Package-level declarations

Types

Link copied to clipboard
data class AcsChatChannelResponse(val channelName: String, val etag: String? = null, val location: String? = null, val provisioningState: String)

AcsChat channel definition

Link copied to clipboard
data class AlexaChannelPropertiesResponse(val alexaSkillId: String, val isEnabled: Boolean, val serviceEndpointUri: String, val urlFragment: String)

The parameters to provide for the Alexa channel.

Link copied to clipboard
data class AlexaChannelResponse(val channelName: String, val etag: String? = null, val location: String? = null, val properties: AlexaChannelPropertiesResponse? = null, val provisioningState: String)

Alexa channel definition

Link copied to clipboard
data class BotPropertiesResponse(val allSettings: Map<String, String>? = null, val appPasswordHint: String? = null, val cmekEncryptionStatus: String, val cmekKeyVaultUrl: String? = null, val configuredChannels: List<String>, val description: String? = null, val developerAppInsightKey: String? = null, val developerAppInsightsApiKey: String? = null, val developerAppInsightsApplicationId: String? = null, val disableLocalAuth: Boolean? = null, val displayName: String, val enabledChannels: List<String>, val endpoint: String, val endpointVersion: String, val iconUrl: String? = null, val isCmekEnabled: Boolean? = null, val isDeveloperAppInsightsApiKeySet: Boolean, val isStreamingSupported: Boolean? = null, val luisAppIds: List<String>? = null, val luisKey: String? = null, val manifestUrl: String? = null, val migrationToken: String, val msaAppId: String, val msaAppMSIResourceId: String? = null, val msaAppTenantId: String? = null, val msaAppType: String? = null, val networkSecurityPerimeterConfigurations: List<NetworkSecurityPerimeterConfigurationResponse>, val openWithHint: String? = null, val parameters: Map<String, String>? = null, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>, val provisioningState: String, val publicNetworkAccess: String? = null, val publishingCredentials: String? = null, val schemaTransformationVersion: String? = null, val storageResourceId: String? = null, val tenantId: String? = null)

The parameters to provide for the Bot.

Link copied to clipboard
data class ChannelSettingsResponse(val botIconUrl: String? = null, val botId: String? = null, val channelDisplayName: String? = null, val channelId: String? = null, val disableLocalAuth: Boolean? = null, val extensionKey1: String? = null, val extensionKey2: String? = null, val isEnabled: Boolean? = null, val requireTermsAgreement: Boolean? = null, val sites: List<SiteResponse>? = null)

Channel settings definition

Link copied to clipboard
data class ConnectionSettingParameterResponse(val key: String? = null, val value: String? = null)

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

Link copied to clipboard
data class ConnectionSettingPropertiesResponse(val clientId: String? = null, val clientSecret: String? = null, val id: String? = null, val name: String? = null, val parameters: List<ConnectionSettingParameterResponse>? = null, val provisioningState: String? = null, val scopes: String? = null, val serviceProviderDisplayName: String? = null, val serviceProviderId: String? = null, val settingId: String)

Properties for a Connection Setting Item

Link copied to clipboard
data class DirectLineChannelPropertiesResponse(val directLineEmbedCode: String? = null, val extensionKey1: String? = null, val extensionKey2: String? = null, val sites: List<DirectLineSiteResponse>? = null)

The parameters to provide for the Direct Line channel.

Link copied to clipboard
data class DirectLineChannelResponse(val channelName: String, val etag: String? = null, val location: String? = null, val properties: DirectLineChannelPropertiesResponse? = null, val provisioningState: String)

Direct Line channel definition

Link copied to clipboard
data class DirectLineSiteResponse(val appId: String? = null, val eTag: String? = null, val isBlockUserUploadEnabled: Boolean? = null, val isDetailedLoggingEnabled: Boolean? = null, val isEnabled: Boolean, val isEndpointParametersEnabled: Boolean? = null, val isNoStorageEnabled: Boolean? = null, val isSecureSiteEnabled: Boolean? = null, val isTokenEnabled: Boolean, val isV1Enabled: Boolean, val isV3Enabled: Boolean, val isWebChatSpeechEnabled: Boolean? = null, val isWebchatPreviewEnabled: Boolean? = null, val key: String, val key2: String, val siteId: String, val siteName: String, val tenantId: String? = null, val trustedOrigins: List<String>? = null)

