Microsoft.BotService (preview:2023-09-15)

2025/07/23 • 10 updated methods

Bots_List (updated)
Description :  Returns all the resources of a particular type belonging to a subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Bots_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@added_c11102813faf444483dcf0819765abb9": {
              "#name": "location",
              "Description": "Specifies the location of the resource.",
              "Required": false,
              "Type": "string"
            },
            "@added_f69a03cd1d264188a8cdfeee438d7c2e": {
              "#name": "tags",
              "Description": "Contains resource tags defined as key/value pairs.",
              "Required": false,
              "Type": "object"
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.BotService/botServices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Bot items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
networkSecurityPerimeterConfigurations:
{
Description: List of Network Security Perimeter configurations for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Network Security Perimeter configuration ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningIssues:
{
Description: List of Provisioning Issues if any ,
Required: False ,
}
[
{
name:
{
Description: Name of the issue ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Provisioning Issue ,
Required: False ,
}
{
issueType:
{
Description: Type of Issue ,
Required: False ,
}
string ,
severity:
{
Description: Provisioning state of Network Security Perimeter configuration propagation ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the issue ,
Required: False ,
}
string ,
suggestedResourceIds:
{
Description: ARM IDs of resources that can be associated to the same perimeter to remediate the issue. ,
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Description: Access rules that can be added to the same profile to remediate the issue. ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: Information about Network Security Perimeter ,
Required: False ,
}
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: Information about resource association ,
Required: False ,
}
{
name:
{
Description: Name of the resource association ,
Required: False ,
}
string ,
accessMode:
{
Description: Access Mode of the resource association ,
Enum:
{
Enforced: No description available. ,
Learning: No description available. ,
Audit: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Information about profile ,
Required: False ,
}
{
name:
{
Description: Name of the profile ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Current access rules version ,
Format: int64 ,
Required: False ,
}
integer ,
accessRules:
{
Description: List of Access Rules ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion:
{
Description: Current diagnostic settings version ,
Format: int64 ,
Required: False ,
}
integer ,
enabledLogCategories:
{
Description: List of log categories ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: Gets or sets the SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The sku name ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets the sku tier. This is based on the SKU name. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Required. Gets or sets the Kind of the resource. ,
Enum:
{
sdk: No description available. ,
designer: No description available. ,
bot: No description available. ,
function: No description available. ,
azurebot: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: Entity Tag. ,
Required: False ,
}
string ,
zones:
{
Description: Entity zones ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Bots_ListByResourceGroup (updated)
Description :  Returns all the resources of a particular type belonging to a resource group
Reference :  Link ¶

⚶ Changes

{
  "#id": "Bots_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@added_1037b37f8dfe4e6b991cf05e82686b83": {
              "#name": "location",
              "Description": "Specifies the location of the resource.",
              "Required": false,
              "Type": "string"
            },
            "@added_245a77c30a744bf798f93da8c5315e5b": {
              "#name": "tags",
              "Description": "Contains resource tags defined as key/value pairs.",
              "Required": false,
              "Type": "object"
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Bot items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
networkSecurityPerimeterConfigurations:
{
Description: List of Network Security Perimeter configurations for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Network Security Perimeter configuration ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningIssues:
{
Description: List of Provisioning Issues if any ,
Required: False ,
}
[
{
name:
{
Description: Name of the issue ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Provisioning Issue ,
Required: False ,
}
{
issueType:
{
Description: Type of Issue ,
Required: False ,
}
string ,
severity:
{
Description: Provisioning state of Network Security Perimeter configuration propagation ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the issue ,
Required: False ,
}
string ,
suggestedResourceIds:
{
Description: ARM IDs of resources that can be associated to the same perimeter to remediate the issue. ,
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Description: Access rules that can be added to the same profile to remediate the issue. ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: Information about Network Security Perimeter ,
Required: False ,
}
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: Information about resource association ,
Required: False ,
}
{
name:
{
Description: Name of the resource association ,
Required: False ,
}
string ,
accessMode:
{
Description: Access Mode of the resource association ,
Enum:
{
Enforced: No description available. ,
Learning: No description available. ,
Audit: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Information about profile ,
Required: False ,
}
{
name:
{
Description: Name of the profile ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Current access rules version ,
Format: int64 ,
Required: False ,
}
integer ,
accessRules:
{
Description: List of Access Rules ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion:
{
Description: Current diagnostic settings version ,
Format: int64 ,
Required: False ,
}
integer ,
enabledLogCategories:
{
Description: List of log categories ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: Gets or sets the SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The sku name ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets the sku tier. This is based on the SKU name. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Required. Gets or sets the Kind of the resource. ,
Enum:
{
sdk: No description available. ,
designer: No description available. ,
bot: No description available. ,
function: No description available. ,
azurebot: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: Entity Tag. ,
Required: False ,
}
string ,
zones:
{
Description: Entity zones ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Bots_Get (updated)
Description :  Returns a BotService specified by the parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Bots_Get",
  "$responses": {
    "200": {
      "$properties": {
        "@added_f88c0ae1dddd4ee9a5c1edb96854487b": {
          "#name": "location",
          "Description": "Specifies the location of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_09e9e21093444b028d48ed7000de223c": {
          "#name": "tags",
          "Description": "Contains resource tags defined as key/value pairs.",
          "Required": false,
          "Type": "object"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
networkSecurityPerimeterConfigurations:
{
Description: List of Network Security Perimeter configurations for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Network Security Perimeter configuration ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningIssues:
{
Description: List of Provisioning Issues if any ,
Required: False ,
}
[
{
name:
{
Description: Name of the issue ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Provisioning Issue ,
Required: False ,
}
{
issueType:
{
Description: Type of Issue ,
Required: False ,
}
string ,
severity:
{
Description: Provisioning state of Network Security Perimeter configuration propagation ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the issue ,
Required: False ,
}
string ,
suggestedResourceIds:
{
Description: ARM IDs of resources that can be associated to the same perimeter to remediate the issue. ,
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Description: Access rules that can be added to the same profile to remediate the issue. ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: Information about Network Security Perimeter ,
Required: False ,
}
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: Information about resource association ,
Required: False ,
}
{
name:
{
Description: Name of the resource association ,
Required: False ,
}
string ,
accessMode:
{
Description: Access Mode of the resource association ,
Enum:
{
Enforced: No description available. ,
Learning: No description available. ,
Audit: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Information about profile ,
Required: False ,
}
{
name:
{
Description: Name of the profile ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Current access rules version ,
Format: int64 ,
Required: False ,
}
integer ,
accessRules:
{
Description: List of Access Rules ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion:
{
Description: Current diagnostic settings version ,
Format: int64 ,
Required: False ,
}
integer ,
enabledLogCategories:
{
Description: List of log categories ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: Gets or sets the SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The sku name ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets the sku tier. This is based on the SKU name. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Required. Gets or sets the Kind of the resource. ,
Enum:
{
sdk: No description available. ,
designer: No description available. ,
bot: No description available. ,
function: No description available. ,
azurebot: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: Entity Tag. ,
Required: False ,
}
string ,
zones:
{
Description: Entity zones ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Bots_Create (updated)
Description :  Creates a Bot Service. Bot Service is a resource group wide resource type.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Bots_Create",
  "$parameters": {
    "parameters": {
      "$properties": {
        "@added_03e4e1bf9622457aa5d3a79746be3fa5": {
          "#name": "location",
          "Description": "Specifies the location of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_e889ded8b3fb4d9f8d9e8faffe2b958b": {
          "#name": "tags",
          "Description": "Contains resource tags defined as key/value pairs.",
          "Required": false,
          "Type": "object"
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "@added_e62f672ab57f4552b72597317d5a101e": {
          "#name": "location",
          "Description": "Specifies the location of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_cbb25bf1e7714fd9b1b54529c7ce0b8e": {
          "#name": "tags",
          "Description": "Contains resource tags defined as key/value pairs.",
          "Required": false,
          "Type": "object"
        }
      }
    },
    "201": {
      "$properties": {
        "@added_2c572659d18d4418aa4a3ebddbaac564": {
          "#name": "location",
          "Description": "Specifies the location of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_d8491b1b833e4f3f95be83ff6a50e751": {
          "#name": "tags",
          "Description": "Contains resource tags defined as key/value pairs.",
          "Required": false,
          "Type": "object"
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the created bot. ,
Required: True ,
}
{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
networkSecurityPerimeterConfigurations:
{
Description: List of Network Security Perimeter configurations for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Network Security Perimeter configuration ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningIssues:
{
Description: List of Provisioning Issues if any ,
Required: False ,
}
[
{
name:
{
Description: Name of the issue ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Provisioning Issue ,
Required: False ,
}
{
issueType:
{
Description: Type of Issue ,
Required: False ,
}
string ,
severity:
{
Description: Provisioning state of Network Security Perimeter configuration propagation ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the issue ,
Required: False ,
}
string ,
suggestedResourceIds:
{
Description: ARM IDs of resources that can be associated to the same perimeter to remediate the issue. ,
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Description: Access rules that can be added to the same profile to remediate the issue. ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: Information about Network Security Perimeter ,
Required: False ,
}
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: Information about resource association ,
Required: False ,
}
{
name:
{
Description: Name of the resource association ,
Required: False ,
}
string ,
accessMode:
{
Description: Access Mode of the resource association ,
Enum:
{
Enforced: No description available. ,
Learning: No description available. ,
Audit: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Information about profile ,
Required: False ,
}
{
name:
{
Description: Name of the profile ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Current access rules version ,
Format: int64 ,
Required: False ,
}
integer ,
accessRules:
{
Description: List of Access Rules ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion:
{
Description: Current diagnostic settings version ,
Format: int64 ,
Required: False ,
}
integer ,
enabledLogCategories:
{
Description: List of log categories ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: Gets or sets the SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The sku name ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets the sku tier. This is based on the SKU name. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Required. Gets or sets the Kind of the resource. ,
Enum:
{
sdk: No description available. ,
designer: No description available. ,
bot: No description available. ,
function: No description available. ,
azurebot: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: Entity Tag. ,
Required: False ,
}
string ,
zones:
{
Description: Entity zones ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
networkSecurityPerimeterConfigurations:
{
Description: List of Network Security Perimeter configurations for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Network Security Perimeter configuration ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningIssues:
{
Description: List of Provisioning Issues if any ,
Required: False ,
}
[
{
name:
{
Description: Name of the issue ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Provisioning Issue ,
Required: False ,
}
{
issueType:
{
Description: Type of Issue ,
Required: False ,
}
string ,
severity:
{
Description: Provisioning state of Network Security Perimeter configuration propagation ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the issue ,
Required: False ,
}
string ,
suggestedResourceIds:
{
Description: ARM IDs of resources that can be associated to the same perimeter to remediate the issue. ,
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Description: Access rules that can be added to the same profile to remediate the issue. ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: Information about Network Security Perimeter ,
Required: False ,
}
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: Information about resource association ,
Required: False ,
}
{
name:
{
Description: Name of the resource association ,
Required: False ,
}
string ,
accessMode:
{
Description: Access Mode of the resource association ,
Enum:
{
Enforced: No description available. ,
Learning: No description available. ,
Audit: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Information about profile ,
Required: False ,
}
{
name:
{
Description: Name of the profile ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Current access rules version ,
Format: int64 ,
Required: False ,
}
integer ,
accessRules:
{
Description: List of Access Rules ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion:
{
Description: Current diagnostic settings version ,
Format: int64 ,
Required: False ,
}
integer ,
enabledLogCategories:
{
Description: List of log categories ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: Gets or sets the SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The sku name ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets the sku tier. This is based on the SKU name. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Required. Gets or sets the Kind of the resource. ,
Enum:
{
sdk: No description available. ,
designer: No description available. ,
bot: No description available. ,
function: No description available. ,
azurebot: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: Entity Tag. ,
Required: False ,
}
string ,
zones:
{
Description: Entity zones ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
networkSecurityPerimeterConfigurations:
{
Description: List of Network Security Perimeter configurations for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Network Security Perimeter configuration ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningIssues:
{
Description: List of Provisioning Issues if any ,
Required: False ,
}
[
{
name:
{
Description: Name of the issue ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Provisioning Issue ,
Required: False ,
}
{
issueType:
{
Description: Type of Issue ,
Required: False ,
}
string ,
severity:
{
Description: Provisioning state of Network Security Perimeter configuration propagation ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the issue ,
Required: False ,
}
string ,
suggestedResourceIds:
{
Description: ARM IDs of resources that can be associated to the same perimeter to remediate the issue. ,
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Description: Access rules that can be added to the same profile to remediate the issue. ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: Information about Network Security Perimeter ,
Required: False ,
}
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: Information about resource association ,
Required: False ,
}
{
name:
{
Description: Name of the resource association ,
Required: False ,
}
string ,
accessMode:
{
Description: Access Mode of the resource association ,
Enum:
{
Enforced: No description available. ,
Learning: No description available. ,
Audit: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Information about profile ,
Required: False ,
}
{
name:
{
Description: Name of the profile ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Current access rules version ,
Format: int64 ,
Required: False ,
}
integer ,
accessRules:
{
Description: List of Access Rules ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion:
{
Description: Current diagnostic settings version ,
Format: int64 ,
Required: False ,
}
integer ,
enabledLogCategories:
{
Description: List of log categories ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: Gets or sets the SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The sku name ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets the sku tier. This is based on the SKU name. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Required. Gets or sets the Kind of the resource. ,
Enum:
{
sdk: No description available. ,
designer: No description available. ,
bot: No description available. ,
function: No description available. ,
azurebot: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: Entity Tag. ,
Required: False ,
}
string ,
zones:
{
Description: Entity zones ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Bots_Update (updated)
Description :  Updates a Bot Service
Reference :  Link ¶

⚶ Changes

{
  "#id": "Bots_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "@added_06e00ef095054f399fcee6a4e77637b9": {
          "#name": "location",
          "Description": "Specifies the location of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_bde1657bf14940a8af636f73f8f3a563": {
          "#name": "tags",
          "Description": "Contains resource tags defined as key/value pairs.",
          "Required": false,
          "Type": "object"
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "@added_20066b58907548a79ef3ac8e6237daba": {
          "#name": "location",
          "Description": "Specifies the location of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_a41b864ac2cd4ec5897845dc0386cdc1": {
          "#name": "tags",
          "Description": "Contains resource tags defined as key/value pairs.",
          "Required": false,
          "Type": "object"
        }
      }
    },
    "201": {
      "$properties": {
        "@added_b7df8d188598477f878737045e24fde7": {
          "#name": "location",
          "Description": "Specifies the location of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_43bcbe58b5f348ee8ed6697e4c9cf46d": {
          "#name": "tags",
          "Description": "Contains resource tags defined as key/value pairs.",
          "Required": false,
          "Type": "object"
        }
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the created bot. ,
Required: True ,
}
{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
networkSecurityPerimeterConfigurations:
{
Description: List of Network Security Perimeter configurations for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Network Security Perimeter configuration ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningIssues:
{
Description: List of Provisioning Issues if any ,
Required: False ,
}
[
{
name:
{
Description: Name of the issue ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Provisioning Issue ,
Required: False ,
}
{
issueType:
{
Description: Type of Issue ,
Required: False ,
}
string ,
severity:
{
Description: Provisioning state of Network Security Perimeter configuration propagation ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the issue ,
Required: False ,
}
string ,
suggestedResourceIds:
{
Description: ARM IDs of resources that can be associated to the same perimeter to remediate the issue. ,
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Description: Access rules that can be added to the same profile to remediate the issue. ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: Information about Network Security Perimeter ,
Required: False ,
}
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: Information about resource association ,
Required: False ,
}
{
name:
{
Description: Name of the resource association ,
Required: False ,
}
string ,
accessMode:
{
Description: Access Mode of the resource association ,
Enum:
{
Enforced: No description available. ,
Learning: No description available. ,
Audit: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Information about profile ,
Required: False ,
}
{
name:
{
Description: Name of the profile ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Current access rules version ,
Format: int64 ,
Required: False ,
}
integer ,
accessRules:
{
Description: List of Access Rules ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion:
{
Description: Current diagnostic settings version ,
Format: int64 ,
Required: False ,
}
integer ,
enabledLogCategories:
{
Description: List of log categories ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: Gets or sets the SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The sku name ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets the sku tier. This is based on the SKU name. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Required. Gets or sets the Kind of the resource. ,
Enum:
{
sdk: No description available. ,
designer: No description available. ,
bot: No description available. ,
function: No description available. ,
azurebot: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: Entity Tag. ,
Required: False ,
}
string ,
zones:
{
Description: Entity zones ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
networkSecurityPerimeterConfigurations:
{
Description: List of Network Security Perimeter configurations for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Network Security Perimeter configuration ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningIssues:
{
Description: List of Provisioning Issues if any ,
Required: False ,
}
[
{
name:
{
Description: Name of the issue ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Provisioning Issue ,
Required: False ,
}
{
issueType:
{
Description: Type of Issue ,
Required: False ,
}
string ,
severity:
{
Description: Provisioning state of Network Security Perimeter configuration propagation ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the issue ,
Required: False ,
}
string ,
suggestedResourceIds:
{
Description: ARM IDs of resources that can be associated to the same perimeter to remediate the issue. ,
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Description: Access rules that can be added to the same profile to remediate the issue. ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: Information about Network Security Perimeter ,
Required: False ,
}
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: Information about resource association ,
Required: False ,
}
{
name:
{
Description: Name of the resource association ,
Required: False ,
}
string ,
accessMode:
{
Description: Access Mode of the resource association ,
Enum:
{
Enforced: No description available. ,
Learning: No description available. ,
Audit: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Information about profile ,
Required: False ,
}
{
name:
{
Description: Name of the profile ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Current access rules version ,
Format: int64 ,
Required: False ,
}
integer ,
accessRules:
{
Description: List of Access Rules ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion:
{
Description: Current diagnostic settings version ,
Format: int64 ,
Required: False ,
}
integer ,
enabledLogCategories:
{
Description: List of log categories ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: Gets or sets the SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The sku name ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets the sku tier. This is based on the SKU name. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Required. Gets or sets the Kind of the resource. ,
Enum:
{
sdk: No description available. ,
designer: No description available. ,
bot: No description available. ,
function: No description available. ,
azurebot: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: Entity Tag. ,
Required: False ,
}
string ,
zones:
{
Description: Entity zones ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
networkSecurityPerimeterConfigurations:
{
Description: List of Network Security Perimeter configurations for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Network Security Perimeter configuration ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningIssues:
{
Description: List of Provisioning Issues if any ,
Required: False ,
}
[
{
name:
{
Description: Name of the issue ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Provisioning Issue ,
Required: False ,
}
{
issueType:
{
Description: Type of Issue ,
Required: False ,
}
string ,
severity:
{
Description: Provisioning state of Network Security Perimeter configuration propagation ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the issue ,
Required: False ,
}
string ,
suggestedResourceIds:
{
Description: ARM IDs of resources that can be associated to the same perimeter to remediate the issue. ,
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Description: Access rules that can be added to the same profile to remediate the issue. ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: Information about Network Security Perimeter ,
Required: False ,
}
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: Information about resource association ,
Required: False ,
}
{
name:
{
Description: Name of the resource association ,
Required: False ,
}
string ,
accessMode:
{
Description: Access Mode of the resource association ,
Enum:
{
Enforced: No description available. ,
Learning: No description available. ,
Audit: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Information about profile ,
Required: False ,
}
{
name:
{
Description: Name of the profile ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Current access rules version ,
Format: int64 ,
Required: False ,
}
integer ,
accessRules:
{
Description: List of Access Rules ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Location of the Network Security Perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion:
{
Description: Current diagnostic settings version ,
Format: int64 ,
Required: False ,
}
integer ,
enabledLogCategories:
{
Description: List of log categories ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: Gets or sets the SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The sku name ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets the sku tier. This is based on the SKU name. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Required. Gets or sets the Kind of the resource. ,
Enum:
{
sdk: No description available. ,
designer: No description available. ,
bot: No description available. ,
function: No description available. ,
azurebot: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: Entity Tag. ,
Required: False ,
}
string ,
zones:
{
Description: Entity zones ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Channels_ListByResourceGroup (updated)
Description :  Returns all the Channel registrations of a particular BotService resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "Channels_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@added_52ef109bd9604b38a4e902da0a0438e8": {
              "#name": "location",
              "Description": "Specifies the location of the resource.",
              "Required": false,
              "Type": "string"
            },
            "@added_1727c73b042942afa12c6d2c20e2fa3d": {
              "#name": "tags",
              "Description": "Contains resource tags defined as key/value pairs.",
              "Required": false,
              "Type": "object"
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The BotChannel items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: Gets or sets the SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The sku name ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets the sku tier. This is based on the SKU name. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Required. Gets or sets the Kind of the resource. ,
Enum:
{
sdk: No description available. ,
designer: No description available. ,
bot: No description available. ,
function: No description available. ,
azurebot: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: Entity Tag. ,
Required: False ,
}
string ,
zones:
{
Description: Entity zones ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Channels_Get (updated)
Description :  Returns a BotService Channel registration specified by the parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Channels_Get",
  "$responses": {
    "200": {
      "$properties": {
        "@added_ecccbbd0b0d84b038c341d9f246cc89b": {
          "#name": "location",
          "Description": "Specifies the location of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_4ac793b1d2ef426a9d178d37facd7972": {
          "#name": "tags",
          "Description": "Contains resource tags defined as key/value pairs.",
          "Required": false,
          "Type": "object"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
channelName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: Gets or sets the SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The sku name ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets the sku tier. This is based on the SKU name. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Required. Gets or sets the Kind of the resource. ,
Enum:
{
sdk: No description available. ,
designer: No description available. ,
bot: No description available. ,
function: No description available. ,
azurebot: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: Entity Tag. ,
Required: False ,
}
string ,
zones:
{
Description: Entity zones ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Channels_Create (updated)
Description :  Creates a Channel registration for a Bot Service
Reference :  Link ¶

⚶ Changes

{
  "#id": "Channels_Create",
  "$parameters": {
    "parameters": {
      "$properties": {
        "@added_eceef10e25064d5786c5b8afded9f65c": {
          "#name": "location",
          "Description": "Specifies the location of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_5a6400222b434893acd357b57bb61aca": {
          "#name": "tags",
          "Description": "Contains resource tags defined as key/value pairs.",
          "Required": false,
          "Type": "object"
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "@added_b635004b18124db89395cc4763426b88": {
          "#name": "location",
          "Description": "Specifies the location of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_8252e138a0a54284ae608eb45edd04c5": {
          "#name": "tags",
          "Description": "Contains resource tags defined as key/value pairs.",
          "Required": false,
          "Type": "object"
        }
      }
    },
    "201": {
      "$properties": {
        "@added_370b358ec31c4d2ca514c00a4396a5c5": {
          "#name": "location",
          "Description": "Specifies the location of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_817dbf076ee14f2dab441df1c8336c01": {
          "#name": "tags",
          "Description": "Contains resource tags defined as key/value pairs.",
          "Required": false,
          "Type": "object"
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
channelName:
{
Description: The name of the Channel resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: Gets or sets the SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The sku name ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets the sku tier. This is based on the SKU name. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Required. Gets or sets the Kind of the resource. ,
Enum:
{
sdk: No description available. ,
designer: No description available. ,
bot: No description available. ,
function: No description available. ,
azurebot: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: Entity Tag. ,
Required: False ,
}
string ,
zones:
{
Description: Entity zones ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: Gets or sets the SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The sku name ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets the sku tier. This is based on the SKU name. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Required. Gets or sets the Kind of the resource. ,
Enum:
{
sdk: No description available. ,
designer: No description available. ,
bot: No description available. ,
function: No description available. ,
azurebot: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: Entity Tag. ,
Required: False ,
}
string ,
zones:
{
Description: Entity zones ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: Gets or sets the SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The sku name ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets the sku tier. This is based on the SKU name. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Required. Gets or sets the Kind of the resource. ,
Enum:
{
sdk: No description available. ,
designer: No description available. ,
bot: No description available. ,
function: No description available. ,
azurebot: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: Entity Tag. ,
Required: False ,
}
string ,
zones:
{
Description: Entity zones ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Channels_Update (updated)
Description :  Updates a Channel registration for a Bot Service
Reference :  Link ¶

⚶ Changes

{
  "#id": "Channels_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "@added_54fc883151b848d2a528c04a386fd4df": {
          "#name": "location",
          "Description": "Specifies the location of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_2b2e2a18310946fc988649b657abf9ba": {
          "#name": "tags",
          "Description": "Contains resource tags defined as key/value pairs.",
          "Required": false,
          "Type": "object"
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "@added_4ad3a621c4084ac28bc0c9c9a2344d54": {
          "#name": "location",
          "Description": "Specifies the location of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_3e7d57995e9b4e3da6a594b5eecda1e0": {
          "#name": "tags",
          "Description": "Contains resource tags defined as key/value pairs.",
          "Required": false,
          "Type": "object"
        }
      }
    },
    "201": {
      "$properties": {
        "@added_09245cb82d4f4d8fb3a868fb03e7df68": {
          "#name": "location",
          "Description": "Specifies the location of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_0cab93461c284ce1b8c4d09e52beddda": {
          "#name": "tags",
          "Description": "Contains resource tags defined as key/value pairs.",
          "Required": false,
          "Type": "object"
        }
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
channelName:
{
Description: The name of the Channel resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the created bot. ,
Required: True ,
}
{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: Gets or sets the SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The sku name ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets the sku tier. This is based on the SKU name. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Required. Gets or sets the Kind of the resource. ,
Enum:
{
sdk: No description available. ,
designer: No description available. ,
bot: No description available. ,
function: No description available. ,
azurebot: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: Entity Tag. ,
Required: False ,
}
string ,
zones:
{
Description: Entity zones ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: Gets or sets the SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The sku name ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets the sku tier. This is based on the SKU name. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Required. Gets or sets the Kind of the resource. ,
Enum:
{
sdk: No description available. ,
designer: No description available. ,
bot: No description available. ,
function: No description available. ,
azurebot: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: Entity Tag. ,
Required: False ,
}
string ,
zones:
{
Description: Entity zones ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: Gets or sets the SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The sku name ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets the sku tier. This is based on the SKU name. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Required. Gets or sets the Kind of the resource. ,
Enum:
{
sdk: No description available. ,
designer: No description available. ,
bot: No description available. ,
function: No description available. ,
azurebot: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: Entity Tag. ,
Required: False ,
}
string ,
zones:
{
Description: Entity zones ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
DirectLine_RegenerateKeys (updated)
Description :  Regenerates secret keys and returns them for the DirectLine Channel of a particular BotService resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "DirectLine_RegenerateKeys",
  "$responses": {
    "200": {
      "$properties": {
        "@added_b6b2c09b6b1e464d84b2f55a9eed2f72": {
          "#name": "location",
          "Description": "Specifies the location of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_ac20151de3334f79a95e65d4d2bc119e": {
          "#name": "tags",
          "Description": "Contains resource tags defined as key/value pairs.",
          "Required": false,
          "Type": "object"
        }
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}/regeneratekeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
channelName:
{
Description: The name of the Channel resource for which keys are to be regenerated. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the created bot. ,
Required: True ,
}
{
siteName:
{
Description: The site name ,
Required: True ,
}
string ,
key:
{
Description: Determines which key is to be regenerated ,
Enum:
{
key1: No description available. ,
key2: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: Gets or sets the SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The sku name ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets the sku tier. This is based on the SKU name. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Required. Gets or sets the Kind of the resource. ,
Enum:
{
sdk: No description available. ,
designer: No description available. ,
bot: No description available. ,
function: No description available. ,
azurebot: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: Entity Tag. ,
Required: False ,
}
string ,
zones:
{
Description: Entity zones ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}