armbotservice

package module
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 17, 2022 License: MIT Imports: 16 Imported by: 3

README

Azure Bot Service Module for Go

PkgGoDev

The armbotservice module provides operations for working with Azure Bot Service.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Bot Service module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Bot Service. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Clients

Azure Bot Service modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client, err := armbotservice.NewBotsClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options := arm.ClientOptions {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
client, err := armbotservice.NewBotsClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Bot Service label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AlexaChannel 

type AlexaChannel struct {
	// REQUIRED; The channel name
	ChannelName *string `json:"channelName,omitempty"`

	// Entity Tag of the resource
	Etag *string `json:"etag,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// The set of properties specific to Alexa channel resource
	Properties *AlexaChannelProperties `json:"properties,omitempty"`

	// READ-ONLY; Provisioning state of the resource
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

AlexaChannel - Alexa channel definition

func (*AlexaChannel) GetChannel added in v0.2.0 

func (a *AlexaChannel) GetChannel() *Channel

GetChannel implements the ChannelClassification interface for type AlexaChannel.

func (AlexaChannel) MarshalJSON 

func (a AlexaChannel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AlexaChannel.

func (*AlexaChannel) UnmarshalJSON 

func (a *AlexaChannel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AlexaChannel.

type AlexaChannelProperties 

type AlexaChannelProperties struct {
	// REQUIRED; The Alexa skill Id
	AlexaSkillID *string `json:"alexaSkillId,omitempty"`

	// REQUIRED; Whether this channel is enabled for the bot
	IsEnabled *bool `json:"isEnabled,omitempty"`

	// READ-ONLY; Full Uri used to configured the skill in Alexa
	ServiceEndpointURI *string `json:"serviceEndpointUri,omitempty" azure:"ro"`

	// READ-ONLY; Url fragment used in part of the Uri configured in Alexa
	URLFragment *string `json:"urlFragment,omitempty" azure:"ro"`
}

AlexaChannelProperties - The parameters to provide for the Alexa channel.

type Bot 

type Bot struct {
	// Entity Tag
	Etag *string `json:"etag,omitempty"`

	// Required. Gets or sets the Kind of the resource.
	Kind *Kind `json:"kind,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// The set of properties specific to bot resource
	Properties *BotProperties `json:"properties,omitempty"`

	// Gets or sets the SKU of the resource.
	SKU *SKU `json:"sku,omitempty"`

	// Contains resource tags defined as key/value pairs.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Specifies the resource ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Specifies the name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Specifies the type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`

	// READ-ONLY; Entity zones
	Zones []*string `json:"zones,omitempty" azure:"ro"`
}

Bot resource definition

func (Bot) MarshalJSON 

func (b Bot) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Bot.

type BotChannel 

type BotChannel struct {
	// Entity Tag
	Etag *string `json:"etag,omitempty"`

	// Required. Gets or sets the Kind of the resource.
	Kind *Kind `json:"kind,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// The set of properties specific to bot channel resource
	Properties ChannelClassification `json:"properties,omitempty"`

	// Gets or sets the SKU of the resource.
	SKU *SKU `json:"sku,omitempty"`

	// Contains resource tags defined as key/value pairs.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Specifies the resource ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Specifies the name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Specifies the type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`

	// READ-ONLY; Entity zones
	Zones []*string `json:"zones,omitempty" azure:"ro"`
}

BotChannel - Bot channel resource definition

func (BotChannel) MarshalJSON 

func (b BotChannel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BotChannel.

func (*BotChannel) UnmarshalJSON 

func (b *BotChannel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BotChannel.

type BotConnectionClient 

type BotConnectionClient struct {
	// contains filtered or unexported fields
}

BotConnectionClient contains the methods for the BotConnection group. Don't use this type directly, use NewBotConnectionClient() instead.

func NewBotConnectionClient 

func NewBotConnectionClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BotConnectionClient, error)

NewBotConnectionClient creates a new instance of BotConnectionClient with the specified values. subscriptionID - Azure Subscription ID. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*BotConnectionClient) Create 

func (client *BotConnectionClient) Create(ctx context.Context, resourceGroupName string, resourceName string, connectionName string, parameters ConnectionSetting, options *BotConnectionClientCreateOptions) (BotConnectionClientCreateResponse, error)

Create - Register a new Auth Connection for a Bot Service If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. resourceName - The name of the Bot resource. connectionName - The name of the Bot Service Connection Setting resource. parameters - The parameters to provide for creating the Connection Setting. options - BotConnectionClientCreateOptions contains the optional parameters for the BotConnectionClient.Create method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewBotConnectionClient("subscription-id", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Create(ctx,
		"OneResourceGroupName",
		"samplebotname",
		"sampleConnection",
		armbotservice.ConnectionSetting{
			Etag:     to.Ptr("etag1"),
			Location: to.Ptr("West US"),
			Properties: &armbotservice.ConnectionSettingProperties{
				ClientID:     to.Ptr("sampleclientid"),
				ClientSecret: to.Ptr("samplesecret"),
				Parameters: []*armbotservice.ConnectionSettingParameter{
					{
						Key:   to.Ptr("key1"),
						Value: to.Ptr("value1"),
					},
					{
						Key:   to.Ptr("key2"),
						Value: to.Ptr("value2"),
					}},
				Scopes:            to.Ptr("samplescope"),
				ServiceProviderID: to.Ptr("serviceproviderid"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BotConnectionClient) Delete 

func (client *BotConnectionClient) Delete(ctx context.Context, resourceGroupName string, resourceName string, connectionName string, options *BotConnectionClientDeleteOptions) (BotConnectionClientDeleteResponse, error)

Delete - Deletes a Connection Setting registration for a Bot Service If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. resourceName - The name of the Bot resource. connectionName - The name of the Bot Service Connection Setting resource. options - BotConnectionClientDeleteOptions contains the optional parameters for the BotConnectionClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/DeleteConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewBotConnectionClient("subscription-id", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"OneResourceGroupName",
		"samplebotname",
		"sampleConnection",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*BotConnectionClient) Get 

func (client *BotConnectionClient) Get(ctx context.Context, resourceGroupName string, resourceName string, connectionName string, options *BotConnectionClientGetOptions) (BotConnectionClientGetResponse, error)

Get - Get a Connection Setting registration for a Bot Service If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. resourceName - The name of the Bot resource. connectionName - The name of the Bot Service Connection Setting resource. options - BotConnectionClientGetOptions contains the optional parameters for the BotConnectionClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewBotConnectionClient("subscription-id", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"OneResourceGroupName",
		"samplebotname",
		"sampleConnection",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BotConnectionClient) ListServiceProviders 

func (client *BotConnectionClient) ListServiceProviders(ctx context.Context, options *BotConnectionClientListServiceProvidersOptions) (BotConnectionClientListServiceProvidersResponse, error)

ListServiceProviders - Lists the available Service Providers for creating Connection Settings If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview options - BotConnectionClientListServiceProvidersOptions contains the optional parameters for the BotConnectionClient.ListServiceProviders method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListServiceProviders.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewBotConnectionClient("subscription-id", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListServiceProviders(ctx,
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BotConnectionClient) ListWithSecrets 

func (client *BotConnectionClient) ListWithSecrets(ctx context.Context, resourceGroupName string, resourceName string, connectionName string, options *BotConnectionClientListWithSecretsOptions) (BotConnectionClientListWithSecretsResponse, error)

ListWithSecrets - Get a Connection Setting registration for a Bot Service If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. resourceName - The name of the Bot resource. connectionName - The name of the Bot Service Connection Setting resource. options - BotConnectionClientListWithSecretsOptions contains the optional parameters for the BotConnectionClient.ListWithSecrets method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewBotConnectionClient("subscription-id", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListWithSecrets(ctx,
		"OneResourceGroupName",
		"samplebotname",
		"sampleConnection",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BotConnectionClient) NewListByBotServicePager added in v0.4.0 

func (client *BotConnectionClient) NewListByBotServicePager(resourceGroupName string, resourceName string, options *BotConnectionClientListByBotServiceOptions) *runtime.Pager[BotConnectionClientListByBotServiceResponse]

NewListByBotServicePager - Returns all the Connection Settings registered to a particular BotService resource If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. resourceName - The name of the Bot resource. options - BotConnectionClientListByBotServiceOptions contains the optional parameters for the BotConnectionClient.ListByBotService method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListConnectionsByBotService.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewBotConnectionClient("subscription-id", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByBotServicePager("OneResourceGroupName",
		"samplebotname",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*BotConnectionClient) Update 

func (client *BotConnectionClient) Update(ctx context.Context, resourceGroupName string, resourceName string, connectionName string, parameters ConnectionSetting, options *BotConnectionClientUpdateOptions) (BotConnectionClientUpdateResponse, error)

Update - Updates a Connection Setting registration for a Bot Service If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. resourceName - The name of the Bot resource. connectionName - The name of the Bot Service Connection Setting resource. parameters - The parameters to provide for updating the Connection Setting. options - BotConnectionClientUpdateOptions contains the optional parameters for the BotConnectionClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewBotConnectionClient("subscription-id", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"OneResourceGroupName",
		"samplebotname",
		"sampleConnection",
		armbotservice.ConnectionSetting{
			Etag:     to.Ptr("etag1"),
			Location: to.Ptr("global"),
			Properties: &armbotservice.ConnectionSettingProperties{
				ClientID:     to.Ptr("sampleclientid"),
				ClientSecret: to.Ptr("samplesecret"),
				Parameters: []*armbotservice.ConnectionSettingParameter{
					{
						Key:   to.Ptr("key1"),
						Value: to.Ptr("value1"),
					},
					{
						Key:   to.Ptr("key2"),
						Value: to.Ptr("value2"),
					}},
				Scopes:                     to.Ptr("samplescope"),
				ServiceProviderDisplayName: to.Ptr("serviceProviderDisplayName"),
				ServiceProviderID:          to.Ptr("serviceproviderid"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type BotConnectionClientCreateOptions added in v0.2.0 

type BotConnectionClientCreateOptions struct {
}

BotConnectionClientCreateOptions contains the optional parameters for the BotConnectionClient.Create method.

type BotConnectionClientCreateResponse added in v0.2.0 

type BotConnectionClientCreateResponse struct {
	ConnectionSetting
}

BotConnectionClientCreateResponse contains the response from method BotConnectionClient.Create.

type BotConnectionClientDeleteOptions added in v0.2.0 

type BotConnectionClientDeleteOptions struct {
}

BotConnectionClientDeleteOptions contains the optional parameters for the BotConnectionClient.Delete method.

type BotConnectionClientDeleteResponse added in v0.2.0 

type BotConnectionClientDeleteResponse struct {
}

BotConnectionClientDeleteResponse contains the response from method BotConnectionClient.Delete.

type BotConnectionClientGetOptions added in v0.2.0 

type BotConnectionClientGetOptions struct {
}

BotConnectionClientGetOptions contains the optional parameters for the BotConnectionClient.Get method.

type BotConnectionClientGetResponse added in v0.2.0 

type BotConnectionClientGetResponse struct {
	ConnectionSetting
}

BotConnectionClientGetResponse contains the response from method BotConnectionClient.Get.

type BotConnectionClientListByBotServiceOptions added in v0.2.0 

type BotConnectionClientListByBotServiceOptions struct {
}

BotConnectionClientListByBotServiceOptions contains the optional parameters for the BotConnectionClient.ListByBotService method.

type BotConnectionClientListByBotServiceResponse added in v0.2.0 

type BotConnectionClientListByBotServiceResponse struct {
	ConnectionSettingResponseList
}

BotConnectionClientListByBotServiceResponse contains the response from method BotConnectionClient.ListByBotService.

type BotConnectionClientListServiceProvidersOptions added in v0.2.0 

type BotConnectionClientListServiceProvidersOptions struct {
}

BotConnectionClientListServiceProvidersOptions contains the optional parameters for the BotConnectionClient.ListServiceProviders method.

type BotConnectionClientListServiceProvidersResponse added in v0.2.0 

type BotConnectionClientListServiceProvidersResponse struct {
	ServiceProviderResponseList
}

BotConnectionClientListServiceProvidersResponse contains the response from method BotConnectionClient.ListServiceProviders.

type BotConnectionClientListWithSecretsOptions added in v0.2.0 

type BotConnectionClientListWithSecretsOptions struct {
}

BotConnectionClientListWithSecretsOptions contains the optional parameters for the BotConnectionClient.ListWithSecrets method.

type BotConnectionClientListWithSecretsResponse added in v0.2.0 

type BotConnectionClientListWithSecretsResponse struct {
	ConnectionSetting
}

BotConnectionClientListWithSecretsResponse contains the response from method BotConnectionClient.ListWithSecrets.

type BotConnectionClientUpdateOptions added in v0.2.0 

type BotConnectionClientUpdateOptions struct {
}

BotConnectionClientUpdateOptions contains the optional parameters for the BotConnectionClient.Update method.

type BotConnectionClientUpdateResponse added in v0.2.0 

type BotConnectionClientUpdateResponse struct {
	ConnectionSetting
}

BotConnectionClientUpdateResponse contains the response from method BotConnectionClient.Update.

type BotProperties 

type BotProperties struct {
	// REQUIRED; The Name of the bot
	DisplayName *string `json:"displayName,omitempty"`

	// REQUIRED; The bot's endpoint
	Endpoint *string `json:"endpoint,omitempty"`

	// REQUIRED; Microsoft App Id for the bot
	MsaAppID *string `json:"msaAppId,omitempty"`

	// Contains resource all settings defined as key/value pairs.
	AllSettings map[string]*string `json:"allSettings,omitempty"`

	// The hint (e.g. keyVault secret resourceId) on how to fetch the app secret
	AppPasswordHint *string `json:"appPasswordHint,omitempty"`

	// The CMK Url
	CmekKeyVaultURL *string `json:"cmekKeyVaultUrl,omitempty"`

	// The description of the bot
	Description *string `json:"description,omitempty"`

	// The Application Insights key
	DeveloperAppInsightKey *string `json:"developerAppInsightKey,omitempty"`

	// The Application Insights Api Key
	DeveloperAppInsightsAPIKey *string `json:"developerAppInsightsApiKey,omitempty"`

	// The Application Insights App Id
	DeveloperAppInsightsApplicationID *string `json:"developerAppInsightsApplicationId,omitempty"`

	// Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
	DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`

	// The Icon Url of the bot
	IconURL *string `json:"iconUrl,omitempty"`

	// Whether Cmek is enabled
	IsCmekEnabled *bool `json:"isCmekEnabled,omitempty"`

	// Whether the bot is streaming supported
	IsStreamingSupported *bool `json:"isStreamingSupported,omitempty"`

	// Collection of LUIS App Ids
	LuisAppIDs []*string `json:"luisAppIds,omitempty"`

	// The LUIS Key
	LuisKey *string `json:"luisKey,omitempty"`

	// The bot's manifest url
	ManifestURL *string `json:"manifestUrl,omitempty"`

	// Microsoft App Managed Identity Resource Id for the bot
	MsaAppMSIResourceID *string `json:"msaAppMSIResourceId,omitempty"`

	// Microsoft App Tenant Id for the bot
	MsaAppTenantID *string `json:"msaAppTenantId,omitempty"`

	// Microsoft App Type for the bot
	MsaAppType *MsaAppType `json:"msaAppType,omitempty"`

	// The hint to browser (e.g. protocol handler) on how to open the bot for authoring
	OpenWithHint *string `json:"openWithHint,omitempty"`

	// Contains resource parameters defined as key/value pairs.
	Parameters map[string]*string `json:"parameters,omitempty"`

	// Whether the bot is in an isolated network
	PublicNetworkAccess *PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`

	// Publishing credentials of the resource
	PublishingCredentials *string `json:"publishingCredentials,omitempty"`

	// The channel schema transformation version for the bot
	SchemaTransformationVersion *string `json:"schemaTransformationVersion,omitempty"`

	// The storage resourceId for the bot
	StorageResourceID *string `json:"storageResourceId,omitempty"`

	// READ-ONLY; The CMK encryption status
	CmekEncryptionStatus *string `json:"cmekEncryptionStatus,omitempty" azure:"ro"`

	// READ-ONLY; Collection of channels for which the bot is configured
	ConfiguredChannels []*string `json:"configuredChannels,omitempty" azure:"ro"`

	// READ-ONLY; Collection of channels for which the bot is enabled
	EnabledChannels []*string `json:"enabledChannels,omitempty" azure:"ro"`

	// READ-ONLY; The bot's endpoint version
	EndpointVersion *string `json:"endpointVersion,omitempty" azure:"ro"`

	// READ-ONLY; Whether the bot is developerAppInsightsApiKey set
	IsDeveloperAppInsightsAPIKeySet *bool `json:"isDeveloperAppInsightsApiKeySet,omitempty" azure:"ro"`

	// READ-ONLY; Token used to migrate non Azure bot to azure subscription
	MigrationToken *string `json:"migrationToken,omitempty" azure:"ro"`

	// READ-ONLY; List of Private Endpoint Connections configured for the bot
	PrivateEndpointConnections []*PrivateEndpointConnection `json:"privateEndpointConnections,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the resource
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

BotProperties - The parameters to provide for the Bot.

func (BotProperties) MarshalJSON 

func (b BotProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BotProperties.

type BotResponseList 

type BotResponseList struct {
	// The link used to get the next page of bot service resources.
	NextLink *string `json:"nextLink,omitempty"`

	// READ-ONLY; Gets the list of bot service results and their properties.
	Value []*Bot `json:"value,omitempty" azure:"ro"`
}

BotResponseList - The list of bot service operation response.

type BotsClient 

type BotsClient struct {
	// contains filtered or unexported fields
}

BotsClient contains the methods for the Bots group. Don't use this type directly, use NewBotsClient() instead.

func NewBotsClient 

func NewBotsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BotsClient, error)

NewBotsClient creates a new instance of BotsClient with the specified values. subscriptionID - Azure Subscription ID. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*BotsClient) Create 

func (client *BotsClient) Create(ctx context.Context, resourceGroupName string, resourceName string, parameters Bot, options *BotsClientCreateOptions) (BotsClientCreateResponse, error)

Create - Creates a Bot Service. Bot Service is a resource group wide resource type. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. resourceName - The name of the Bot resource. parameters - The parameters to provide for the created bot. options - BotsClientCreateOptions contains the optional parameters for the BotsClient.Create method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/CreateBot.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewBotsClient("subscription-id", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Create(ctx,
		"OneResourceGroupName",
		"samplebotname",
		armbotservice.Bot{
			Etag:     to.Ptr("etag1"),
			Kind:     to.Ptr(armbotservice.KindSdk),
			Location: to.Ptr("West US"),
			SKU: &armbotservice.SKU{
				Name: to.Ptr(armbotservice.SKUNameS1),
			},
			Tags: map[string]*string{
				"tag1": to.Ptr("value1"),
				"tag2": to.Ptr("value2"),
			},
			Properties: &armbotservice.BotProperties{
				Description:                       to.Ptr("The description of the bot"),
				CmekKeyVaultURL:                   to.Ptr("https://myCmekKey"),
				DeveloperAppInsightKey:            to.Ptr("appinsightskey"),
				DeveloperAppInsightsAPIKey:        to.Ptr("appinsightsapikey"),
				DeveloperAppInsightsApplicationID: to.Ptr("appinsightsappid"),
				DisableLocalAuth:                  to.Ptr(true),
				DisplayName:                       to.Ptr("The Name of the bot"),
				Endpoint:                          to.Ptr("http://mybot.coffee"),
				IconURL:                           to.Ptr("http://myicon"),
				IsCmekEnabled:                     to.Ptr(true),
				LuisAppIDs: []*string{
					to.Ptr("luisappid1"),
					to.Ptr("luisappid2")},
				LuisKey:                     to.Ptr("luiskey"),
				MsaAppID:                    to.Ptr("exampleappid"),
				MsaAppMSIResourceID:         to.Ptr("/subscriptions/foo/resourcegroups/bar/providers/microsoft.managedidentity/userassignedidentities/sampleId"),
				MsaAppTenantID:              to.Ptr("exampleapptenantid"),
				MsaAppType:                  to.Ptr(armbotservice.MsaAppTypeUserAssignedMSI),
				PublicNetworkAccess:         to.Ptr(armbotservice.PublicNetworkAccessEnabled),
				SchemaTransformationVersion: to.Ptr("1.0"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BotsClient) Delete 

func (client *BotsClient) Delete(ctx context.Context, resourceGroupName string, resourceName string, options *BotsClientDeleteOptions) (BotsClientDeleteResponse, error)

Delete - Deletes a Bot Service from the resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. resourceName - The name of the Bot resource. options - BotsClientDeleteOptions contains the optional parameters for the BotsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/DeleteBot.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewBotsClient("subscription-id", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"OneResourceGroupName",
		"samplebotname",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*BotsClient) Get 

func (client *BotsClient) Get(ctx context.Context, resourceGroupName string, resourceName string, options *BotsClientGetOptions) (BotsClientGetResponse, error)

Get - Returns a BotService specified by the parameters. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. resourceName - The name of the Bot resource. options - BotsClientGetOptions contains the optional parameters for the BotsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetBot.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewBotsClient("subscription-id", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"OneResourceGroupName",
		"samplebotname",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BotsClient) GetCheckNameAvailability 

func (client *BotsClient) GetCheckNameAvailability(ctx context.Context, parameters CheckNameAvailabilityRequestBody, options *BotsClientGetCheckNameAvailabilityOptions) (BotsClientGetCheckNameAvailabilityResponse, error)

GetCheckNameAvailability - Check whether a bot name is available. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview parameters - The request body parameters to provide for the check name availability request options - BotsClientGetCheckNameAvailabilityOptions contains the optional parameters for the BotsClient.GetCheckNameAvailability method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/CheckNameAvailability.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewBotsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.GetCheckNameAvailability(ctx,
		armbotservice.CheckNameAvailabilityRequestBody{
			Name: to.Ptr("testbotname"),
			Type: to.Ptr("string"),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BotsClient) NewListByResourceGroupPager added in v0.4.0 

func (client *BotsClient) NewListByResourceGroupPager(resourceGroupName string, options *BotsClientListByResourceGroupOptions) *runtime.Pager[BotsClientListByResourceGroupResponse]

NewListByResourceGroupPager - Returns all the resources of a particular type belonging to a resource group If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. options - BotsClientListByResourceGroupOptions contains the optional parameters for the BotsClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListBotsByResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewBotsClient("subscription-id", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourceGroupPager("OneResourceGroupName",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*BotsClient) NewListPager added in v0.4.0 

func (client *BotsClient) NewListPager(options *BotsClientListOptions) *runtime.Pager[BotsClientListResponse]

NewListPager - Returns all the resources of a particular type belonging to a subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview options - BotsClientListOptions contains the optional parameters for the BotsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListBotsBySubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewBotsClient("subscription-id", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*BotsClient) Update 

func (client *BotsClient) Update(ctx context.Context, resourceGroupName string, resourceName string, parameters Bot, options *BotsClientUpdateOptions) (BotsClientUpdateResponse, error)

Update - Updates a Bot Service If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. resourceName - The name of the Bot resource. parameters - The parameters to provide for the created bot. options - BotsClientUpdateOptions contains the optional parameters for the BotsClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateBot.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewBotsClient("subscription-id", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"OneResourceGroupName",
		"samplebotname",
		armbotservice.Bot{
			Etag:     to.Ptr("etag1"),
			Kind:     to.Ptr(armbotservice.KindSdk),
			Location: to.Ptr("West US"),
			SKU: &armbotservice.SKU{
				Name: to.Ptr(armbotservice.SKUNameS1),
			},
			Tags: map[string]*string{
				"tag1": to.Ptr("value1"),
				"tag2": to.Ptr("value2"),
			},
			Properties: &armbotservice.BotProperties{
				Description:                       to.Ptr("The description of the bot"),
				CmekKeyVaultURL:                   to.Ptr("https://myCmekKey"),
				DeveloperAppInsightKey:            to.Ptr("appinsightskey"),
				DeveloperAppInsightsAPIKey:        to.Ptr("appinsightsapikey"),
				DeveloperAppInsightsApplicationID: to.Ptr("appinsightsappid"),
				DisableLocalAuth:                  to.Ptr(true),
				DisplayName:                       to.Ptr("The Name of the bot"),
				Endpoint:                          to.Ptr("http://mybot.coffee"),
				IconURL:                           to.Ptr("http://myicon"),
				IsCmekEnabled:                     to.Ptr(true),
				LuisAppIDs: []*string{
					to.Ptr("luisappid1"),
					to.Ptr("luisappid2")},
				LuisKey:                     to.Ptr("luiskey"),
				MsaAppID:                    to.Ptr("msaappid"),
				MsaAppMSIResourceID:         to.Ptr("/subscriptions/foo/resourcegroups/bar/providers/microsoft.managedidentity/userassignedidentities/sampleId"),
				MsaAppTenantID:              to.Ptr("msaapptenantid"),
				MsaAppType:                  to.Ptr(armbotservice.MsaAppTypeUserAssignedMSI),
				PublicNetworkAccess:         to.Ptr(armbotservice.PublicNetworkAccessEnabled),
				SchemaTransformationVersion: to.Ptr("1.0"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type BotsClientCreateOptions added in v0.2.0 

type BotsClientCreateOptions struct {
}

BotsClientCreateOptions contains the optional parameters for the BotsClient.Create method.

type BotsClientCreateResponse added in v0.2.0 

type BotsClientCreateResponse struct {
	Bot
}

BotsClientCreateResponse contains the response from method BotsClient.Create.

type BotsClientDeleteOptions added in v0.2.0 

type BotsClientDeleteOptions struct {
}

BotsClientDeleteOptions contains the optional parameters for the BotsClient.Delete method.

type BotsClientDeleteResponse added in v0.2.0 

type BotsClientDeleteResponse struct {
}

BotsClientDeleteResponse contains the response from method BotsClient.Delete.

type BotsClientGetCheckNameAvailabilityOptions added in v0.2.0 

type BotsClientGetCheckNameAvailabilityOptions struct {
}

BotsClientGetCheckNameAvailabilityOptions contains the optional parameters for the BotsClient.GetCheckNameAvailability method.

type BotsClientGetCheckNameAvailabilityResponse added in v0.2.0 

type BotsClientGetCheckNameAvailabilityResponse struct {
	CheckNameAvailabilityResponseBody
}

BotsClientGetCheckNameAvailabilityResponse contains the response from method BotsClient.GetCheckNameAvailability.

type BotsClientGetOptions added in v0.2.0 

type BotsClientGetOptions struct {
}

BotsClientGetOptions contains the optional parameters for the BotsClient.Get method.

type BotsClientGetResponse added in v0.2.0 

type BotsClientGetResponse struct {
	Bot
}

BotsClientGetResponse contains the response from method BotsClient.Get.

type BotsClientListByResourceGroupOptions added in v0.2.0 

type BotsClientListByResourceGroupOptions struct {
}

BotsClientListByResourceGroupOptions contains the optional parameters for the BotsClient.ListByResourceGroup method.

type BotsClientListByResourceGroupResponse added in v0.2.0 

type BotsClientListByResourceGroupResponse struct {
	BotResponseList
}

BotsClientListByResourceGroupResponse contains the response from method BotsClient.ListByResourceGroup.

type BotsClientListOptions added in v0.2.0 

type BotsClientListOptions struct {
}

BotsClientListOptions contains the optional parameters for the BotsClient.List method.

type BotsClientListResponse added in v0.2.0 

type BotsClientListResponse struct {
	BotResponseList
}

BotsClientListResponse contains the response from method BotsClient.List.

type BotsClientUpdateOptions added in v0.2.0 

type BotsClientUpdateOptions struct {
}

BotsClientUpdateOptions contains the optional parameters for the BotsClient.Update method.

type BotsClientUpdateResponse added in v0.2.0 

type BotsClientUpdateResponse struct {
	Bot
}

BotsClientUpdateResponse contains the response from method BotsClient.Update.

type Channel 

type Channel struct {
	// REQUIRED; The channel name
	ChannelName *string `json:"channelName,omitempty"`

	// Entity Tag of the resource
	Etag *string `json:"etag,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// READ-ONLY; Provisioning state of the resource
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

Channel definition

func (*Channel) GetChannel 

func (c *Channel) GetChannel() *Channel

GetChannel implements the ChannelClassification interface for type Channel.

type ChannelClassification 

type ChannelClassification interface {
	// GetChannel returns the Channel content of the underlying type.
	GetChannel() *Channel
}

ChannelClassification provides polymorphic access to related types. Call the interface's GetChannel() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AlexaChannel, *Channel, *DirectLineChannel, *DirectLineSpeechChannel, *EmailChannel, *FacebookChannel, *KikChannel, - *LineChannel, *MsTeamsChannel, *SkypeChannel, *SlackChannel, *SmsChannel, *TelegramChannel, *WebChatChannel

type ChannelName 

type ChannelName string
const (
	ChannelNameAlexaChannel            ChannelName = "AlexaChannel"
	ChannelNameFacebookChannel         ChannelName = "FacebookChannel"
	ChannelNameEmailChannel            ChannelName = "EmailChannel"
	ChannelNameKikChannel              ChannelName = "KikChannel"
	ChannelNameTelegramChannel         ChannelName = "TelegramChannel"
	ChannelNameSlackChannel            ChannelName = "SlackChannel"
	ChannelNameMsTeamsChannel          ChannelName = "MsTeamsChannel"
	ChannelNameSkypeChannel            ChannelName = "SkypeChannel"
	ChannelNameWebChatChannel          ChannelName = "WebChatChannel"
	ChannelNameDirectLineChannel       ChannelName = "DirectLineChannel"
	ChannelNameSmsChannel              ChannelName = "SmsChannel"
	ChannelNameLineChannel             ChannelName = "LineChannel"
	ChannelNameDirectLineSpeechChannel ChannelName = "DirectLineSpeechChannel"
	ChannelNameOutlookChannel          ChannelName = "OutlookChannel"
)

func PossibleChannelNameValues 

func PossibleChannelNameValues() []ChannelName

PossibleChannelNameValues returns the possible values for the ChannelName const type.

type ChannelResponseList 

type ChannelResponseList struct {
	// The link used to get the next page of bot service channel resources.
	NextLink *string `json:"nextLink,omitempty"`

	// READ-ONLY; Gets the list of bot service channel results and their properties.
	Value []*BotChannel `json:"value,omitempty" azure:"ro"`
}

ChannelResponseList - The list of bot service channel operation response.

type ChannelSettings added in v0.2.0 

type ChannelSettings struct {
	// The bot id
	BotID *string `json:"botId,omitempty"`

	// The bot icon url
	BotIconURL *string `json:"botIconUrl,omitempty"`

	// The channel display name
	ChannelDisplayName *string `json:"channelDisplayName,omitempty"`

	// The channel id
	ChannelID *string `json:"channelId,omitempty"`

	// Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
	DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`

	// The extensionKey1
	ExtensionKey1 *string `json:"extensionKey1,omitempty"`

	// The extensionKey2
	ExtensionKey2 *string `json:"extensionKey2,omitempty"`

	// Whether this channel is enabled for the bot
	IsEnabled *bool `json:"isEnabled,omitempty"`

	// The list of sites
	Sites []*Site `json:"sites,omitempty"`
}

ChannelSettings - Channel settings definition

func (ChannelSettings) MarshalJSON added in v0.2.0 

func (c ChannelSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ChannelSettings.

type ChannelsClient 

type ChannelsClient struct {
	// contains filtered or unexported fields
}

ChannelsClient contains the methods for the Channels group. Don't use this type directly, use NewChannelsClient() instead.

func NewChannelsClient 

func NewChannelsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ChannelsClient, error)

NewChannelsClient creates a new instance of ChannelsClient with the specified values. subscriptionID - Azure Subscription ID. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ChannelsClient) Create 

func (client *ChannelsClient) Create(ctx context.Context, resourceGroupName string, resourceName string, channelName ChannelName, parameters BotChannel, options *ChannelsClientCreateOptions) (ChannelsClientCreateResponse, error)

Create - Creates a Channel registration for a Bot Service If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. resourceName - The name of the Bot resource. channelName - The name of the Channel resource. parameters - The parameters to provide for the created bot. options - ChannelsClientCreateOptions contains the optional parameters for the ChannelsClient.Create method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutAlexaChannel.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewChannelsClient("subscription-id", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Create(ctx,
		"OneResourceGroupName",
		"samplebotname",
		armbotservice.ChannelNameAlexaChannel,
		armbotservice.BotChannel{
			Location: to.Ptr("global"),
			Properties: &armbotservice.AlexaChannel{
				ChannelName: to.Ptr("AlexaChannel"),
				Properties: &armbotservice.AlexaChannelProperties{
					AlexaSkillID: to.Ptr("XAlexaSkillIdX"),
					IsEnabled:    to.Ptr(true),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ChannelsClient) Delete 

func (client *ChannelsClient) Delete(ctx context.Context, resourceGroupName string, resourceName string, channelName string, options *ChannelsClientDeleteOptions) (ChannelsClientDeleteResponse, error)

Delete - Deletes a Channel registration from a Bot Service If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. resourceName - The name of the Bot resource. channelName - The name of the Bot resource. options - ChannelsClientDeleteOptions contains the optional parameters for the ChannelsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/DeleteChannel.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewChannelsClient("subscription-id", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"OneResourceGroupName",
		"samplebotname",
		"EmailChannel",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*ChannelsClient) Get 

func (client *ChannelsClient) Get(ctx context.Context, resourceGroupName string, resourceName string, channelName string, options *ChannelsClientGetOptions) (ChannelsClientGetResponse, error)

Get - Returns a BotService Channel registration specified by the parameters. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. resourceName - The name of the Bot resource. channelName - The name of the Bot resource. options - ChannelsClientGetOptions contains the optional parameters for the ChannelsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetAlexaChannel.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewChannelsClient("subscription-id", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"OneResourceGroupName",
		"samplebotname",
		"AlexaChannel",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ChannelsClient) ListWithKeys 

func (client *ChannelsClient) ListWithKeys(ctx context.Context, resourceGroupName string, resourceName string, channelName ChannelName, options *ChannelsClientListWithKeysOptions) (ChannelsClientListWithKeysResponse, error)

ListWithKeys - Lists a Channel registration for a Bot Service including secrets If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. resourceName - The name of the Bot resource. channelName - The name of the Channel resource. options - ChannelsClientListWithKeysOptions contains the optional parameters for the ChannelsClient.ListWithKeys method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListChannel.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewChannelsClient("subscription-id", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListWithKeys(ctx,
		"OneResourceGroupName",
		"samplebotname",
		armbotservice.ChannelNameEmailChannel,
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ChannelsClient) NewListByResourceGroupPager added in v0.4.0 

func (client *ChannelsClient) NewListByResourceGroupPager(resourceGroupName string, resourceName string, options *ChannelsClientListByResourceGroupOptions) *runtime.Pager[ChannelsClientListByResourceGroupResponse]

NewListByResourceGroupPager - Returns all the Channel registrations of a particular BotService resource If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. resourceName - The name of the Bot resource. options - ChannelsClientListByResourceGroupOptions contains the optional parameters for the ChannelsClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListChannelsByBotService.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewChannelsClient("subscription-id", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourceGroupPager("OneResourceGroupName",
		"samplebotname",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*ChannelsClient) Update 

func (client *ChannelsClient) Update(ctx context.Context, resourceGroupName string, resourceName string, channelName ChannelName, parameters BotChannel, options *ChannelsClientUpdateOptions) (ChannelsClientUpdateResponse, error)

Update - Updates a Channel registration for a Bot Service If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. resourceName - The name of the Bot resource. channelName - The name of the Channel resource. parameters - The parameters to provide for the created bot. options - ChannelsClientUpdateOptions contains the optional parameters for the ChannelsClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateAlexaChannel.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewChannelsClient("subscription-id", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"OneResourceGroupName",
		"samplebotname",
		armbotservice.ChannelNameAlexaChannel,
		armbotservice.BotChannel{
			Location: to.Ptr("global"),
			Properties: &armbotservice.AlexaChannel{
				ChannelName: to.Ptr("AlexaChannel"),
				Properties: &armbotservice.AlexaChannelProperties{
					AlexaSkillID: to.Ptr("XAlexaSkillIdX"),
					IsEnabled:    to.Ptr(true),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type ChannelsClientCreateOptions added in v0.2.0 

type ChannelsClientCreateOptions struct {
}

ChannelsClientCreateOptions contains the optional parameters for the ChannelsClient.Create method.

type ChannelsClientCreateResponse added in v0.2.0 

type ChannelsClientCreateResponse struct {
	BotChannel
}

ChannelsClientCreateResponse contains the response from method ChannelsClient.Create.

type ChannelsClientDeleteOptions added in v0.2.0 

type ChannelsClientDeleteOptions struct {
}

ChannelsClientDeleteOptions contains the optional parameters for the ChannelsClient.Delete method.

type ChannelsClientDeleteResponse added in v0.2.0 

type ChannelsClientDeleteResponse struct {
}

ChannelsClientDeleteResponse contains the response from method ChannelsClient.Delete.

type ChannelsClientGetOptions added in v0.2.0 

type ChannelsClientGetOptions struct {
}

ChannelsClientGetOptions contains the optional parameters for the ChannelsClient.Get method.

type ChannelsClientGetResponse added in v0.2.0 

type ChannelsClientGetResponse struct {
	BotChannel
}

ChannelsClientGetResponse contains the response from method ChannelsClient.Get.

type ChannelsClientListByResourceGroupOptions added in v0.2.0 

type ChannelsClientListByResourceGroupOptions struct {
}

ChannelsClientListByResourceGroupOptions contains the optional parameters for the ChannelsClient.ListByResourceGroup method.

type ChannelsClientListByResourceGroupResponse added in v0.2.0 

type ChannelsClientListByResourceGroupResponse struct {
	ChannelResponseList
}

ChannelsClientListByResourceGroupResponse contains the response from method ChannelsClient.ListByResourceGroup.

type ChannelsClientListWithKeysOptions added in v0.2.0 

type ChannelsClientListWithKeysOptions struct {
}

ChannelsClientListWithKeysOptions contains the optional parameters for the ChannelsClient.ListWithKeys method.

type ChannelsClientListWithKeysResponse added in v0.2.0 

type ChannelsClientListWithKeysResponse struct {
	ListChannelWithKeysResponse
}

ChannelsClientListWithKeysResponse contains the response from method ChannelsClient.ListWithKeys.

type ChannelsClientUpdateOptions added in v0.2.0 

type ChannelsClientUpdateOptions struct {
}

ChannelsClientUpdateOptions contains the optional parameters for the ChannelsClient.Update method.

type ChannelsClientUpdateResponse added in v0.2.0 

type ChannelsClientUpdateResponse struct {
	BotChannel
}

ChannelsClientUpdateResponse contains the response from method ChannelsClient.Update.

type CheckNameAvailabilityRequestBody 

type CheckNameAvailabilityRequestBody struct {
	// the name of the bot for which availability needs to be checked.
	Name *string `json:"name,omitempty"`

	// the type of the bot for which availability needs to be checked
	Type *string `json:"type,omitempty"`
}

CheckNameAvailabilityRequestBody - The request body for a request to Bot Service Management to check availability of a bot name.

type CheckNameAvailabilityResponseBody 

type CheckNameAvailabilityResponseBody struct {
	// additional message from the bot management api showing why a bot name is not available
	Message *string `json:"message,omitempty"`

	// indicates if the bot name is valid.
	Valid *bool `json:"valid,omitempty"`
}

CheckNameAvailabilityResponseBody - The response body returned for a request to Bot Service Management to check availability of a bot name.

type ConnectionItemName 

type ConnectionItemName struct {
	// READ-ONLY; Connection Item name that has been added in the API
	Name *string `json:"name,omitempty" azure:"ro"`
}

ConnectionItemName - The display name of a connection Item Setting registered with the Bot

type ConnectionSetting 

type ConnectionSetting struct {
	// Entity Tag
	Etag *string `json:"etag,omitempty"`

	// Required. Gets or sets the Kind of the resource.
	Kind *Kind `json:"kind,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// The set of properties specific to bot channel resource
	Properties *ConnectionSettingProperties `json:"properties,omitempty"`

	// Gets or sets the SKU of the resource.
	SKU *SKU `json:"sku,omitempty"`

	// Contains resource tags defined as key/value pairs.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Specifies the resource ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Specifies the name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Specifies the type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`

	// READ-ONLY; Entity zones
	Zones []*string `json:"zones,omitempty" azure:"ro"`
}

ConnectionSetting - Bot channel resource definition

func (ConnectionSetting) MarshalJSON 

func (c ConnectionSetting) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionSetting.

type ConnectionSettingParameter 

type ConnectionSettingParameter struct {
	// Key for the Connection Setting Parameter.
	Key *string `json:"key,omitempty"`

	// Value associated with the Connection Setting Parameter.
	Value *string `json:"value,omitempty"`
}

ConnectionSettingParameter - Extra Parameter in a Connection Setting Properties to indicate service provider specific properties

type ConnectionSettingProperties 

type ConnectionSettingProperties struct {
	// Client Id associated with the Connection Setting.
	ClientID *string `json:"clientId,omitempty"`

	// Client Secret associated with the Connection Setting
	ClientSecret *string `json:"clientSecret,omitempty"`

	// Id associated with the Connection Setting.
	ID *string `json:"id,omitempty"`

	// Name associated with the Connection Setting.
	Name *string `json:"name,omitempty"`

	// Service Provider Parameters associated with the Connection Setting
	Parameters []*ConnectionSettingParameter `json:"parameters,omitempty"`

	// Provisioning state of the resource
	ProvisioningState *string `json:"provisioningState,omitempty"`

	// Scopes associated with the Connection Setting
	Scopes *string `json:"scopes,omitempty"`

	// Service Provider Display Name associated with the Connection Setting
	ServiceProviderDisplayName *string `json:"serviceProviderDisplayName,omitempty"`

	// Service Provider Id associated with the Connection Setting
	ServiceProviderID *string `json:"serviceProviderId,omitempty"`

	// READ-ONLY; Setting Id set by the service for the Connection Setting.
	SettingID *string `json:"settingId,omitempty" azure:"ro"`
}

ConnectionSettingProperties - Properties for a Connection Setting Item

func (ConnectionSettingProperties) MarshalJSON 

func (c ConnectionSettingProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionSettingProperties.

type ConnectionSettingResponseList 

type ConnectionSettingResponseList struct {
	// The link used to get the next page of bot service connection setting resources.
	NextLink *string `json:"nextLink,omitempty"`

	// READ-ONLY; Gets the list of bot service connection settings and their properties.
	Value []*ConnectionSetting `json:"value,omitempty" azure:"ro"`
}

ConnectionSettingResponseList - The list of bot service connection settings response.

type DirectLineChannel 

type DirectLineChannel struct {
	// REQUIRED; The channel name
	ChannelName *string `json:"channelName,omitempty"`

	// Entity Tag of the resource
	Etag *string `json:"etag,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// The set of properties specific to Direct Line channel resource
	Properties *DirectLineChannelProperties `json:"properties,omitempty"`

	// READ-ONLY; Provisioning state of the resource
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

DirectLineChannel - Direct Line channel definition

func (*DirectLineChannel) GetChannel added in v0.2.0 

func (d *DirectLineChannel) GetChannel() *Channel

GetChannel implements the ChannelClassification interface for type DirectLineChannel.

func (DirectLineChannel) MarshalJSON 

func (d DirectLineChannel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DirectLineChannel.

func (*DirectLineChannel) UnmarshalJSON 

func (d *DirectLineChannel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DirectLineChannel.

type DirectLineChannelProperties 

type DirectLineChannelProperties struct {
	// Direct Line embed code of the resource
	DirectLineEmbedCode *string `json:"DirectLineEmbedCode,omitempty"`

	// The list of Direct Line sites
	Sites []*DirectLineSite `json:"sites,omitempty"`
}

DirectLineChannelProperties - The parameters to provide for the Direct Line channel.

func (DirectLineChannelProperties) MarshalJSON 

func (d DirectLineChannelProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DirectLineChannelProperties.

type DirectLineClient 

type DirectLineClient struct {
	// contains filtered or unexported fields
}

DirectLineClient contains the methods for the DirectLine group. Don't use this type directly, use NewDirectLineClient() instead.

func NewDirectLineClient 

func NewDirectLineClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DirectLineClient, error)

NewDirectLineClient creates a new instance of DirectLineClient with the specified values. subscriptionID - Azure Subscription ID. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DirectLineClient) RegenerateKeys 

func (client *DirectLineClient) RegenerateKeys(ctx context.Context, resourceGroupName string, resourceName string, channelName RegenerateKeysChannelName, parameters SiteInfo, options *DirectLineClientRegenerateKeysOptions) (DirectLineClientRegenerateKeysResponse, error)

RegenerateKeys - Regenerates secret keys and returns them for the DirectLine Channel of a particular BotService resource If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. resourceName - The name of the Bot resource. channelName - The name of the Channel resource for which keys are to be regenerated. parameters - The parameters to provide for the created bot. options - DirectLineClientRegenerateKeysOptions contains the optional parameters for the DirectLineClient.RegenerateKeys method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/DirectlineRegenerateKeys.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewDirectLineClient("subscription-id", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.RegenerateKeys(ctx,
		"OneResourceGroupName",
		"samplebotname",
		armbotservice.RegenerateKeysChannelNameDirectLineChannel,
		armbotservice.SiteInfo{
			Key:      to.Ptr(armbotservice.KeyKey1),
			SiteName: to.Ptr("testSiteName"),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type DirectLineClientRegenerateKeysOptions added in v0.2.0 

type DirectLineClientRegenerateKeysOptions struct {
}

DirectLineClientRegenerateKeysOptions contains the optional parameters for the DirectLineClient.RegenerateKeys method.

type DirectLineClientRegenerateKeysResponse added in v0.2.0 

type DirectLineClientRegenerateKeysResponse struct {
	BotChannel
}

DirectLineClientRegenerateKeysResponse contains the response from method DirectLineClient.RegenerateKeys.

type DirectLineSite 

type DirectLineSite struct {
	// REQUIRED; Whether this site is enabled for DirectLine channel.
	IsEnabled *bool `json:"isEnabled,omitempty"`

	// REQUIRED; Whether this site is enabled for Bot Framework V1 protocol.
	IsV1Enabled *bool `json:"isV1Enabled,omitempty"`

	// REQUIRED; Whether this site is enabled for Bot Framework V1 protocol.
	IsV3Enabled *bool `json:"isV3Enabled,omitempty"`

	// REQUIRED; Site name
	SiteName *string `json:"siteName,omitempty"`

	// Whether this site is enabled for block user upload.
	IsBlockUserUploadEnabled *bool `json:"isBlockUserUploadEnabled,omitempty"`

	// Whether this site is enabled for authentication with Bot Framework.
	IsSecureSiteEnabled *bool `json:"isSecureSiteEnabled,omitempty"`

	// List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True.
	TrustedOrigins []*string `json:"trustedOrigins,omitempty"`

	// READ-ONLY; Primary key. Value only returned through POST to the action Channel List API, otherwise empty.
	Key *string `json:"key,omitempty" azure:"ro"`

	// READ-ONLY; Secondary key. Value only returned through POST to the action Channel List API, otherwise empty.
	Key2 *string `json:"key2,omitempty" azure:"ro"`

	// READ-ONLY; Site Id
	SiteID *string `json:"siteId,omitempty" azure:"ro"`
}

DirectLineSite - A site for the Direct Line channel

func (DirectLineSite) MarshalJSON 

func (d DirectLineSite) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DirectLineSite.

type DirectLineSpeechChannel 

type DirectLineSpeechChannel struct {
	// REQUIRED; The channel name
	ChannelName *string `json:"channelName,omitempty"`

	// Entity Tag of the resource
	Etag *string `json:"etag,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// The set of properties specific to DirectLine Speech channel resource
	Properties *DirectLineSpeechChannelProperties `json:"properties,omitempty"`

	// READ-ONLY; Provisioning state of the resource
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

DirectLineSpeechChannel - DirectLine Speech channel definition

func (*DirectLineSpeechChannel) GetChannel added in v0.2.0 

func (d *DirectLineSpeechChannel) GetChannel() *Channel

GetChannel implements the ChannelClassification interface for type DirectLineSpeechChannel.

func (DirectLineSpeechChannel) MarshalJSON 

func (d DirectLineSpeechChannel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DirectLineSpeechChannel.

func (*DirectLineSpeechChannel) UnmarshalJSON 

func (d *DirectLineSpeechChannel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DirectLineSpeechChannel.

type DirectLineSpeechChannelProperties 

type DirectLineSpeechChannelProperties struct {
	// REQUIRED; The cognitive service region with this channel registration.
	CognitiveServiceRegion *string `json:"cognitiveServiceRegion,omitempty"`

	// REQUIRED; The cognitive service subscription key to use with this channel registration.
	CognitiveServiceSubscriptionKey *string `json:"cognitiveServiceSubscriptionKey,omitempty"`

	// Custom voice deployment id (optional).
	CustomSpeechModelID *string `json:"customSpeechModelId,omitempty"`

	// Custom speech model id (optional).
	CustomVoiceDeploymentID *string `json:"customVoiceDeploymentId,omitempty"`

	// Make this a default bot for chosen cognitive service account.
	IsDefaultBotForCogSvcAccount *bool `json:"isDefaultBotForCogSvcAccount,omitempty"`

	// Whether this channel is enabled or not.
	IsEnabled *bool `json:"isEnabled,omitempty"`
}

DirectLineSpeechChannelProperties - The parameters to provide for the DirectLine Speech channel.

type EmailChannel 

type EmailChannel struct {
	// REQUIRED; The channel name
	ChannelName *string `json:"channelName,omitempty"`

	// Entity Tag of the resource
	Etag *string `json:"etag,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// The set of properties specific to email channel resource
	Properties *EmailChannelProperties `json:"properties,omitempty"`

	// READ-ONLY; Provisioning state of the resource
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

EmailChannel - Email channel definition

func (*EmailChannel) GetChannel added in v0.2.0 

func (e *EmailChannel) GetChannel() *Channel

GetChannel implements the ChannelClassification interface for type EmailChannel.

func (EmailChannel) MarshalJSON 

func (e EmailChannel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EmailChannel.

func (*EmailChannel) UnmarshalJSON 

func (e *EmailChannel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EmailChannel.

type EmailChannelProperties 

type EmailChannelProperties struct {
	// REQUIRED; The email address
	EmailAddress *string `json:"emailAddress,omitempty"`

	// REQUIRED; Whether this channel is enabled for the bot
	IsEnabled *bool `json:"isEnabled,omitempty"`

	// The password for the email address. Value only returned through POST to the action Channel List API, otherwise empty.
	Password *string `json:"password,omitempty"`
}

EmailChannelProperties - The parameters to provide for the Email channel.

type Error 

type Error struct {
	// The error body.
	Error *ErrorBody `json:"error,omitempty"`
}

Error - Bot Service error object.

type ErrorBody 

type ErrorBody struct {
	// REQUIRED; error code
	Code *string `json:"code,omitempty"`

	// REQUIRED; error message
	Message *string `json:"message,omitempty"`
}

ErrorBody - Bot Service error body.

type FacebookChannel 

type FacebookChannel struct {
	// REQUIRED; The channel name
	ChannelName *string `json:"channelName,omitempty"`

	// Entity Tag of the resource
	Etag *string `json:"etag,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// The set of properties specific to bot facebook channel
	Properties *FacebookChannelProperties `json:"properties,omitempty"`

	// READ-ONLY; Provisioning state of the resource
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

FacebookChannel - Facebook channel definition

func (*FacebookChannel) GetChannel added in v0.2.0 

func (f *FacebookChannel) GetChannel() *Channel

GetChannel implements the ChannelClassification interface for type FacebookChannel.

func (FacebookChannel) MarshalJSON 

func (f FacebookChannel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FacebookChannel.

func (*FacebookChannel) UnmarshalJSON 

func (f *FacebookChannel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FacebookChannel.

type FacebookChannelProperties 

type FacebookChannelProperties struct {
	// REQUIRED; Facebook application id
	AppID *string `json:"appId,omitempty"`

	// REQUIRED; Whether this channel is enabled for the bot
	IsEnabled *bool `json:"isEnabled,omitempty"`

	// Facebook application secret. Value only returned through POST to the action Channel List API, otherwise empty.
	AppSecret *string `json:"appSecret,omitempty"`

	// The list of Facebook pages
	Pages []*FacebookPage `json:"pages,omitempty"`

	// READ-ONLY; Callback Url
	CallbackURL *string `json:"callbackUrl,omitempty" azure:"ro"`

	// READ-ONLY; Verify token. Value only returned through POST to the action Channel List API, otherwise empty.
	VerifyToken *string `json:"verifyToken,omitempty" azure:"ro"`
}

FacebookChannelProperties - The parameters to provide for the Facebook channel.

func (FacebookChannelProperties) MarshalJSON 

func (f FacebookChannelProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FacebookChannelProperties.

type FacebookPage 

type FacebookPage struct {
	// REQUIRED; Page id
	ID *string `json:"id,omitempty"`

	// Facebook application access token. Value only returned through POST to the action Channel List API, otherwise empty.
	AccessToken *string `json:"accessToken,omitempty"`
}

FacebookPage - A Facebook page for Facebook channel registration

type HostSettingsClient 

type HostSettingsClient struct {
	// contains filtered or unexported fields
}

HostSettingsClient contains the methods for the HostSettings group. Don't use this type directly, use NewHostSettingsClient() instead.

func NewHostSettingsClient 

func NewHostSettingsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*HostSettingsClient, error)

NewHostSettingsClient creates a new instance of HostSettingsClient with the specified values. subscriptionID - Azure Subscription ID. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*HostSettingsClient) Get 

func (client *HostSettingsClient) Get(ctx context.Context, options *HostSettingsClientGetOptions) (HostSettingsClientGetResponse, error)

Get - Get per subscription settings needed to host bot in compute resource such as Azure App Service If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview options - HostSettingsClientGetOptions contains the optional parameters for the HostSettingsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetHostSettings.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewHostSettingsClient("subscription-id", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type HostSettingsClientGetOptions added in v0.2.0 

type HostSettingsClientGetOptions struct {
}

HostSettingsClientGetOptions contains the optional parameters for the HostSettingsClient.Get method.

type HostSettingsClientGetResponse added in v0.2.0 

type HostSettingsClientGetResponse struct {
	HostSettingsResponse
}

HostSettingsClientGetResponse contains the response from method HostSettingsClient.Get.

type HostSettingsResponse 

type HostSettingsResponse struct {
	// Same as toBotFromChannelOpenIdMetadataUrl, used by SDK < v4.12
	BotOpenIDMetadata *string `json:"BotOpenIdMetadata,omitempty"`

	// For in-conversation bot user authentication
	OAuthURL *string `json:"OAuthUrl,omitempty"`

	// For verifying incoming tokens from the channels
	ToBotFromChannelOpenIDMetadataURL *string `json:"ToBotFromChannelOpenIdMetadataUrl,omitempty"`

	// For verifying incoming tokens from the channels
	ToBotFromChannelTokenIssuer *string `json:"ToBotFromChannelTokenIssuer,omitempty"`

	// For verifying incoming tokens from bot emulator
	ToBotFromEmulatorOpenIDMetadataURL *string `json:"ToBotFromEmulatorOpenIdMetadataUrl,omitempty"`

	// For getting access token to channels from bot host
	ToChannelFromBotLoginURL *string `json:"ToChannelFromBotLoginUrl,omitempty"`

	// For getting access token to channels from bot host
	ToChannelFromBotOAuthScope *string `json:"ToChannelFromBotOAuthScope,omitempty"`

	// Per cloud OAuth setting on whether authority is validated
	ValidateAuthority *bool `json:"ValidateAuthority,omitempty"`
}

HostSettingsResponse - The response body returned for a request to Bot Service Management to check per subscription hostSettings

type Key 

type Key string

Key - Determines which key is to be regenerated 

const (
	KeyKey1 Key = "key1"
	KeyKey2 Key = "key2"
)

func PossibleKeyValues 

func PossibleKeyValues() []Key

PossibleKeyValues returns the possible values for the Key const type.

type KikChannel 

type KikChannel struct {
	// REQUIRED; The channel name
	ChannelName *string `json:"channelName,omitempty"`

	// Entity Tag of the resource
	Etag *string `json:"etag,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// The set of properties specific to Kik channel resource
	Properties *KikChannelProperties `json:"properties,omitempty"`

	// READ-ONLY; Provisioning state of the resource
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

KikChannel - Kik channel definition

func (*KikChannel) GetChannel added in v0.2.0 

func (k *KikChannel) GetChannel() *Channel

GetChannel implements the ChannelClassification interface for type KikChannel.

func (KikChannel) MarshalJSON 

func (k KikChannel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KikChannel.

func (*KikChannel) UnmarshalJSON 

func (k *KikChannel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KikChannel.

type KikChannelProperties 

type KikChannelProperties struct {
	// REQUIRED; Whether this channel is enabled for the bot
	IsEnabled *bool `json:"isEnabled,omitempty"`

	// REQUIRED; The Kik user name
	UserName *string `json:"userName,omitempty"`

	// Kik API key. Value only returned through POST to the action Channel List API, otherwise empty.
	APIKey *string `json:"apiKey,omitempty"`

	// Whether this channel is validated for the bot
	IsValidated *bool `json:"isValidated,omitempty"`
}

KikChannelProperties - The parameters to provide for the Kik channel.

type Kind 

type Kind string

Kind - Indicates the type of bot service 

const (
	KindAzurebot Kind = "azurebot"
	KindBot      Kind = "bot"
	KindDesigner Kind = "designer"
	KindFunction Kind = "function"
	KindSdk      Kind = "sdk"
)

func PossibleKindValues 

func PossibleKindValues() []Kind

PossibleKindValues returns the possible values for the Kind const type.

type LineChannel 

type LineChannel struct {
	// REQUIRED; The channel name
	ChannelName *string `json:"channelName,omitempty"`

	// Entity Tag of the resource
	Etag *string `json:"etag,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// The set of properties specific to line channel resource
	Properties *LineChannelProperties `json:"properties,omitempty"`

	// READ-ONLY; Provisioning state of the resource
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

LineChannel - Line channel definition

func (*LineChannel) GetChannel added in v0.2.0 

func (l *LineChannel) GetChannel() *Channel

GetChannel implements the ChannelClassification interface for type LineChannel.

func (LineChannel) MarshalJSON 

func (l LineChannel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LineChannel.

func (*LineChannel) UnmarshalJSON 

func (l *LineChannel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LineChannel.

type LineChannelProperties 

type LineChannelProperties struct {
	// REQUIRED; The list of line channel registrations
	LineRegistrations []*LineRegistration `json:"lineRegistrations,omitempty"`

	// READ-ONLY; Callback Url to enter in line registration.
	CallbackURL *string `json:"callbackUrl,omitempty" azure:"ro"`

	// READ-ONLY; Whether this channel is validated for the bot
	IsValidated *bool `json:"isValidated,omitempty" azure:"ro"`
}

LineChannelProperties - The parameters to provide for the Line channel.

func (LineChannelProperties) MarshalJSON 

func (l LineChannelProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LineChannelProperties.

type LineRegistration 

type LineRegistration struct {
	// Access token for the line channel registration
	ChannelAccessToken *string `json:"channelAccessToken,omitempty"`

	// Secret for the line channel registration
	ChannelSecret *string `json:"channelSecret,omitempty"`

	// READ-ONLY; Id generated for the line channel registration
	GeneratedID *string `json:"generatedId,omitempty" azure:"ro"`
}

LineRegistration - The properties corresponding to a line channel registration

type ListChannelWithKeysResponse added in v0.2.0 

type ListChannelWithKeysResponse struct {
	// Changed time of the resource
	ChangedTime *string `json:"changedTime,omitempty"`

	// Entity tag of the resource
	EntityTag *string `json:"entityTag,omitempty"`

	// Entity Tag
	Etag *string `json:"etag,omitempty"`

	// Required. Gets or sets the Kind of the resource.
	Kind *Kind `json:"kind,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// The set of properties specific to bot channel resource
	Properties ChannelClassification `json:"properties,omitempty"`

	// Provisioning state of the resource
	ProvisioningState *string `json:"provisioningState,omitempty"`

	// The set of properties specific to bot channel resource
	Resource ChannelClassification `json:"resource,omitempty"`

	// Gets or sets the SKU of the resource.
	SKU *SKU `json:"sku,omitempty"`

	// Channel settings
	Setting *ChannelSettings `json:"setting,omitempty"`

	// Contains resource tags defined as key/value pairs.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Specifies the resource ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Specifies the name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Specifies the type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`

	// READ-ONLY; Entity zones
	Zones []*string `json:"zones,omitempty" azure:"ro"`
}

ListChannelWithKeysResponse - The ARM channel of list channel with keys operation response.

func (ListChannelWithKeysResponse) MarshalJSON added in v0.2.0 

func (l ListChannelWithKeysResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListChannelWithKeysResponse.

func (*ListChannelWithKeysResponse) UnmarshalJSON added in v0.2.0 

func (l *ListChannelWithKeysResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ListChannelWithKeysResponse.

type MsTeamsChannel 

type MsTeamsChannel struct {
	// REQUIRED; The channel name
	ChannelName *string `json:"channelName,omitempty"`

	// Entity Tag of the resource
	Etag *string `json:"etag,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// The set of properties specific to Microsoft Teams channel resource
	Properties *MsTeamsChannelProperties `json:"properties,omitempty"`

	// READ-ONLY; Provisioning state of the resource
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

MsTeamsChannel - Microsoft Teams channel definition

func (*MsTeamsChannel) GetChannel added in v0.2.0 

func (m *MsTeamsChannel) GetChannel() *Channel

GetChannel implements the ChannelClassification interface for type MsTeamsChannel.

func (MsTeamsChannel) MarshalJSON 

func (m MsTeamsChannel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MsTeamsChannel.

func (*MsTeamsChannel) UnmarshalJSON 

func (m *MsTeamsChannel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MsTeamsChannel.

type MsTeamsChannelProperties 

type MsTeamsChannelProperties struct {
	// REQUIRED; Whether this channel is enabled for the bot
	IsEnabled *bool `json:"isEnabled,omitempty"`

	// Whether this channel accepted terms
	AcceptedTerms *bool `json:"acceptedTerms,omitempty"`

	// Webhook for Microsoft Teams channel calls
	CallingWebHook *string `json:"callingWebHook,omitempty"`

	// Deployment environment for Microsoft Teams channel calls
	DeploymentEnvironment *string `json:"deploymentEnvironment,omitempty"`

	// Enable calling for Microsoft Teams channel
	EnableCalling *bool `json:"enableCalling,omitempty"`

	// Webhook for Microsoft Teams channel calls
	IncomingCallRoute *string `json:"incomingCallRoute,omitempty"`
}

MsTeamsChannelProperties - The parameters to provide for the Microsoft Teams channel.

type MsaAppType 

type MsaAppType string

MsaAppType - Microsoft App Type for the bot 

const (
	MsaAppTypeMultiTenant     MsaAppType = "MultiTenant"
	MsaAppTypeSingleTenant    MsaAppType = "SingleTenant"
	MsaAppTypeUserAssignedMSI MsaAppType = "UserAssignedMSI"
)

func PossibleMsaAppTypeValues 

func PossibleMsaAppTypeValues() []MsaAppType

PossibleMsaAppTypeValues returns the possible values for the MsaAppType const type.

type OperationDisplayInfo 

type OperationDisplayInfo struct {
	// The description of the operation.
	Description *string `json:"description,omitempty"`

	// The action that users can perform, based on their permission level.
	Operation *string `json:"operation,omitempty"`

	// Service provider: Microsoft Bot Service.
	Provider *string `json:"provider,omitempty"`

	// Resource on which the operation is performed.
	Resource *string `json:"resource,omitempty"`
}

OperationDisplayInfo - The operation supported by Bot Service Management.

type OperationEntity 

type OperationEntity struct {
	// The operation supported by Bot Service Management.
	Display *OperationDisplayInfo `json:"display,omitempty"`

	// Operation name: {provider}/{resource}/{operation}.
	Name *string `json:"name,omitempty"`

	// The origin of the operation.
	Origin *string `json:"origin,omitempty"`

	// Additional properties.
	Properties interface{} `json:"properties,omitempty"`
}

OperationEntity - The operations supported by Bot Service Management.

type OperationEntityListResult 

type OperationEntityListResult struct {
	// The link used to get the next page of operations.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of operations.
	Value []*OperationEntity `json:"value,omitempty"`
}

OperationEntityListResult - The list of bot service operation response.

type OperationResultStatus 

type OperationResultStatus string

OperationResultStatus - The status of the operation being performed. 

const (
	OperationResultStatusCanceled  OperationResultStatus = "Canceled"
	OperationResultStatusFailed    OperationResultStatus = "Failed"
	OperationResultStatusRequested OperationResultStatus = "Requested"
	OperationResultStatusRunning   OperationResultStatus = "Running"
	OperationResultStatusSucceeded OperationResultStatus = "Succeeded"
)

func PossibleOperationResultStatusValues 

func PossibleOperationResultStatusValues() []OperationResultStatus

PossibleOperationResultStatusValues returns the possible values for the OperationResultStatus const type.

type OperationResultsClient 

type OperationResultsClient struct {
	// contains filtered or unexported fields
}

OperationResultsClient contains the methods for the OperationResults group. Don't use this type directly, use NewOperationResultsClient() instead.

func NewOperationResultsClient 

func NewOperationResultsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationResultsClient, error)

NewOperationResultsClient creates a new instance of OperationResultsClient with the specified values. subscriptionID - Azure Subscription ID. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OperationResultsClient) BeginGet 

func (client *OperationResultsClient) BeginGet(ctx context.Context, operationResultID string, options *OperationResultsClientBeginGetOptions) (*runtime.Poller[OperationResultsClientGetResponse], error)

BeginGet - Get the operation result for a long running operation. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview operationResultID - The ID of the operation result to get. options - OperationResultsClientBeginGetOptions contains the optional parameters for the OperationResultsClient.BeginGet method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/OperationResultsGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewOperationResultsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginGet(ctx,
		"exampleid",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type OperationResultsClientBeginGetOptions added in v0.2.0 

type OperationResultsClientBeginGetOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

OperationResultsClientBeginGetOptions contains the optional parameters for the OperationResultsClient.BeginGet method.

type OperationResultsClientGetResponse added in v0.2.0 

type OperationResultsClientGetResponse struct {
	OperationResultsDescription
}

OperationResultsClientGetResponse contains the response from method OperationResultsClient.Get.

type OperationResultsDescription 

type OperationResultsDescription struct {
	// READ-ONLY; The ID of the operation returned.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the operation result.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The time that the operation was started.
	StartTime *time.Time `json:"startTime,omitempty" azure:"ro"`

	// READ-ONLY; The status of the operation being performed.
	Status *OperationResultStatus `json:"status,omitempty" azure:"ro"`
}

OperationResultsDescription - The properties indicating the operation result of an operation on a service.

func (*OperationResultsDescription) UnmarshalJSON 

func (o *OperationResultsDescription) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationResultsDescription.

type OperationsClient 

type OperationsClient struct {
	// contains filtered or unexported fields
}

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OperationsClient) NewListPager added in v0.4.0 

func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]

NewListPager - Lists all the available BotService operations. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetOperations.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewOperationsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type OperationsClientListOptions added in v0.2.0 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListResponse added in v0.2.0 

type OperationsClientListResponse struct {
	OperationEntityListResult
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type PrivateEndpoint 

type PrivateEndpoint struct {
	// READ-ONLY; The ARM identifier for Private Endpoint
	ID *string `json:"id,omitempty" azure:"ro"`
}

PrivateEndpoint - The Private Endpoint resource.

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	// Resource properties.
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateEndpointConnection - The Private Endpoint Connection resource.

type PrivateEndpointConnectionListResult 

type PrivateEndpointConnectionListResult struct {
	// Array of private endpoint connections
	Value []*PrivateEndpointConnection `json:"value,omitempty"`
}

PrivateEndpointConnectionListResult - List of private endpoint connection associated with the specified storage account

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	// REQUIRED; A collection of information about the state of the connection between service consumer and provider.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`

	// The resource of private end point.
	PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"`

	// READ-ONLY; The provisioning state of the private endpoint connection resource.
	ProvisioningState *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PrivateEndpointConnectionProperties - Properties of the PrivateEndpointConnectProperties.

type PrivateEndpointConnectionProvisioningState 

type PrivateEndpointConnectionProvisioningState string

PrivateEndpointConnectionProvisioningState - The current provisioning state. 

const (
	PrivateEndpointConnectionProvisioningStateCreating  PrivateEndpointConnectionProvisioningState = "Creating"
	PrivateEndpointConnectionProvisioningStateDeleting  PrivateEndpointConnectionProvisioningState = "Deleting"
	PrivateEndpointConnectionProvisioningStateFailed    PrivateEndpointConnectionProvisioningState = "Failed"
	PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded"
)

func PossiblePrivateEndpointConnectionProvisioningStateValues 

func PossiblePrivateEndpointConnectionProvisioningStateValues() []PrivateEndpointConnectionProvisioningState

PossiblePrivateEndpointConnectionProvisioningStateValues returns the possible values for the PrivateEndpointConnectionProvisioningState const type.

type PrivateEndpointConnectionsClient 

type PrivateEndpointConnectionsClient struct {
	// contains filtered or unexported fields
}

PrivateEndpointConnectionsClient contains the methods for the PrivateEndpointConnections group. Don't use this type directly, use NewPrivateEndpointConnectionsClient() instead.

func NewPrivateEndpointConnectionsClient 

func NewPrivateEndpointConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateEndpointConnectionsClient, error)

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient with the specified values. subscriptionID - Azure Subscription ID. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateEndpointConnectionsClient) Create 

func (client *PrivateEndpointConnectionsClient) Create(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string, properties PrivateEndpointConnection, options *PrivateEndpointConnectionsClientCreateOptions) (PrivateEndpointConnectionsClientCreateResponse, error)

Create - Update the state of specified private endpoint connection associated with the Bot. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. resourceName - The name of the Bot resource. privateEndpointConnectionName - The name of the private endpoint connection associated with the Azure resource properties - The private endpoint connection properties. options - PrivateEndpointConnectionsClientCreateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Create method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutPrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewPrivateEndpointConnectionsClient("{subscription-id}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Create(ctx,
		"res7687",
		"sto9699",
		"{privateEndpointConnectionName}",
		armbotservice.PrivateEndpointConnection{
			Properties: &armbotservice.PrivateEndpointConnectionProperties{
				PrivateLinkServiceConnectionState: &armbotservice.PrivateLinkServiceConnectionState{
					Description: to.Ptr("Auto-Approved"),
					Status:      to.Ptr(armbotservice.PrivateEndpointServiceConnectionStatusApproved),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*PrivateEndpointConnectionsClient) Delete 

func (client *PrivateEndpointConnectionsClient) Delete(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientDeleteOptions) (PrivateEndpointConnectionsClientDeleteResponse, error)

Delete - Deletes the specified private endpoint connection associated with the Bot. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. resourceName - The name of the Bot resource. privateEndpointConnectionName - The name of the private endpoint connection associated with the Azure resource options - PrivateEndpointConnectionsClientDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/DeletePrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewPrivateEndpointConnectionsClient("{subscription-id}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"res6977",
		"sto2527",
		"{privateEndpointConnectionName}",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*PrivateEndpointConnectionsClient) Get 

func (client *PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientGetOptions) (PrivateEndpointConnectionsClientGetResponse, error)

Get - Gets the specified private endpoint connection associated with the Bot. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. resourceName - The name of the Bot resource. privateEndpointConnectionName - The name of the private endpoint connection associated with the Azure resource options - PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetPrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewPrivateEndpointConnectionsClient("{subscription-id}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"res6977",
		"sto2527",
		"{privateEndpointConnectionName}",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*PrivateEndpointConnectionsClient) NewListPager added in v0.4.0 

func (client *PrivateEndpointConnectionsClient) NewListPager(resourceGroupName string, resourceName string, options *PrivateEndpointConnectionsClientListOptions) *runtime.Pager[PrivateEndpointConnectionsClientListResponse]

NewListPager - List all the private endpoint connections associated with the Bot. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. resourceName - The name of the Bot resource. options - PrivateEndpointConnectionsClientListOptions contains the optional parameters for the PrivateEndpointConnectionsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListPrivateEndpointConnections.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewPrivateEndpointConnectionsClient("{subscription-id}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager("res6977",
		"sto2527",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type PrivateEndpointConnectionsClientCreateOptions added in v0.2.0 

type PrivateEndpointConnectionsClientCreateOptions struct {
}

PrivateEndpointConnectionsClientCreateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Create method.

type PrivateEndpointConnectionsClientCreateResponse added in v0.2.0 

type PrivateEndpointConnectionsClientCreateResponse struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientCreateResponse contains the response from method PrivateEndpointConnectionsClient.Create.

type PrivateEndpointConnectionsClientDeleteOptions added in v0.2.0 

type PrivateEndpointConnectionsClientDeleteOptions struct {
}

PrivateEndpointConnectionsClientDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Delete method.

type PrivateEndpointConnectionsClientDeleteResponse added in v0.2.0 

type PrivateEndpointConnectionsClientDeleteResponse struct {
}

PrivateEndpointConnectionsClientDeleteResponse contains the response from method PrivateEndpointConnectionsClient.Delete.

type PrivateEndpointConnectionsClientGetOptions added in v0.2.0 

type PrivateEndpointConnectionsClientGetOptions struct {
}

PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

type PrivateEndpointConnectionsClientGetResponse added in v0.2.0 

type PrivateEndpointConnectionsClientGetResponse struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientGetResponse contains the response from method PrivateEndpointConnectionsClient.Get.

type PrivateEndpointConnectionsClientListOptions added in v0.2.0 

type PrivateEndpointConnectionsClientListOptions struct {
}

PrivateEndpointConnectionsClientListOptions contains the optional parameters for the PrivateEndpointConnectionsClient.List method.

type PrivateEndpointConnectionsClientListResponse added in v0.2.0 

type PrivateEndpointConnectionsClientListResponse struct {
	PrivateEndpointConnectionListResult
}

PrivateEndpointConnectionsClientListResponse contains the response from method PrivateEndpointConnectionsClient.List.

type PrivateEndpointServiceConnectionStatus 

type PrivateEndpointServiceConnectionStatus string

PrivateEndpointServiceConnectionStatus - The private endpoint connection status. 

const (
	PrivateEndpointServiceConnectionStatusApproved PrivateEndpointServiceConnectionStatus = "Approved"
	PrivateEndpointServiceConnectionStatusPending  PrivateEndpointServiceConnectionStatus = "Pending"
	PrivateEndpointServiceConnectionStatusRejected PrivateEndpointServiceConnectionStatus = "Rejected"
)

func PossiblePrivateEndpointServiceConnectionStatusValues 

func PossiblePrivateEndpointServiceConnectionStatusValues() []PrivateEndpointServiceConnectionStatus

PossiblePrivateEndpointServiceConnectionStatusValues returns the possible values for the PrivateEndpointServiceConnectionStatus const type.

type PrivateLinkResource 

type PrivateLinkResource struct {
	// Resource properties.
	Properties *PrivateLinkResourceProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateLinkResource - A private link resource

type PrivateLinkResourceBase 

type PrivateLinkResourceBase struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateLinkResourceBase - Common fields that are returned in the response for all BotService Private Link Resources

type PrivateLinkResourceListResult 

type PrivateLinkResourceListResult struct {
	// Array of private link resources
	Value []*PrivateLinkResource `json:"value,omitempty"`
}

PrivateLinkResourceListResult - A list of private link resources

type PrivateLinkResourceProperties 

type PrivateLinkResourceProperties struct {
	// The private link resource Private link DNS zone name.
	RequiredZoneNames []*string `json:"requiredZoneNames,omitempty"`

	// READ-ONLY; The private link resource group id.
	GroupID *string `json:"groupId,omitempty" azure:"ro"`

	// READ-ONLY; The private link resource required member names.
	RequiredMembers []*string `json:"requiredMembers,omitempty" azure:"ro"`
}

PrivateLinkResourceProperties - Properties of a private link resource.

func (PrivateLinkResourceProperties) MarshalJSON 

func (p PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceProperties.

type PrivateLinkResourcesClient 

type PrivateLinkResourcesClient struct {
	// contains filtered or unexported fields
}

PrivateLinkResourcesClient contains the methods for the PrivateLinkResources group. Don't use this type directly, use NewPrivateLinkResourcesClient() instead.

func NewPrivateLinkResourcesClient 

func NewPrivateLinkResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateLinkResourcesClient, error)

NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient with the specified values. subscriptionID - Azure Subscription ID. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateLinkResourcesClient) ListByBotResource 

func (client *PrivateLinkResourcesClient) ListByBotResource(ctx context.Context, resourceGroupName string, resourceName string, options *PrivateLinkResourcesClientListByBotResourceOptions) (PrivateLinkResourcesClientListByBotResourceResponse, error)

ListByBotResource - Gets the private link resources that need to be created for a Bot. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-05-01-preview resourceGroupName - The name of the Bot resource group in the user subscription. resourceName - The name of the Bot resource. options - PrivateLinkResourcesClientListByBotResourceOptions contains the optional parameters for the PrivateLinkResourcesClient.ListByBotResource method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListPrivateLinkResources.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/botservice/armbotservice"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armbotservice.NewPrivateLinkResourcesClient("{subscription-id}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListByBotResource(ctx,
		"res6977",
		"sto2527",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type PrivateLinkResourcesClientListByBotResourceOptions added in v0.2.0 

type PrivateLinkResourcesClientListByBotResourceOptions struct {
}

PrivateLinkResourcesClientListByBotResourceOptions contains the optional parameters for the PrivateLinkResourcesClient.ListByBotResource method.

type PrivateLinkResourcesClientListByBotResourceResponse added in v0.2.0 

type PrivateLinkResourcesClientListByBotResourceResponse struct {
	PrivateLinkResourceListResult
}

PrivateLinkResourcesClientListByBotResourceResponse contains the response from method PrivateLinkResourcesClient.ListByBotResource.

type PrivateLinkServiceConnectionState 

type PrivateLinkServiceConnectionState struct {
	// A message indicating if changes on the service provider require any updates on the consumer.
	ActionsRequired *string `json:"actionsRequired,omitempty"`

	// The reason for approval/rejection of the connection.
	Description *string `json:"description,omitempty"`

	// Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
	Status *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
}

PrivateLinkServiceConnectionState - A collection of information about the state of the connection between service consumer and provider.

type PublicNetworkAccess added in v0.2.0 

type PublicNetworkAccess string

PublicNetworkAccess - Whether the bot is in an isolated network 

const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "Enabled"
)

func PossiblePublicNetworkAccessValues added in v0.2.0 

func PossiblePublicNetworkAccessValues() []PublicNetworkAccess

PossiblePublicNetworkAccessValues returns the possible values for the PublicNetworkAccess const type.

type RegenerateKeysChannelName 

type RegenerateKeysChannelName string
const (
	RegenerateKeysChannelNameWebChatChannel    RegenerateKeysChannelName = "WebChatChannel"
	RegenerateKeysChannelNameDirectLineChannel RegenerateKeysChannelName = "DirectLineChannel"
)

func PossibleRegenerateKeysChannelNameValues 

func PossibleRegenerateKeysChannelNameValues() []RegenerateKeysChannelName

PossibleRegenerateKeysChannelNameValues returns the possible values for the RegenerateKeysChannelName const type.

type Resource 

type Resource struct {
	// Entity Tag
	Etag *string `json:"etag,omitempty"`

	// Required. Gets or sets the Kind of the resource.
	Kind *Kind `json:"kind,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// Gets or sets the SKU of the resource.
	SKU *SKU `json:"sku,omitempty"`

	// Contains resource tags defined as key/value pairs.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Specifies the resource ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Specifies the name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Specifies the type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`

	// READ-ONLY; Entity zones
	Zones []*string `json:"zones,omitempty" azure:"ro"`
}

Resource - Azure resource

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Resource.

type SKU 

type SKU struct {
	// REQUIRED; The sku name
	Name *SKUName `json:"name,omitempty"`

	// READ-ONLY; Gets the sku tier. This is based on the SKU name.
	Tier *SKUTier `json:"tier,omitempty" azure:"ro"`
}

SKU - The SKU of the cognitive services account.

type SKUName 

type SKUName string

SKUName - The name of SKU. 

const (
	SKUNameF0 SKUName = "F0"
	SKUNameS1 SKUName = "S1"
)

func PossibleSKUNameValues 

func PossibleSKUNameValues() []SKUName

PossibleSKUNameValues returns the possible values for the SKUName const type.

type SKUTier 

type SKUTier string

SKUTier - Gets the sku tier. This is based on the SKU name. 

const (
	SKUTierFree     SKUTier = "Free"
	SKUTierStandard SKUTier = "Standard"
)

func PossibleSKUTierValues 

func PossibleSKUTierValues() []SKUTier

PossibleSKUTierValues returns the possible values for the SKUTier const type.

type ServiceProvider 

type ServiceProvider struct {
	// The Properties of a Service Provider Object
	Properties *ServiceProviderProperties `json:"properties,omitempty"`
}

ServiceProvider - Service Provider Definition

type ServiceProviderParameter 

type ServiceProviderParameter struct {
	// READ-ONLY; Default Name for the Service Provider
	Default *string `json:"default,omitempty" azure:"ro"`

	// READ-ONLY; Description of the Service Provider
	Description *string `json:"description,omitempty" azure:"ro"`

	// READ-ONLY; Display Name of the Service Provider
	DisplayName *string `json:"displayName,omitempty" azure:"ro"`

	// READ-ONLY; Help Url for the Service Provider
	HelpURL *string `json:"helpUrl,omitempty" azure:"ro"`

	// READ-ONLY; Meta data for the Service Provider
	Metadata *ServiceProviderParameterMetadata `json:"metadata,omitempty" azure:"ro"`

	// READ-ONLY; Name of the Service Provider
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Type of the Service Provider
	Type *string `json:"type,omitempty" azure:"ro"`
}

ServiceProviderParameter - Extra Parameters specific to each Service Provider

type ServiceProviderParameterMetadata added in v0.2.0 

type ServiceProviderParameterMetadata struct {
	// the constraints of the bot meta data.
	Constraints *ServiceProviderParameterMetadataConstraints `json:"constraints,omitempty"`
}

ServiceProviderParameterMetadata - Meta data for the Service Provider

type ServiceProviderParameterMetadataConstraints added in v0.2.0 

type ServiceProviderParameterMetadataConstraints struct {
	// Whether required the constraints of the bot meta data.
	Required *bool `json:"required,omitempty"`
}

ServiceProviderParameterMetadataConstraints - the constraints of the bot meta data.

type ServiceProviderProperties 

type ServiceProviderProperties struct {
	// The list of parameters for the Service Provider
	Parameters []*ServiceProviderParameter `json:"parameters,omitempty"`

	// READ-ONLY; Display Name of the Service Provider
	DevPortalURL *string `json:"devPortalUrl,omitempty" azure:"ro"`

	// READ-ONLY; Display Name of the Service Provider
	DisplayName *string `json:"displayName,omitempty" azure:"ro"`

	// READ-ONLY; Id for Service Provider
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Display Name of the Service Provider
	IconURL *string `json:"iconUrl,omitempty" azure:"ro"`

	// READ-ONLY; Display Name of the Service Provider
	ServiceProviderName *string `json:"serviceProviderName,omitempty" azure:"ro"`
}

ServiceProviderProperties - The Object used to describe a Service Provider supported by Bot Service

type ServiceProviderResponseList 

type ServiceProviderResponseList struct {
	// The link used to get the next page of bot service providers.
	NextLink *string `json:"nextLink,omitempty"`

	// READ-ONLY; Gets the list of bot service providers and their properties.
	Value []*ServiceProvider `json:"value,omitempty" azure:"ro"`
}

ServiceProviderResponseList - The list of bot service providers response.

type Site added in v0.2.0 

type Site struct {
	// REQUIRED; Whether this site is enabled for DirectLine channel
	IsEnabled *bool `json:"isEnabled,omitempty"`

	// REQUIRED; Whether this site is enabled for Bot Framework V1 protocol.
	IsV1Enabled *bool `json:"isV1Enabled,omitempty"`

	// REQUIRED; Whether this site is enabled for Bot Framework V1 protocol.
	IsV3Enabled *bool `json:"isV3Enabled,omitempty"`

	// REQUIRED; Whether this site is enabled for preview versions of Webchat
	IsWebchatPreviewEnabled *bool `json:"isWebchatPreviewEnabled,omitempty"`

	// REQUIRED; Site name
	SiteName *string `json:"siteName,omitempty"`

	// Entity Tag
	ETag *string `json:"eTag,omitempty"`

	// Whether this site is enabled for block user upload.
	IsBlockUserUploadEnabled *bool `json:"isBlockUserUploadEnabled,omitempty"`

	// Whether this site is enabled for authentication with Bot Framework.
	IsSecureSiteEnabled *bool `json:"isSecureSiteEnabled,omitempty"`

	// Whether this site is token enabled for channel
	IsTokenEnabled *bool `json:"isTokenEnabled,omitempty"`

	// List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True.
	TrustedOrigins []*string `json:"trustedOrigins,omitempty"`

	// READ-ONLY; Primary key. Value only returned through POST to the action Channel List API, otherwise empty.
	Key *string `json:"key,omitempty" azure:"ro"`

	// READ-ONLY; Secondary key. Value only returned through POST to the action Channel List API, otherwise empty.
	Key2 *string `json:"key2,omitempty" azure:"ro"`

	// READ-ONLY; Site Id
	SiteID *string `json:"siteId,omitempty" azure:"ro"`
}

Site - A site for the channel

func (Site) MarshalJSON added in v0.2.0 

func (s Site) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Site.

type SiteInfo 

type SiteInfo struct {
	// REQUIRED; Determines which key is to be regenerated
	Key *Key `json:"key,omitempty"`

	// REQUIRED; The site name
	SiteName *string `json:"siteName,omitempty"`
}

SiteInfo - Site information for WebChat or DirectLine Channels to identify which site to regenerate keys for.

type SkypeChannel 

type SkypeChannel struct {
	// REQUIRED; The channel name
	ChannelName *string `json:"channelName,omitempty"`

	// Entity Tag of the resource
	Etag *string `json:"etag,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// The set of properties specific to Skype channel resource
	Properties *SkypeChannelProperties `json:"properties,omitempty"`

	// READ-ONLY; Provisioning state of the resource
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

SkypeChannel - Skype channel definition

func (*SkypeChannel) GetChannel added in v0.2.0 

func (s *SkypeChannel) GetChannel() *Channel

GetChannel implements the ChannelClassification interface for type SkypeChannel.

func (SkypeChannel) MarshalJSON 

func (s SkypeChannel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SkypeChannel.

func (*SkypeChannel) UnmarshalJSON 

func (s *SkypeChannel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SkypeChannel.

type SkypeChannelProperties 

type SkypeChannelProperties struct {
	// REQUIRED; Whether this channel is enabled for the bot
	IsEnabled *bool `json:"isEnabled,omitempty"`

	// Calling web hook for Skype channel
	CallingWebHook *string `json:"callingWebHook,omitempty"`

	// Enable calling for Skype channel
	EnableCalling *bool `json:"enableCalling,omitempty"`

	// Enable groups for Skype channel
	EnableGroups *bool `json:"enableGroups,omitempty"`

	// Enable media cards for Skype channel
	EnableMediaCards *bool `json:"enableMediaCards,omitempty"`

	// Enable messaging for Skype channel
	EnableMessaging *bool `json:"enableMessaging,omitempty"`

	// Enable screen sharing for Skype channel
	EnableScreenSharing *bool `json:"enableScreenSharing,omitempty"`

	// Enable video for Skype channel
	EnableVideo *bool `json:"enableVideo,omitempty"`

	// Group mode for Skype channel
	GroupsMode *string `json:"groupsMode,omitempty"`

	// Incoming call route for Skype channel
	IncomingCallRoute *string `json:"incomingCallRoute,omitempty"`
}

SkypeChannelProperties - The parameters to provide for the Microsoft Teams channel.

type SlackChannel 

type SlackChannel struct {
	// REQUIRED; The channel name
	ChannelName *string `json:"channelName,omitempty"`

	// Entity Tag of the resource
	Etag *string `json:"etag,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// The set of properties specific to Slack channel resource
	Properties *SlackChannelProperties `json:"properties,omitempty"`

	// READ-ONLY; Provisioning state of the resource
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

SlackChannel - Slack channel definition

func (*SlackChannel) GetChannel added in v0.2.0 

func (s *SlackChannel) GetChannel() *Channel

GetChannel implements the ChannelClassification interface for type SlackChannel.

func (SlackChannel) MarshalJSON 

func (s SlackChannel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SlackChannel.

func (*SlackChannel) UnmarshalJSON 

func (s *SlackChannel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SlackChannel.

type SlackChannelProperties 

type SlackChannelProperties struct {
	// REQUIRED; Whether this channel is enabled for the bot
	IsEnabled *bool `json:"isEnabled,omitempty"`

	// The Slack client id
	ClientID *string `json:"clientId,omitempty"`

	// The Slack client secret. Value only returned through POST to the action Channel List API, otherwise empty.
	ClientSecret *string `json:"clientSecret,omitempty"`

	// The Slack landing page Url
	LandingPageURL *string `json:"landingPageUrl,omitempty"`

	// The Slack permission scopes.
	Scopes *string `json:"scopes,omitempty"`

	// The Slack signing secret.
	SigningSecret *string `json:"signingSecret,omitempty"`

	// The Slack verification token. Value only returned through POST to the action Channel List API, otherwise empty.
	VerificationToken *string `json:"verificationToken,omitempty"`

	// READ-ONLY; Whether this channel is validated for the bot
	IsValidated *bool `json:"IsValidated,omitempty" azure:"ro"`

	// READ-ONLY; The Sms auth token
	LastSubmissionID *string `json:"lastSubmissionId,omitempty" azure:"ro"`

	// READ-ONLY; The Slack redirect action
	RedirectAction *string `json:"redirectAction,omitempty" azure:"ro"`

	// READ-ONLY; Whether to register the settings before OAuth validation is performed. Recommended to True.
	RegisterBeforeOAuthFlow *bool `json:"registerBeforeOAuthFlow,omitempty" azure:"ro"`
}

SlackChannelProperties - The parameters to provide for the Slack channel.

type SmsChannel 

type SmsChannel struct {
	// REQUIRED; The channel name
	ChannelName *string `json:"channelName,omitempty"`

	// Entity Tag of the resource
	Etag *string `json:"etag,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// The set of properties specific to Sms channel resource
	Properties *SmsChannelProperties `json:"properties,omitempty"`

	// READ-ONLY; Provisioning state of the resource
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

SmsChannel - Sms channel definition

func (*SmsChannel) GetChannel added in v0.2.0 

func (s *SmsChannel) GetChannel() *Channel

GetChannel implements the ChannelClassification interface for type SmsChannel.

func (SmsChannel) MarshalJSON 

func (s SmsChannel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SmsChannel.

func (*SmsChannel) UnmarshalJSON 

func (s *SmsChannel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SmsChannel.

type SmsChannelProperties 

type SmsChannelProperties struct {
	// REQUIRED; The Sms account SID. Value only returned through POST to the action Channel List API, otherwise empty.
	AccountSID *string `json:"accountSID,omitempty"`

	// REQUIRED; Whether this channel is enabled for the bot
	IsEnabled *bool `json:"isEnabled,omitempty"`

	// REQUIRED; The Sms phone
	Phone *string `json:"phone,omitempty"`

	// The Sms auth token. Value only returned through POST to the action Channel List API, otherwise empty.
	AuthToken *string `json:"authToken,omitempty"`

	// Whether this channel is validated for the bot
	IsValidated *bool `json:"isValidated,omitempty"`
}

SmsChannelProperties - The parameters to provide for the Sms channel.

type TelegramChannel 

type TelegramChannel struct {
	// REQUIRED; The channel name
	ChannelName *string `json:"channelName,omitempty"`

	// Entity Tag of the resource
	Etag *string `json:"etag,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// The set of properties specific to Telegram channel resource
	Properties *TelegramChannelProperties `json:"properties,omitempty"`

	// READ-ONLY; Provisioning state of the resource
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

TelegramChannel - Telegram channel definition

func (*TelegramChannel) GetChannel added in v0.2.0 

func (t *TelegramChannel) GetChannel() *Channel

GetChannel implements the ChannelClassification interface for type TelegramChannel.

func (TelegramChannel) MarshalJSON 

func (t TelegramChannel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TelegramChannel.

func (*TelegramChannel) UnmarshalJSON 

func (t *TelegramChannel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TelegramChannel.

type TelegramChannelProperties 

type TelegramChannelProperties struct {
	// REQUIRED; Whether this channel is enabled for the bot
	IsEnabled *bool `json:"isEnabled,omitempty"`

	// The Telegram access token. Value only returned through POST to the action Channel List API, otherwise empty.
	AccessToken *string `json:"accessToken,omitempty"`

	// Whether this channel is validated for the bot
	IsValidated *bool `json:"isValidated,omitempty"`
}

TelegramChannelProperties - The parameters to provide for the Telegram channel.

type WebChatChannel 

type WebChatChannel struct {
	// REQUIRED; The channel name
	ChannelName *string `json:"channelName,omitempty"`

	// Entity Tag of the resource
	Etag *string `json:"etag,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// The set of properties specific to Web Chat channel resource
	Properties *WebChatChannelProperties `json:"properties,omitempty"`

	// READ-ONLY; Provisioning state of the resource
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

WebChatChannel - Web Chat channel definition

func (*WebChatChannel) GetChannel added in v0.2.0 

func (w *WebChatChannel) GetChannel() *Channel

GetChannel implements the ChannelClassification interface for type WebChatChannel.

func (WebChatChannel) MarshalJSON 

func (w WebChatChannel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WebChatChannel.

func (*WebChatChannel) UnmarshalJSON 

func (w *WebChatChannel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WebChatChannel.

type WebChatChannelProperties 

type WebChatChannelProperties struct {
	// The list of Web Chat sites
	Sites []*WebChatSite `json:"sites,omitempty"`

	// READ-ONLY; Web chat control embed code
	WebChatEmbedCode *string `json:"webChatEmbedCode,omitempty" azure:"ro"`
}

WebChatChannelProperties - The parameters to provide for the Web Chat channel.

func (WebChatChannelProperties) MarshalJSON 

func (w WebChatChannelProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WebChatChannelProperties.

type WebChatSite 

type WebChatSite struct {
	// REQUIRED; Whether this site is enabled for DirectLine channel
	IsEnabled *bool `json:"isEnabled,omitempty"`

	// REQUIRED; Whether this site is enabled for preview versions of Webchat
	IsWebchatPreviewEnabled *bool `json:"isWebchatPreviewEnabled,omitempty"`

	// REQUIRED; Site name
	SiteName *string `json:"siteName,omitempty"`

	// READ-ONLY; Primary key. Value only returned through POST to the action Channel List API, otherwise empty.
	Key *string `json:"key,omitempty" azure:"ro"`

	// READ-ONLY; Secondary key. Value only returned through POST to the action Channel List API, otherwise empty.
	Key2 *string `json:"key2,omitempty" azure:"ro"`

	// READ-ONLY; Site Id
	SiteID *string `json:"siteId,omitempty" azure:"ro"`
}

WebChatSite - A site for the Webchat channel

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.