A site for the Direct Line channel

data class DirectLineSpeechChannelPropertiesResponse(val cognitiveServiceRegion: String? = null, val cognitiveServiceResourceId: String? = null, val cognitiveServiceSubscriptionKey: String? = null, val customSpeechModelId: String? = null, val customVoiceDeploymentId: String? = null, val isDefaultBotForCogSvcAccount: Boolean? = null, val isEnabled: Boolean? = null)

The parameters to provide for the DirectLine Speech channel.

Link copied to clipboard
data class DirectLineSpeechChannelResponse(val channelName: String, val etag: String? = null, val location: String? = null, val properties: DirectLineSpeechChannelPropertiesResponse? = null, val provisioningState: String)

DirectLine Speech channel definition

Link copied to clipboard
data class EmailChannelPropertiesResponse(val authMethod: Double? = null, val emailAddress: String, val isEnabled: Boolean, val magicCode: String? = null, val password: String? = null)

The parameters to provide for the Email channel.

Link copied to clipboard
data class EmailChannelResponse(val channelName: String, val etag: String? = null, val location: String? = null, val properties: EmailChannelPropertiesResponse? = null, val provisioningState: String)

Email channel definition

Link copied to clipboard
data class FacebookChannelPropertiesResponse(val appId: String, val appSecret: String? = null, val callbackUrl: String, val isEnabled: Boolean, val pages: List<FacebookPageResponse>? = null, val verifyToken: String)

The parameters to provide for the Facebook channel.

Link copied to clipboard
data class FacebookChannelResponse(val channelName: String, val etag: String? = null, val location: String? = null, val properties: FacebookChannelPropertiesResponse? = null, val provisioningState: String)

Facebook channel definition

Link copied to clipboard
data class FacebookPageResponse(val accessToken: String? = null, val id: String)

A Facebook page for Facebook channel registration

Link copied to clipboard
data class GetBotConnectionResult(val azureApiVersion: String, val etag: String? = null, val id: String, val kind: String? = null, val location: String? = null, val name: String, val properties: ConnectionSettingPropertiesResponse, val sku: SkuResponse? = null, val tags: Map<String, String>? = null, val type: String, val zones: List<String>)

Bot channel resource definition

Link copied to clipboard
data class GetBotResult(val azureApiVersion: String, val etag: String? = null, val id: String, val kind: String? = null, val location: String? = null, val name: String, val properties: BotPropertiesResponse, val sku: SkuResponse? = null, val tags: Map<String, String>? = null, val type: String, val zones: List<String>)

Bot resource definition

Link copied to clipboard
data class GetChannelResult(val azureApiVersion: String, val etag: String? = null, val id: String, val kind: String? = null, val location: String? = null, val name: String, val properties: Any, val sku: SkuResponse? = null, val tags: Map<String, String>? = null, val type: String, val zones: List<String>)

Bot channel resource definition

Link copied to clipboard
data class GetPrivateEndpointConnectionResult(val azureApiVersion: String, val groupIds: List<String>? = null, val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val type: String)

The Private Endpoint Connection resource.

Link copied to clipboard
data class KikChannelPropertiesResponse(val apiKey: String? = null, val isEnabled: Boolean, val isValidated: Boolean? = null, val userName: String)

The parameters to provide for the Kik channel.

Link copied to clipboard
data class KikChannelResponse(val channelName: String, val etag: String? = null, val location: String? = null, val properties: KikChannelPropertiesResponse? = null, val provisioningState: String)

Kik channel definition

Link copied to clipboard
data class LineChannelPropertiesResponse(val callbackUrl: String, val isValidated: Boolean, val lineRegistrations: List<LineRegistrationResponse>)

The parameters to provide for the Line channel.

Link copied to clipboard
data class LineChannelResponse(val channelName: String, val etag: String? = null, val location: String? = null, val properties: LineChannelPropertiesResponse? = null, val provisioningState: String)

Line channel definition

Link copied to clipboard
data class LineRegistrationResponse(val channelAccessToken: String? = null, val channelSecret: String? = null, val generatedId: String)

The properties corresponding to a line channel registration

Link copied to clipboard
data class ListBotConnectionServiceProvidersResult(val nextLink: String? = null, val value: List<ServiceProviderResponse>)

The list of bot service providers response.

Link copied to clipboard
data class ListBotConnectionWithSecretsResult(val etag: String? = null, val id: String, val kind: String? = null, val location: String? = null, val name: String, val properties: ConnectionSettingPropertiesResponse, val sku: SkuResponse? = null, val tags: Map<String, String>? = null, val type: String, val zones: List<String>)

Bot channel resource definition

Link copied to clipboard
data class ListChannelWithKeysResult(val changedTime: String? = null, val entityTag: String? = null, val etag: String? = null, val id: String, val kind: String? = null, val location: String? = null, val name: String, val properties: Any, val provisioningState: String? = null, val resource: Any? = null, val setting: ChannelSettingsResponse? = null, val sku: SkuResponse? = null, val tags: Map<String, String>? = null, val type: String, val zones: List<String>)

The ARM channel of list channel with keys operation response.

Link copied to clipboard
data class ListQnAMakerEndpointKeyResult(val installedVersion: String? = null, val lastStableVersion: String? = null, val primaryEndpointKey: String? = null, val secondaryEndpointKey: String? = null)

Schema for EndpointKeys generate/refresh operations.

Link copied to clipboard
data class M365ExtensionsResponse(val channelName: String, val etag: String? = null, val location: String? = null, val provisioningState: String)

M365 Extensions definition

Link copied to clipboard
data class MsTeamsChannelPropertiesResponse(val acceptedTerms: Boolean? = null, val callingWebhook: String? = null, val deploymentEnvironment: String? = null, val enableCalling: Boolean? = null, val incomingCallRoute: String? = null, val isEnabled: Boolean)

The parameters to provide for the Microsoft Teams channel.

Link copied to clipboard
data class MsTeamsChannelResponse(val channelName: String, val etag: String? = null, val location: String? = null, val properties: MsTeamsChannelPropertiesResponse? = null, val provisioningState: String)

Microsoft Teams channel definition

data class NetworkSecurityPerimeterConfigurationPropertiesResponse(val networkSecurityPerimeter: NetworkSecurityPerimeterResponse, val profile: ProfileResponse, val provisioningIssues: List<ProvisioningIssueResponse>? = null, val provisioningState: String? = null, val resourceAssociation: ResourceAssociationResponse)

Properties of Network Security Perimeter configuration

data class NetworkSecurityPerimeterConfigurationResponse(val id: String? = null, val name: String? = null, val properties: NetworkSecurityPerimeterConfigurationPropertiesResponse, val type: String? = null)

Network Security Perimeter configuration

Link copied to clipboard
data class NetworkSecurityPerimeterResponse(val id: String, val location: String? = null, val perimeterGuid: String? = null)

Information about Network Security Perimeter

Link copied to clipboard
data class NspAccessRuleResponse(val name: String? = null, val properties: NspAccessRuleResponseProperties)

Information of Access Rule in a profile

Link copied to clipboard
data class NspAccessRuleResponseProperties(val addressPrefixes: List<String>? = null, val direction: String? = null, val emailAddresses: List<String>, val fullyQualifiedDomainNames: List<String>, val networkSecurityPerimeters: List<NetworkSecurityPerimeterResponse>, val phoneNumbers: List<String>, val subscriptions: List<NspAccessRuleResponseSubscriptions>? = null)

Properties of Access Rule

Link copied to clipboard
data class NspAccessRuleResponseSubscriptions(val id: String? = null)

Subscription for inbound rule

Link copied to clipboard
data class OmnichannelResponse(val channelName: String, val etag: String? = null, val location: String? = null, val provisioningState: String)

Omnichannel channel definition

Link copied to clipboard
data class OutlookChannelResponse(val channelName: String, val etag: String? = null, val location: String? = null, val provisioningState: String)

Outlook channel definition

Link copied to clipboard
data class PrivateEndpointConnectionResponse(val groupIds: List<String>? = null, val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val type: String)

The Private Endpoint Connection resource.

Link copied to clipboard
data class PrivateEndpointResponse(val id: String)

The Private Endpoint resource.

data class PrivateLinkServiceConnectionStateResponse(val actionsRequired: String? = null, val description: String? = null, val status: String? = null)

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

Link copied to clipboard
data class ProfileResponse(val accessRules: List<NspAccessRuleResponse>? = null, val accessRulesVersion: Double? = null, val diagnosticSettingsVersion: Double? = null, val enabledLogCategories: List<String>, val name: String? = null)

Information about profile

Link copied to clipboard
data class ProvisioningIssueResponse(val name: String? = null, val properties: ProvisioningIssueResponseProperties)

Describes Provisioning issue for given Network Security Perimeter configuration

Link copied to clipboard
data class ProvisioningIssueResponseProperties(val description: String? = null, val issueType: String? = null, val severity: String? = null, val suggestedAccessRules: List<NspAccessRuleResponse>? = null, val suggestedResourceIds: List<String>)

Properties of Provisioning Issue

Link copied to clipboard
data class ResourceAssociationResponse(val accessMode: String? = null, val name: String? = null)

Information about resource association

Link copied to clipboard
data class SearchAssistantResponse(val channelName: String, val etag: String? = null, val location: String? = null, val provisioningState: String)

SearchAssistant definition

Link copied to clipboard
data class ServiceProviderParameterResponse(val default: String, val description: String, val displayName: String, val helpUrl: String, val metadata: ServiceProviderParameterResponseMetadata, val name: String, val type: String)

Extra Parameters specific to each Service Provider

data class ServiceProviderParameterResponseConstraints(val required: Boolean? = null)

the constraints of the bot meta data.

Link copied to clipboard

Meta data for the Service Provider

Link copied to clipboard
data class ServiceProviderPropertiesResponse(val devPortalUrl: String, val displayName: String, val iconUrl: String? = null, val id: String, val parameters: List<ServiceProviderParameterResponse>? = null, val serviceProviderName: String)

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

Link copied to clipboard

Service Provider Definition

Link copied to clipboard
data class SiteResponse(val appId: String? = null, val eTag: String? = null, val isBlockUserUploadEnabled: Boolean? = null, val isDetailedLoggingEnabled: Boolean? = null, val isEnabled: Boolean, val isEndpointParametersEnabled: Boolean? = null, val isNoStorageEnabled: Boolean? = null, val isSecureSiteEnabled: Boolean? = null, val isTokenEnabled: Boolean, val isV1Enabled: Boolean? = null, val isV3Enabled: Boolean? = null, val isWebChatSpeechEnabled: Boolean? = null, val isWebchatPreviewEnabled: Boolean? = null, val key: String, val key2: String, val siteId: String, val siteName: String, val tenantId: String? = null, val trustedOrigins: List<String>? = null)

A site for the channel

Link copied to clipboard
data class SkuResponse(val name: String, val tier: String)

The SKU of the cognitive services account.

Link copied to clipboard
data class SkypeChannelPropertiesResponse(val callingWebHook: String? = null, val enableCalling: Boolean? = null, val enableGroups: Boolean? = null, val enableMediaCards: Boolean? = null, val enableMessaging: Boolean? = null, val enableScreenSharing: Boolean? = null, val enableVideo: Boolean? = null, val groupsMode: String? = null, val incomingCallRoute: String? = null, val isEnabled: Boolean)

The parameters to provide for the Microsoft Teams channel.

Link copied to clipboard
data class SkypeChannelResponse(val channelName: String, val etag: String? = null, val location: String? = null, val properties: SkypeChannelPropertiesResponse? = null, val provisioningState: String)

Skype channel definition

Link copied to clipboard
data class SlackChannelPropertiesResponse(val clientId: String? = null, val clientSecret: String? = null, val isEnabled: Boolean, val isValidated: Boolean, val landingPageUrl: String? = null, val lastSubmissionId: String, val redirectAction: String, val registerBeforeOAuthFlow: Boolean? = null, val scopes: String? = null, val signingSecret: String? = null, val verificationToken: String? = null)

The parameters to provide for the Slack channel.

Link copied to clipboard
data class SlackChannelResponse(val channelName: String, val etag: String? = null, val location: String? = null, val properties: SlackChannelPropertiesResponse? = null, val provisioningState: String)

Slack channel definition

Link copied to clipboard
data class SmsChannelPropertiesResponse(val accountSID: String, val authToken: String? = null, val isEnabled: Boolean, val isValidated: Boolean? = null, val phone: String)

The parameters to provide for the Sms channel.

Link copied to clipboard
data class SmsChannelResponse(val channelName: String, val etag: String? = null, val location: String? = null, val properties: SmsChannelPropertiesResponse? = null, val provisioningState: String)

Sms channel definition

Link copied to clipboard
data class TelegramChannelPropertiesResponse(val accessToken: String? = null, val isEnabled: Boolean, val isValidated: Boolean? = null)

The parameters to provide for the Telegram channel.

Link copied to clipboard
data class TelegramChannelResponse(val channelName: String, val etag: String? = null, val location: String? = null, val properties: TelegramChannelPropertiesResponse? = null, val provisioningState: String)

Telegram channel definition

Link copied to clipboard
data class TelephonyChannelPropertiesResponse(val apiConfigurations: List<TelephonyChannelResourceApiConfigurationResponse>? = null, val cognitiveServiceRegion: String? = null, val cognitiveServiceSubscriptionKey: String? = null, val defaultLocale: String? = null, val isEnabled: Boolean? = null, val phoneNumbers: List<TelephonyPhoneNumbersResponse>? = null, val premiumSKU: String? = null)

The parameters to provide for the Direct Line channel.

data class TelephonyChannelResourceApiConfigurationResponse(val cognitiveServiceRegion: String? = null, val cognitiveServiceResourceId: String? = null, val cognitiveServiceSubscriptionKey: String? = null, val defaultLocale: String? = null, val id: String? = null, val providerName: String? = null)

A resource Api configuration for the Telephony channel

Link copied to clipboard
data class TelephonyChannelResponse(val channelName: String, val etag: String? = null, val location: String? = null, val properties: TelephonyChannelPropertiesResponse? = null, val provisioningState: String)

Telephony channel definition

Link copied to clipboard
data class TelephonyPhoneNumbersResponse(val acsEndpoint: String? = null, val acsResourceId: String? = null, val acsSecret: String? = null, val cognitiveServiceRegion: String? = null, val cognitiveServiceResourceId: String? = null, val cognitiveServiceSubscriptionKey: String? = null, val defaultLocale: String? = null, val id: String? = null, val offerType: String? = null, val phoneNumber: String? = null)

A telephone number for the Telephony channel

Link copied to clipboard
data class WebChatChannelPropertiesResponse(val sites: List<WebChatSiteResponse>? = null, val webChatEmbedCode: String)

The parameters to provide for the Web Chat channel.

Link copied to clipboard
data class WebChatChannelResponse(val channelName: String, val etag: String? = null, val location: String? = null, val properties: WebChatChannelPropertiesResponse? = null, val provisioningState: String)

Web Chat channel definition

Link copied to clipboard
data class WebChatSiteResponse(val appId: String? = null, val eTag: String? = null, val isBlockUserUploadEnabled: Boolean? = null, val isDetailedLoggingEnabled: Boolean? = null, val isEnabled: Boolean, val isEndpointParametersEnabled: Boolean? = null, val isNoStorageEnabled: Boolean? = null, val isSecureSiteEnabled: Boolean? = null, val isTokenEnabled: Boolean, val isV1Enabled: Boolean? = null, val isV3Enabled: Boolean? = null, val isWebChatSpeechEnabled: Boolean? = null, val isWebchatPreviewEnabled: Boolean, val key: String, val key2: String, val siteId: String, val siteName: String, val tenantId: String? = null, val trustedOrigins: List<String>? = null)

A site for the Webchat channel