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

2025/07/07 • 34 updated methods

Bots_GetCheckNameAvailability (updated)
Description :  Check whether a bot name is available.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Bots_GetCheckNameAvailability",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "parameters",
      "Description": {
        "new": "The request body",
        "old": "The request body parameters to provide for the check name availability request"
      }
    }
  ]
}

⚼ Request

POST:  /providers/Microsoft.BotService/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The request body ,
Required: True ,
}
{
name:
{
Description: the name of the bot for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: the type of the bot for which availability needs to be checked ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
valid:
{
Description: indicates if the bot name is valid. ,
Required: False ,
}
boolean ,
message:
{
Description: additional message from the bot management api showing why a bot name is not available ,
Required: False ,
}
string ,
absCode:
{
Description: response code from ABS ,
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 ,
}
,
}
Operations_List (updated)
Description :  List the operations for the provider
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "Description": {
    "new": "List the operations for the provider",
    "old": "Lists all the available BotService operations."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": [
              {
                "#name": "properties",
                "Type": {
                  "new": "string",
                  "old": "object"
                }
              }
            ]
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.BotService/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of operations. ,
Required: True ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The operation supported by Bot Service Management. ,
Required: False ,
}
{
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
operation:
{
Description: The action that users can perform, based on their permission level. ,
Required: False ,
}
string ,
provider:
{
Description: Service provider: Microsoft Bot Service. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The origin of the operation. ,
Required: False ,
}
string ,
properties:
{
Description: Additional properties. ,
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_List (updated)
Description :  Returns all the resources of a particular type belonging to a subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Bots_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Bot items on this page",
            "old": "Gets the list of bot service results and their properties."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "networkSecurityPerimeterConfigurations": {
                    "$properties": {
                      "properties": [
                        {
                          "provisioningIssues": {
                            "$properties": {
                              "properties": [
                                {
                                  "suggestedResourceIds": {
                                    "Description": {
                                      "new": "A type definition that refers the id to an Azure Resource Manager resource.",
                                      "old": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
                                    }
                                  }
                                }
                              ]
                            }
                          }
                        }
                      ],
                      "@removed_c3bef5bb0fe74dfdaa874d78a9fc86b2": {
                        "#name": "id",
                        "Description": "Fully qualified identifier of the resource",
                        "Required": false,
                        "Type": "string"
                      },
                      "@removed_37e09e0fe4004773a6102172208d3c9d": {
                        "#name": "name",
                        "Description": "Name of the resource",
                        "Required": false,
                        "Type": "string"
                      },
                      "@removed_d77f4775746c401db11bdd26295ad2e1": {
                        "#name": "type",
                        "Description": "Type of the resource",
                        "Required": false,
                        "Type": "string"
                      }
                    }
                  }
                }
              ],
              "@added_4749411520024b00a549ceb8ed4a9edf": {
                "#name": "sku",
                "Description": "Gets or sets the SKU of the resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "The sku name",
                    "Enum": [
                      [
                        "F0",
                        ""
                      ],
                      [
                        "S1",
                        ""
                      ]
                    ],
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "tier",
                    "Description": "Gets the sku tier. This is based on the SKU name.",
                    "Enum": [
                      [
                        "Free",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              "@added_a9d9298389f04dac8616fc67fdf975d3": {
                "#name": "kind",
                "Description": "Required. Gets or sets the Kind of the resource.",
                "Enum": [
                  [
                    "sdk",
                    ""
                  ],
                  [
                    "designer",
                    ""
                  ],
                  [
                    "bot",
                    ""
                  ],
                  [
                    "function",
                    ""
                  ],
                  [
                    "azurebot",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              "@added_ad65485032bb4c9180dc445c94310a21": {
                "#name": "etag",
                "Description": "Entity Tag.",
                "Required": false,
                "Type": "string"
              },
              "@added_583ba418f7e74b57b32c5724ac73729a": {
                "#name": "zones",
                "Description": "Entity zones",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link used to get the next page of bot service resources."
          }
        }
      ]
    }
  }
}

⚼ 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 ,
}
,
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 ,
}
,
}
HostSettings_Get (updated)
Description :  Get per subscription settings needed to host bot in compute resource such as Azure App Service
Reference :  Link ¶

⚶ Changes

{
  "#id": "HostSettings_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.BotService/hostSettings
{
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)

{
OAuthUrl:
{
Description: For in-conversation bot user authentication ,
Required: False ,
}
string ,
ToBotFromChannelOpenIdMetadataUrl:
{
Description: For verifying incoming tokens from the channels ,
Required: False ,
}
string ,
ToBotFromChannelTokenIssuer:
{
Description: For verifying incoming tokens from the channels ,
Required: False ,
}
string ,
ToBotFromEmulatorOpenIdMetadataUrl:
{
Description: For verifying incoming tokens from bot emulator ,
Required: False ,
}
string ,
ToChannelFromBotLoginUrl:
{
Description: For getting access token to channels from bot host ,
Required: False ,
}
string ,
ToChannelFromBotOAuthScope:
{
Description: For getting access token to channels from bot host ,
Required: False ,
}
string ,
ValidateAuthority:
{
Description: Per cloud OAuth setting on whether authority is validated ,
Required: False ,
}
boolean ,
BotOpenIdMetadata:
{
Description: Same as toBotFromChannelOpenIdMetadataUrl, used by SDK < v4.12 ,
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 ,
}
,
}
BotConnection_ListServiceProviders (updated)
Description :  Lists the available Service Providers for creating Connection Settings
Reference :  Link ¶

⚶ Changes

{
  "#id": "BotConnection_ListServiceProviders",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.BotService/listAuthServiceProviders
{
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)

{
nextLink:
{
Description: The link used to get the next page of bot service providers. ,
Required: False ,
}
string ,
value:
{
Description: Gets the list of bot service providers and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The Properties of a Service Provider Object ,
Required: False ,
}
{
id:
{
Description: Id for Service Provider ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name of the Service Provider ,
Required: False ,
}
string ,
serviceProviderName:
{
Description: Name of the Service Provider ,
Required: False ,
}
string ,
devPortalUrl:
{
Description: URL of Dev Portal ,
Required: False ,
}
string ,
iconUrl:
{
Description: The URL of icon ,
Required: False ,
}
string ,
parameters:
{
Description: The list of parameters for the Service Provider ,
Required: False ,
}
[
{
name:
{
Description: Name of the Service Provider ,
Required: False ,
}
string ,
type:
{
Description: Type of the Service Provider ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name of the Service Provider ,
Required: False ,
}
string ,
description:
{
Description: Description of the Service Provider ,
Required: False ,
}
string ,
helpUrl:
{
Description: Help Url for the Service Provider ,
Required: False ,
}
string ,
default:
{
Description: Default Name for the Service Provider ,
Required: False ,
}
string ,
metadata:
{
Description: Meta data for the Service Provider ,
Required: False ,
}
{
constraints:
{
Description: the constraints of the bot meta data. ,
Required: False ,
}
{
required:
{
Description: Whether required the constraints of the bot meta data. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
QnAMakerEndpointKeys_Get (updated)
Description :  Lists the QnA Maker endpoint keys
Reference :  Link ¶

⚶ Changes

{
  "#id": "QnAMakerEndpointKeys_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "parameters",
      "Description": {
        "new": "The request body",
        "old": "The request body parameters to provide for the check name availability request"
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.BotService/listQnAMakerEndpointKeys
{
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 ,
parameters:
{
Description: The request body ,
Required: True ,
}
{
hostname:
{
Description: the host name of the QnA Maker endpoint ,
Required: False ,
}
string ,
authkey:
{
Description: Subscription key which provides access to this API. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
primaryEndpointKey:
{
Description: Primary Access Key. ,
Required: False ,
}
string ,
secondaryEndpointKey:
{
Description: Secondary Access Key. ,
Required: False ,
}
string ,
installedVersion:
{
Description: Current version of runtime. ,
Required: False ,
}
string ,
lastStableVersion:
{
Description: Latest version of runtime. ,
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 ,
}
,
}
OperationResults_Get (updated)
Description :  Get the operation result for a long running operation.
Reference :  Link ¶

⚶ Changes

{
  "#id": "OperationResults_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.BotService/operationresults/{operationResultId}
{
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 ,
operationResultId:
{
Description: The ID of the operation result to get. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the operation returned. ,
Required: False ,
}
string ,
name:
{
Description: The name of the operation result. ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation being performed. ,
Enum:
{
Canceled: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Requested: No description available. ,
Running: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The time that the operation was started. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Bot items on this page",
            "old": "Gets the list of bot service results and their properties."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "networkSecurityPerimeterConfigurations": {
                    "$properties": {
                      "properties": [
                        {
                          "provisioningIssues": {
                            "$properties": {
                              "properties": [
                                {
                                  "suggestedResourceIds": {
                                    "Description": {
                                      "new": "A type definition that refers the id to an Azure Resource Manager resource.",
                                      "old": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
                                    }
                                  }
                                }
                              ]
                            }
                          }
                        }
                      ],
                      "@removed_fe0ad346fe754229bc33f57c70efaa3c": {
                        "#name": "id",
                        "Description": "Fully qualified identifier of the resource",
                        "Required": false,
                        "Type": "string"
                      },
                      "@removed_58cd1168a5fd4985bc8630733e73cbb2": {
                        "#name": "name",
                        "Description": "Name of the resource",
                        "Required": false,
                        "Type": "string"
                      },
                      "@removed_55beaaadb15e4d69b5f9e9aaea134785": {
                        "#name": "type",
                        "Description": "Type of the resource",
                        "Required": false,
                        "Type": "string"
                      }
                    }
                  }
                }
              ],
              "@added_371e5665d1f04ceba39736257ef47b6f": {
                "#name": "sku",
                "Description": "Gets or sets the SKU of the resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "The sku name",
                    "Enum": [
                      [
                        "F0",
                        ""
                      ],
                      [
                        "S1",
                        ""
                      ]
                    ],
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "tier",
                    "Description": "Gets the sku tier. This is based on the SKU name.",
                    "Enum": [
                      [
                        "Free",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              "@added_30145a82d9c943cc93f8e0e7a342a92a": {
                "#name": "kind",
                "Description": "Required. Gets or sets the Kind of the resource.",
                "Enum": [
                  [
                    "sdk",
                    ""
                  ],
                  [
                    "designer",
                    ""
                  ],
                  [
                    "bot",
                    ""
                  ],
                  [
                    "function",
                    ""
                  ],
                  [
                    "azurebot",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              "@added_c293b3793c9b4148bf9a7e6d58263584": {
                "#name": "etag",
                "Description": "Entity Tag.",
                "Required": false,
                "Type": "string"
              },
              "@added_e4d54b5b74494b04980423b80f86e9fe": {
                "#name": "zones",
                "Description": "Entity zones",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link used to get the next page of bot service resources."
          }
        }
      ]
    }
  }
}

⚼ 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 ,
}
,
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",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "networkSecurityPerimeterConfigurations": {
              "$properties": {
                "properties": [
                  {
                    "provisioningIssues": {
                      "$properties": {
                        "properties": [
                          {
                            "suggestedResourceIds": {
                              "Description": {
                                "new": "A type definition that refers the id to an Azure Resource Manager resource.",
                                "old": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                ],
                "@removed_f63341fb35d741f5b4c4c9400f28726f": {
                  "#name": "id",
                  "Description": "Fully qualified identifier of the resource",
                  "Required": false,
                  "Type": "string"
                },
                "@removed_4879b50a1fd149ec9710a5912671e5a2": {
                  "#name": "name",
                  "Description": "Name of the resource",
                  "Required": false,
                  "Type": "string"
                },
                "@removed_56adca1309a7494c92aa72107cd719d8": {
                  "#name": "type",
                  "Description": "Type of the resource",
                  "Required": false,
                  "Type": "string"
                }
              }
            }
          }
        ],
        "@added_c9b7da2d8f08454b92b2623b881654e5": {
          "#name": "sku",
          "Description": "Gets or sets the SKU of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The sku name",
              "Enum": [
                [
                  "F0",
                  ""
                ],
                [
                  "S1",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "Gets the sku tier. This is based on the SKU name.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Standard",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_0a4421aba17547748241febd7973c0d0": {
          "#name": "kind",
          "Description": "Required. Gets or sets the Kind of the resource.",
          "Enum": [
            [
              "sdk",
              ""
            ],
            [
              "designer",
              ""
            ],
            [
              "bot",
              ""
            ],
            [
              "function",
              ""
            ],
            [
              "azurebot",
              ""
            ]
          ],
          "Required": false,
          "Type": "string"
        },
        "@added_13b23a1578ef4901a4306f2bf1ccea36": {
          "#name": "etag",
          "Description": "Entity Tag.",
          "Required": false,
          "Type": "string"
        },
        "@added_038c6723ba714d9b963896fae2255541": {
          "#name": "zones",
          "Description": "Entity zones",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        }
      }
    }
  }
}

⚼ 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 ,
}
,
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": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    },
    {
      "parameters": {
        "$properties": {
          "properties": [
            {
              "networkSecurityPerimeterConfigurations": {
                "$properties": {
                  "properties": [
                    {
                      "provisioningIssues": {
                        "$properties": {
                          "properties": [
                            {
                              "suggestedResourceIds": {
                                "Description": {
                                  "new": "A type definition that refers the id to an Azure Resource Manager resource.",
                                  "old": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
                                }
                              }
                            }
                          ]
                        }
                      }
                    }
                  ],
                  "@removed_6a5af9046760477b9618e7b52f398c1f": {
                    "#name": "id",
                    "Description": "Fully qualified identifier of the resource",
                    "Required": false,
                    "Type": "string"
                  },
                  "@removed_4f4a2b9c0df849ebaa0b8671c12a7f69": {
                    "#name": "name",
                    "Description": "Name of the resource",
                    "Required": false,
                    "Type": "string"
                  },
                  "@removed_98965b0001074dcfb469c3bca5e130bb": {
                    "#name": "type",
                    "Description": "Type of the resource",
                    "Required": false,
                    "Type": "string"
                  }
                }
              }
            }
          ],
          "@added_67e005d310ef49e48d5c188f1f5e3d9a": {
            "#name": "sku",
            "Description": "Gets or sets the SKU of the resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "name",
                "Description": "The sku name",
                "Enum": [
                  [
                    "F0",
                    ""
                  ],
                  [
                    "S1",
                    ""
                  ]
                ],
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "tier",
                "Description": "Gets the sku tier. This is based on the SKU name.",
                "Enum": [
                  [
                    "Free",
                    ""
                  ],
                  [
                    "Standard",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            ]
          },
          "@added_75bfa2e5b273452da7b5f1a0941c8d6f": {
            "#name": "kind",
            "Description": "Required. Gets or sets the Kind of the resource.",
            "Enum": [
              [
                "sdk",
                ""
              ],
              [
                "designer",
                ""
              ],
              [
                "bot",
                ""
              ],
              [
                "function",
                ""
              ],
              [
                "azurebot",
                ""
              ]
            ],
            "Required": false,
            "Type": "string"
          },
          "@added_d9034a2c3a844e498e9193d0cd179869": {
            "#name": "etag",
            "Description": "Entity Tag.",
            "Required": false,
            "Type": "string"
          },
          "@added_d439cca080e442c08efd5b60d7d39e5e": {
            "#name": "zones",
            "Description": "Entity zones",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "networkSecurityPerimeterConfigurations": {
              "$properties": {
                "properties": [
                  {
                    "provisioningIssues": {
                      "$properties": {
                        "properties": [
                          {
                            "suggestedResourceIds": {
                              "Description": {
                                "new": "A type definition that refers the id to an Azure Resource Manager resource.",
                                "old": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                ],
                "@removed_89896f740f2d43eab89b415783a223d5": {
                  "#name": "id",
                  "Description": "Fully qualified identifier of the resource",
                  "Required": false,
                  "Type": "string"
                },
                "@removed_4dcf3565a2a14f5c8e80389e314f1185": {
                  "#name": "name",
                  "Description": "Name of the resource",
                  "Required": false,
                  "Type": "string"
                },
                "@removed_b5a40aee42a7442abedcf1e87719e416": {
                  "#name": "type",
                  "Description": "Type of the resource",
                  "Required": false,
                  "Type": "string"
                }
              }
            }
          }
        ],
        "@added_61a224bdd5f549c3a02766c94cf9b086": {
          "#name": "sku",
          "Description": "Gets or sets the SKU of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The sku name",
              "Enum": [
                [
                  "F0",
                  ""
                ],
                [
                  "S1",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "Gets the sku tier. This is based on the SKU name.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Standard",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_b1dc9519f33649ac892ad59b5c5b65e1": {
          "#name": "kind",
          "Description": "Required. Gets or sets the Kind of the resource.",
          "Enum": [
            [
              "sdk",
              ""
            ],
            [
              "designer",
              ""
            ],
            [
              "bot",
              ""
            ],
            [
              "function",
              ""
            ],
            [
              "azurebot",
              ""
            ]
          ],
          "Required": false,
          "Type": "string"
        },
        "@added_f8d6b3996c6544da8eb18edc4b4eb1e3": {
          "#name": "etag",
          "Description": "Entity Tag.",
          "Required": false,
          "Type": "string"
        },
        "@added_698607fe6d594fa1ac206b28ca0606f5": {
          "#name": "zones",
          "Description": "Entity zones",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        }
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "networkSecurityPerimeterConfigurations": {
              "$properties": {
                "properties": [
                  {
                    "provisioningIssues": {
                      "$properties": {
                        "properties": [
                          {
                            "suggestedResourceIds": {
                              "Description": {
                                "new": "A type definition that refers the id to an Azure Resource Manager resource.",
                                "old": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                ],
                "@removed_453e87b1baf24145ad8265bcd2a9a2fb": {
                  "#name": "id",
                  "Description": "Fully qualified identifier of the resource",
                  "Required": false,
                  "Type": "string"
                },
                "@removed_e9dae304bbc946848fd216e62d5d6d11": {
                  "#name": "name",
                  "Description": "Name of the resource",
                  "Required": false,
                  "Type": "string"
                },
                "@removed_4ab27615d39f46c9a72b5f03ef19725c": {
                  "#name": "type",
                  "Description": "Type of the resource",
                  "Required": false,
                  "Type": "string"
                }
              }
            }
          }
        ],
        "@added_21e5c220d90e4614a3702f5100bcf089": {
          "#name": "sku",
          "Description": "Gets or sets the SKU of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The sku name",
              "Enum": [
                [
                  "F0",
                  ""
                ],
                [
                  "S1",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "Gets the sku tier. This is based on the SKU name.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Standard",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_02239b252faa4c36bfaab8c3294f43e3": {
          "#name": "kind",
          "Description": "Required. Gets or sets the Kind of the resource.",
          "Enum": [
            [
              "sdk",
              ""
            ],
            [
              "designer",
              ""
            ],
            [
              "bot",
              ""
            ],
            [
              "function",
              ""
            ],
            [
              "azurebot",
              ""
            ]
          ],
          "Required": false,
          "Type": "string"
        },
        "@added_eb4d9a3ad9b34c24b41ffef95e59fb9e": {
          "#name": "etag",
          "Description": "Entity Tag.",
          "Required": false,
          "Type": "string"
        },
        "@added_d6781aa5956d42188f31d9f745500ae5": {
          "#name": "zones",
          "Description": "Entity zones",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        }
      }
    }
  }
}

⚼ 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 ,
}
,
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 ,
}
,
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 ,
}
,
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": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    },
    {
      "parameters": {
        "$properties": {
          "properties": [
            {
              "networkSecurityPerimeterConfigurations": {
                "$properties": {
                  "properties": [
                    {
                      "provisioningIssues": {
                        "$properties": {
                          "properties": [
                            {
                              "suggestedResourceIds": {
                                "Description": {
                                  "new": "A type definition that refers the id to an Azure Resource Manager resource.",
                                  "old": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
                                }
                              }
                            }
                          ]
                        }
                      }
                    }
                  ],
                  "@removed_126d9b48bbf34fbe917103e81093236e": {
                    "#name": "id",
                    "Description": "Fully qualified identifier of the resource",
                    "Required": false,
                    "Type": "string"
                  },
                  "@removed_546c25267be748f09497fe142d394aff": {
                    "#name": "name",
                    "Description": "Name of the resource",
                    "Required": false,
                    "Type": "string"
                  },
                  "@removed_7bd174fdeb414f0bb3a15dbe3f20fc5b": {
                    "#name": "type",
                    "Description": "Type of the resource",
                    "Required": false,
                    "Type": "string"
                  }
                }
              }
            }
          ],
          "@added_9ac07d7019b347e8a8c1a0c3db6932b8": {
            "#name": "sku",
            "Description": "Gets or sets the SKU of the resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "name",
                "Description": "The sku name",
                "Enum": [
                  [
                    "F0",
                    ""
                  ],
                  [
                    "S1",
                    ""
                  ]
                ],
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "tier",
                "Description": "Gets the sku tier. This is based on the SKU name.",
                "Enum": [
                  [
                    "Free",
                    ""
                  ],
                  [
                    "Standard",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            ]
          },
          "@added_f7e60237f8ab41e2a324ee2c3a878d29": {
            "#name": "kind",
            "Description": "Required. Gets or sets the Kind of the resource.",
            "Enum": [
              [
                "sdk",
                ""
              ],
              [
                "designer",
                ""
              ],
              [
                "bot",
                ""
              ],
              [
                "function",
                ""
              ],
              [
                "azurebot",
                ""
              ]
            ],
            "Required": false,
            "Type": "string"
          },
          "@added_c62679c42df1499d8bf788ed66ab1074": {
            "#name": "etag",
            "Description": "Entity Tag.",
            "Required": false,
            "Type": "string"
          },
          "@added_30618e2e8ad744a2ab4d2ac6bc32f600": {
            "#name": "zones",
            "Description": "Entity zones",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "networkSecurityPerimeterConfigurations": {
              "$properties": {
                "properties": [
                  {
                    "provisioningIssues": {
                      "$properties": {
                        "properties": [
                          {
                            "suggestedResourceIds": {
                              "Description": {
                                "new": "A type definition that refers the id to an Azure Resource Manager resource.",
                                "old": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                ],
                "@removed_60a38328478e4704adf095c8ce75fd0f": {
                  "#name": "id",
                  "Description": "Fully qualified identifier of the resource",
                  "Required": false,
                  "Type": "string"
                },
                "@removed_27b9153a88474d3a85f5ddefe636e551": {
                  "#name": "name",
                  "Description": "Name of the resource",
                  "Required": false,
                  "Type": "string"
                },
                "@removed_b92d064b32b344d38492bab6c27d65f1": {
                  "#name": "type",
                  "Description": "Type of the resource",
                  "Required": false,
                  "Type": "string"
                }
              }
            }
          }
        ],
        "@added_3c1a0960b82d4d4690519704ed6eb644": {
          "#name": "sku",
          "Description": "Gets or sets the SKU of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The sku name",
              "Enum": [
                [
                  "F0",
                  ""
                ],
                [
                  "S1",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "Gets the sku tier. This is based on the SKU name.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Standard",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_54fca48bfc6c4d78b73f90118712f470": {
          "#name": "kind",
          "Description": "Required. Gets or sets the Kind of the resource.",
          "Enum": [
            [
              "sdk",
              ""
            ],
            [
              "designer",
              ""
            ],
            [
              "bot",
              ""
            ],
            [
              "function",
              ""
            ],
            [
              "azurebot",
              ""
            ]
          ],
          "Required": false,
          "Type": "string"
        },
        "@added_61f2d3bbdd364ca299eab1fc690a41bf": {
          "#name": "etag",
          "Description": "Entity Tag.",
          "Required": false,
          "Type": "string"
        },
        "@added_4a382142ff294ff7b685350b879bf86e": {
          "#name": "zones",
          "Description": "Entity zones",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        }
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "networkSecurityPerimeterConfigurations": {
              "$properties": {
                "properties": [
                  {
                    "provisioningIssues": {
                      "$properties": {
                        "properties": [
                          {
                            "suggestedResourceIds": {
                              "Description": {
                                "new": "A type definition that refers the id to an Azure Resource Manager resource.",
                                "old": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                ],
                "@removed_b61e3ad1a39a4197aec686b458c21c39": {
                  "#name": "id",
                  "Description": "Fully qualified identifier of the resource",
                  "Required": false,
                  "Type": "string"
                },
                "@removed_af3670e06be54baeadee9624649317b0": {
                  "#name": "name",
                  "Description": "Name of the resource",
                  "Required": false,
                  "Type": "string"
                },
                "@removed_fbc2fb13a18e499ba400b51fa6160ef5": {
                  "#name": "type",
                  "Description": "Type of the resource",
                  "Required": false,
                  "Type": "string"
                }
              }
            }
          }
        ],
        "@added_9a32d21c6bfa4472b1d06ec3a55f7d3c": {
          "#name": "sku",
          "Description": "Gets or sets the SKU of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The sku name",
              "Enum": [
                [
                  "F0",
                  ""
                ],
                [
                  "S1",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "Gets the sku tier. This is based on the SKU name.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Standard",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_01d12c58aca04990b4d88b9bfe747b3a": {
          "#name": "kind",
          "Description": "Required. Gets or sets the Kind of the resource.",
          "Enum": [
            [
              "sdk",
              ""
            ],
            [
              "designer",
              ""
            ],
            [
              "bot",
              ""
            ],
            [
              "function",
              ""
            ],
            [
              "azurebot",
              ""
            ]
          ],
          "Required": false,
          "Type": "string"
        },
        "@added_af4fff7002a94283a8e80aec32f327fc": {
          "#name": "etag",
          "Description": "Entity Tag.",
          "Required": false,
          "Type": "string"
        },
        "@added_80653f005a6c4f119e8b686b89ece046": {
          "#name": "zones",
          "Description": "Entity zones",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        }
      }
    }
  }
}

⚼ 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 ,
}
,
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 ,
}
,
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 ,
}
,
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_Delete (updated)
Description :  Deletes a Bot Service from the resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Bots_Delete",
  "Description": {
    "new": "Deletes a Bot Service from the resource group.",
    "old": "Deletes a Bot Service from the resource group. "
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ]
}

⚼ Request

DELETE:  /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)

{}

⚐ Response (204)

{}

⚐ 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",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The BotChannel items on this page",
            "old": "Gets the list of bot service channel results and their properties."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@added_ec90cafa287d44ff869043321908a4d0": {
                "#name": "sku",
                "Description": "Gets or sets the SKU of the resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "The sku name",
                    "Enum": [
                      [
                        "F0",
                        ""
                      ],
                      [
                        "S1",
                        ""
                      ]
                    ],
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "tier",
                    "Description": "Gets the sku tier. This is based on the SKU name.",
                    "Enum": [
                      [
                        "Free",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              "@added_2d95dfe1b1ad4957ae089abb6699a211": {
                "#name": "kind",
                "Description": "Required. Gets or sets the Kind of the resource.",
                "Enum": [
                  [
                    "sdk",
                    ""
                  ],
                  [
                    "designer",
                    ""
                  ],
                  [
                    "bot",
                    ""
                  ],
                  [
                    "function",
                    ""
                  ],
                  [
                    "azurebot",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              "@added_df8f432e25274fd7affc553128149fcf": {
                "#name": "etag",
                "Description": "Entity Tag.",
                "Required": false,
                "Type": "string"
              },
              "@added_71a7c1646dc140d3add933017221245e": {
                "#name": "zones",
                "Description": "Entity zones",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link used to get the next page of bot service channel resources."
          }
        }
      ]
    }
  }
}

⚼ 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 ,
}
,
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",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_ae75953c0f404a43a501af9046814abb": {
          "#name": "sku",
          "Description": "Gets or sets the SKU of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The sku name",
              "Enum": [
                [
                  "F0",
                  ""
                ],
                [
                  "S1",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "Gets the sku tier. This is based on the SKU name.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Standard",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_66a69b5397974813927ba2ea39cfa5e2": {
          "#name": "kind",
          "Description": "Required. Gets or sets the Kind of the resource.",
          "Enum": [
            [
              "sdk",
              ""
            ],
            [
              "designer",
              ""
            ],
            [
              "bot",
              ""
            ],
            [
              "function",
              ""
            ],
            [
              "azurebot",
              ""
            ]
          ],
          "Required": false,
          "Type": "string"
        },
        "@added_790fbec419c74d4d908c71205a4e33cb": {
          "#name": "etag",
          "Description": "Entity Tag.",
          "Required": false,
          "Type": "string"
        },
        "@added_91ebf2afa22c4c13b0b5f011e50eb374": {
          "#name": "zones",
          "Description": "Entity zones",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        }
      }
    }
  }
}

⚼ 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 ,
}
,
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": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    },
    {
      "#name": "parameters",
      "Description": {
        "new": "Resource create parameters.",
        "old": "The parameters to provide for the created bot."
      },
      "$schema": {
        "$properties": {
          "@added_bd0881b668eb41259fec73c7fe332ad0": {
            "#name": "sku",
            "Description": "Gets or sets the SKU of the resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "name",
                "Description": "The sku name",
                "Enum": [
                  [
                    "F0",
                    ""
                  ],
                  [
                    "S1",
                    ""
                  ]
                ],
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "tier",
                "Description": "Gets the sku tier. This is based on the SKU name.",
                "Enum": [
                  [
                    "Free",
                    ""
                  ],
                  [
                    "Standard",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            ]
          },
          "@added_45c0667637ce411cba05a5c42a2f6450": {
            "#name": "kind",
            "Description": "Required. Gets or sets the Kind of the resource.",
            "Enum": [
              [
                "sdk",
                ""
              ],
              [
                "designer",
                ""
              ],
              [
                "bot",
                ""
              ],
              [
                "function",
                ""
              ],
              [
                "azurebot",
                ""
              ]
            ],
            "Required": false,
            "Type": "string"
          },
          "@added_cd066a8c3f5b4e9fb99155ab6bb3019d": {
            "#name": "etag",
            "Description": "Entity Tag.",
            "Required": false,
            "Type": "string"
          },
          "@added_1f845bbcedae4c7292885b6c23078bb0": {
            "#name": "zones",
            "Description": "Entity zones",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_f6148d50a22f4ecf94d11edb2ebcd863": {
          "#name": "sku",
          "Description": "Gets or sets the SKU of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The sku name",
              "Enum": [
                [
                  "F0",
                  ""
                ],
                [
                  "S1",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "Gets the sku tier. This is based on the SKU name.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Standard",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_854d945e8d9a4811a2298e18ffa14906": {
          "#name": "kind",
          "Description": "Required. Gets or sets the Kind of the resource.",
          "Enum": [
            [
              "sdk",
              ""
            ],
            [
              "designer",
              ""
            ],
            [
              "bot",
              ""
            ],
            [
              "function",
              ""
            ],
            [
              "azurebot",
              ""
            ]
          ],
          "Required": false,
          "Type": "string"
        },
        "@added_20d0d26a6e9643259bd90f22078f5f00": {
          "#name": "etag",
          "Description": "Entity Tag.",
          "Required": false,
          "Type": "string"
        },
        "@added_2df07073c19f42f3993e873c469ed7a2": {
          "#name": "zones",
          "Description": "Entity zones",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        }
      }
    },
    "201": {
      "$properties": {
        "@added_1844c8b1ba9f400ba2fa7133f2a4f7d2": {
          "#name": "sku",
          "Description": "Gets or sets the SKU of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The sku name",
              "Enum": [
                [
                  "F0",
                  ""
                ],
                [
                  "S1",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "Gets the sku tier. This is based on the SKU name.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Standard",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_4b54b0bd9b1c4fff83f48a8ec5314435": {
          "#name": "kind",
          "Description": "Required. Gets or sets the Kind of the resource.",
          "Enum": [
            [
              "sdk",
              ""
            ],
            [
              "designer",
              ""
            ],
            [
              "bot",
              ""
            ],
            [
              "function",
              ""
            ],
            [
              "azurebot",
              ""
            ]
          ],
          "Required": false,
          "Type": "string"
        },
        "@added_44c9c00ffef74a7f992304d2dedc7027": {
          "#name": "etag",
          "Description": "Entity Tag.",
          "Required": false,
          "Type": "string"
        },
        "@added_02aa3d7040c04667b9ad19c7d82a8281": {
          "#name": "zones",
          "Description": "Entity zones",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        }
      }
    }
  }
}

⚼ 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 ,
}
,
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 ,
}
,
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 ,
}
,
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": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    },
    {
      "parameters": {
        "$properties": {
          "@added_eb3b4779969f4b28a2c84d87847e9570": {
            "#name": "sku",
            "Description": "Gets or sets the SKU of the resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "name",
                "Description": "The sku name",
                "Enum": [
                  [
                    "F0",
                    ""
                  ],
                  [
                    "S1",
                    ""
                  ]
                ],
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "tier",
                "Description": "Gets the sku tier. This is based on the SKU name.",
                "Enum": [
                  [
                    "Free",
                    ""
                  ],
                  [
                    "Standard",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            ]
          },
          "@added_d76f9ab30efe4f57a50760a30a3ab7c2": {
            "#name": "kind",
            "Description": "Required. Gets or sets the Kind of the resource.",
            "Enum": [
              [
                "sdk",
                ""
              ],
              [
                "designer",
                ""
              ],
              [
                "bot",
                ""
              ],
              [
                "function",
                ""
              ],
              [
                "azurebot",
                ""
              ]
            ],
            "Required": false,
            "Type": "string"
          },
          "@added_033d8ce21ac74efaaebbd4917f1b9a84": {
            "#name": "etag",
            "Description": "Entity Tag.",
            "Required": false,
            "Type": "string"
          },
          "@added_011ca8a4481240e89d78ece4272bd9d1": {
            "#name": "zones",
            "Description": "Entity zones",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_28c7dae7bf71499095ed4a0d6d526238": {
          "#name": "sku",
          "Description": "Gets or sets the SKU of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The sku name",
              "Enum": [
                [
                  "F0",
                  ""
                ],
                [
                  "S1",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "Gets the sku tier. This is based on the SKU name.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Standard",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_208e74f56cdd4b9a9f8f0ffb55b32101": {
          "#name": "kind",
          "Description": "Required. Gets or sets the Kind of the resource.",
          "Enum": [
            [
              "sdk",
              ""
            ],
            [
              "designer",
              ""
            ],
            [
              "bot",
              ""
            ],
            [
              "function",
              ""
            ],
            [
              "azurebot",
              ""
            ]
          ],
          "Required": false,
          "Type": "string"
        },
        "@added_f3b64d10b81e41e5b5d3fbd67a0c698d": {
          "#name": "etag",
          "Description": "Entity Tag.",
          "Required": false,
          "Type": "string"
        },
        "@added_5bec52dbec534f38878a9530e95848c4": {
          "#name": "zones",
          "Description": "Entity zones",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        }
      }
    },
    "201": {
      "$properties": {
        "@added_35feccead3cf49d28d12197e48919770": {
          "#name": "sku",
          "Description": "Gets or sets the SKU of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The sku name",
              "Enum": [
                [
                  "F0",
                  ""
                ],
                [
                  "S1",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "Gets the sku tier. This is based on the SKU name.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Standard",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_410460f985d24cdbbdec572e52f9abb9": {
          "#name": "kind",
          "Description": "Required. Gets or sets the Kind of the resource.",
          "Enum": [
            [
              "sdk",
              ""
            ],
            [
              "designer",
              ""
            ],
            [
              "bot",
              ""
            ],
            [
              "function",
              ""
            ],
            [
              "azurebot",
              ""
            ]
          ],
          "Required": false,
          "Type": "string"
        },
        "@added_013c8f48b6d14445818c35aa357df0d4": {
          "#name": "etag",
          "Description": "Entity Tag.",
          "Required": false,
          "Type": "string"
        },
        "@added_9016ea45840a4ab1b31f72baed9341f2": {
          "#name": "zones",
          "Description": "Entity zones",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        }
      }
    }
  }
}

⚼ 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 ,
}
,
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 ,
}
,
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 ,
}
,
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_Delete (updated)
Description :  Deletes a Channel registration from a Bot Service
Reference :  Link ¶

⚶ Changes

{
  "#id": "Channels_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ]
}

⚼ Request

DELETE:  /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)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Channels_ListWithKeys",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}/listChannelWithKeys
{
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 ,
}

⚐ Response (200)

{
resource:
{
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 ,
}
,
setting:
{
Description: Channel settings ,
Required: False ,
}
{
extensionKey1:
{
Description: The extensionKey1 ,
Required: False ,
}
string ,
extensionKey2:
{
Description: The extensionKey2 ,
Required: False ,
}
string ,
sites:
{
Description: The list of sites ,
Required: False ,
}
[
{
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
siteId:
{
Description: Site Id ,
Required: False ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
key:
{
Description: Primary key. Value only returned through POST to the action Channel List API, otherwise empty. ,
Required: False ,
}
string ,
key2:
{
Description: Secondary key. Value only returned through POST to the action Channel List API, otherwise empty. ,
Required: False ,
}
string ,
isEnabled:
{
Description: Whether this site is enabled for DirectLine channel ,
Required: True ,
}
boolean ,
isTokenEnabled:
{
Description: Whether this site is token enabled for channel ,
Required: False ,
}
boolean ,
isEndpointParametersEnabled:
{
Description: Whether this site is EndpointParameters enabled for channel ,
Required: False ,
}
boolean ,
isDetailedLoggingEnabled:
{
Description: Whether this site is disabled detailed logging for ,
Required: False ,
}
boolean ,
isBlockUserUploadEnabled:
{
Description: Whether this site is enabled for block user upload. ,
Required: False ,
}
boolean ,
isNoStorageEnabled:
{
Description: Whether this no-storage site is disabled detailed logging for ,
Required: False ,
}
boolean ,
eTag:
{
Description: Entity Tag ,
Required: False ,
}
string ,
appId:
{
Description: DirectLine application id ,
Required: False ,
}
string ,
isV1Enabled:
{
Description: Whether this site is enabled for Bot Framework V1 protocol. ,
Required: False ,
}
boolean ,
isV3Enabled:
{
Description: Whether this site is enabled for Bot Framework V3 protocol. ,
Required: False ,
}
boolean ,
isSecureSiteEnabled:
{
Description: Whether this site is enabled for authentication with Bot Framework. ,
Required: False ,
}
boolean ,
trustedOrigins:
{
Description: List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True. ,
Required: False ,
}
[
string ,
]
,
isWebChatSpeechEnabled:
{
Description: Whether this site is enabled for Webchat Speech ,
Required: False ,
}
boolean ,
isWebchatPreviewEnabled:
{
Description: Whether this site is enabled for preview versions of Webchat ,
Required: False ,
}
boolean ,
}
,
]
,
channelId:
{
Description: The channel id ,
Required: False ,
}
string ,
channelDisplayName:
{
Description: The channel display name ,
Required: False ,
}
string ,
botId:
{
Description: The bot id ,
Required: False ,
}
string ,
botIconUrl:
{
Description: The bot icon url ,
Required: False ,
}
string ,
isEnabled:
{
Description: Whether this channel is enabled for the bot ,
Required: False ,
}
boolean ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
requireTermsAgreement:
{
Description: Whether customer needs to agree to new terms. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
entityTag:
{
Description: Entity tag of the resource ,
Required: False ,
}
string ,
changedTime:
{
Description: Changed time of the resource ,
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",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_c5a1426be2a6405a9d6fad069d6dab51": {
          "#name": "sku",
          "Description": "Gets or sets the SKU of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The sku name",
              "Enum": [
                [
                  "F0",
                  ""
                ],
                [
                  "S1",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "Gets the sku tier. This is based on the SKU name.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Standard",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_930d48b9ab444c1aba83df9874337681": {
          "#name": "kind",
          "Description": "Required. Gets or sets the Kind of the resource.",
          "Enum": [
            [
              "sdk",
              ""
            ],
            [
              "designer",
              ""
            ],
            [
              "bot",
              ""
            ],
            [
              "function",
              ""
            ],
            [
              "azurebot",
              ""
            ]
          ],
          "Required": false,
          "Type": "string"
        },
        "@added_028ee3e4e1a141d9919a6f7984fb2aca": {
          "#name": "etag",
          "Description": "Entity Tag.",
          "Required": false,
          "Type": "string"
        },
        "@added_bda1cf251ed04e42a43df2aae37beacc": {
          "#name": "zones",
          "Description": "Entity zones",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        }
      }
    }
  }
}

⚼ 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 ,
}
,
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 ,
}
,
}
BotConnection_ListByBotService (updated)
Description :  Returns all the Connection Settings registered to a particular BotService resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "BotConnection_ListByBotService",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ConnectionSetting items on this page",
            "old": "Gets the list of bot service connection settings and their properties."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@added_8aee0f3044824739bea0984a9393b34d": {
                "#name": "location",
                "Description": "Specifies the location of the resource.",
                "Required": false,
                "Type": "string"
              },
              "@added_658256fd2bb746b184ad4f0993a98129": {
                "#name": "tags",
                "Description": "Contains resource tags defined as key/value pairs.",
                "Required": false,
                "Type": "object"
              },
              "@added_38a616e160934dd89d2a596c80997ca1": {
                "#name": "sku",
                "Description": "Gets or sets the SKU of the resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "The sku name",
                    "Enum": [
                      [
                        "F0",
                        ""
                      ],
                      [
                        "S1",
                        ""
                      ]
                    ],
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "tier",
                    "Description": "Gets the sku tier. This is based on the SKU name.",
                    "Enum": [
                      [
                        "Free",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              "@added_08a59b3f965245bb8d38985a5487e75c": {
                "#name": "kind",
                "Description": "Required. Gets or sets the Kind of the resource.",
                "Enum": [
                  [
                    "sdk",
                    ""
                  ],
                  [
                    "designer",
                    ""
                  ],
                  [
                    "bot",
                    ""
                  ],
                  [
                    "function",
                    ""
                  ],
                  [
                    "azurebot",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              "@added_cec93421ce5d4a988d22937a4750686b": {
                "#name": "etag",
                "Description": "Entity Tag.",
                "Required": false,
                "Type": "string"
              },
              "@added_63e8af5ab2d14b1d89e21dd4ea269d78": {
                "#name": "zones",
                "Description": "Entity zones",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link used to get the next page of bot service connection setting resources."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections
{
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 ConnectionSetting items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Format: password ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state 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 ,
}
,
}
BotConnection_Get (updated)
Description :  Get a Connection Setting registration for a Bot Service
Reference :  Link ¶

⚶ Changes

{
  "#id": "BotConnection_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_e1ac151d1bf34ddab327658250bd063c": {
          "#name": "location",
          "Description": "Specifies the location of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_64c15ddb5d4b4e98a8015cb9bb442307": {
          "#name": "tags",
          "Description": "Contains resource tags defined as key/value pairs.",
          "Required": false,
          "Type": "object"
        },
        "@added_88b29a2a28ce499ea23a382616bd8210": {
          "#name": "sku",
          "Description": "Gets or sets the SKU of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The sku name",
              "Enum": [
                [
                  "F0",
                  ""
                ],
                [
                  "S1",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "Gets the sku tier. This is based on the SKU name.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Standard",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_29e5a87d20934cbaba326489379f962e": {
          "#name": "kind",
          "Description": "Required. Gets or sets the Kind of the resource.",
          "Enum": [
            [
              "sdk",
              ""
            ],
            [
              "designer",
              ""
            ],
            [
              "bot",
              ""
            ],
            [
              "function",
              ""
            ],
            [
              "azurebot",
              ""
            ]
          ],
          "Required": false,
          "Type": "string"
        },
        "@added_724ded3a267b4fa8a3e8a4daad86dd2b": {
          "#name": "etag",
          "Description": "Entity Tag.",
          "Required": false,
          "Type": "string"
        },
        "@added_120baee47fee4889806742043ceec040": {
          "#name": "zones",
          "Description": "Entity zones",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}
{
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 ,
connectionName:
{
Description: The name of the Bot Service Connection Setting resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Format: password ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state 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 ,
}
,
}
BotConnection_Create (updated)
Description :  Register a new Auth Connection for a Bot Service
Reference :  Link ¶

⚶ Changes

{
  "#id": "BotConnection_Create",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    },
    {
      "parameters": {
        "$properties": {
          "@added_a557c921459345e4b75188f911fddb3a": {
            "#name": "location",
            "Description": "Specifies the location of the resource.",
            "Required": false,
            "Type": "string"
          },
          "@added_df3ddb94e7cc4ac48a8523c4963c9d6e": {
            "#name": "tags",
            "Description": "Contains resource tags defined as key/value pairs.",
            "Required": false,
            "Type": "object"
          },
          "@added_93a526c488cd478590bcb66ab87ee59f": {
            "#name": "sku",
            "Description": "Gets or sets the SKU of the resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "name",
                "Description": "The sku name",
                "Enum": [
                  [
                    "F0",
                    ""
                  ],
                  [
                    "S1",
                    ""
                  ]
                ],
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "tier",
                "Description": "Gets the sku tier. This is based on the SKU name.",
                "Enum": [
                  [
                    "Free",
                    ""
                  ],
                  [
                    "Standard",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            ]
          },
          "@added_c5afd66563fe4e9093a09ee3863e5d13": {
            "#name": "kind",
            "Description": "Required. Gets or sets the Kind of the resource.",
            "Enum": [
              [
                "sdk",
                ""
              ],
              [
                "designer",
                ""
              ],
              [
                "bot",
                ""
              ],
              [
                "function",
                ""
              ],
              [
                "azurebot",
                ""
              ]
            ],
            "Required": false,
            "Type": "string"
          },
          "@added_d1d4aa410879443e961ff901f2abf4a8": {
            "#name": "etag",
            "Description": "Entity Tag.",
            "Required": false,
            "Type": "string"
          },
          "@added_37f65c60e5e14c1292ae67492ba41545": {
            "#name": "zones",
            "Description": "Entity zones",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_187d7418c6fe45eea7c2eec1d9fc68fe": {
          "#name": "location",
          "Description": "Specifies the location of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_efb91c662b3b42fb8b4389cd1134095a": {
          "#name": "tags",
          "Description": "Contains resource tags defined as key/value pairs.",
          "Required": false,
          "Type": "object"
        },
        "@added_b2cf8f85101f4842949d575bf4eb573f": {
          "#name": "sku",
          "Description": "Gets or sets the SKU of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The sku name",
              "Enum": [
                [
                  "F0",
                  ""
                ],
                [
                  "S1",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "Gets the sku tier. This is based on the SKU name.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Standard",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_b9f101029a264ac79f66bcf19f7d8a8d": {
          "#name": "kind",
          "Description": "Required. Gets or sets the Kind of the resource.",
          "Enum": [
            [
              "sdk",
              ""
            ],
            [
              "designer",
              ""
            ],
            [
              "bot",
              ""
            ],
            [
              "function",
              ""
            ],
            [
              "azurebot",
              ""
            ]
          ],
          "Required": false,
          "Type": "string"
        },
        "@added_e516a96c9bd044408e62240fefadbd80": {
          "#name": "etag",
          "Description": "Entity Tag.",
          "Required": false,
          "Type": "string"
        },
        "@added_d0d2543cd47f40ee8ad9731fdb77b775": {
          "#name": "zones",
          "Description": "Entity zones",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        }
      }
    },
    "201": {
      "$properties": {
        "@added_5365da602e674b57b655490ea3a8a076": {
          "#name": "location",
          "Description": "Specifies the location of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_4c91cddff6924cad944902ea8c3c460e": {
          "#name": "tags",
          "Description": "Contains resource tags defined as key/value pairs.",
          "Required": false,
          "Type": "object"
        },
        "@added_aff7b8fde98b48719f49e33b5e606008": {
          "#name": "sku",
          "Description": "Gets or sets the SKU of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The sku name",
              "Enum": [
                [
                  "F0",
                  ""
                ],
                [
                  "S1",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "Gets the sku tier. This is based on the SKU name.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Standard",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_2f572996aa5242f681e2f97f7b0e3e6c": {
          "#name": "kind",
          "Description": "Required. Gets or sets the Kind of the resource.",
          "Enum": [
            [
              "sdk",
              ""
            ],
            [
              "designer",
              ""
            ],
            [
              "bot",
              ""
            ],
            [
              "function",
              ""
            ],
            [
              "azurebot",
              ""
            ]
          ],
          "Required": false,
          "Type": "string"
        },
        "@added_24852a5df2e64a69bf3086f4c251ed9d": {
          "#name": "etag",
          "Description": "Entity Tag.",
          "Required": false,
          "Type": "string"
        },
        "@added_2ebbd98fd47b4977bf6dcaefee47cfdd": {
          "#name": "zones",
          "Description": "Entity zones",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}
{
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 ,
connectionName:
{
Description: The name of the Bot Service Connection Setting resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for creating the Connection Setting. ,
Required: True ,
}
{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Format: password ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state 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 ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Format: password ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state 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 ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Format: password ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state 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 ,
}
,
}
BotConnection_Update (updated)
Description :  Updates a Connection Setting registration for a Bot Service
Reference :  Link ¶

⚶ Changes

{
  "#id": "BotConnection_Update",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    },
    {
      "parameters": {
        "$properties": {
          "@added_9b35e58b7f70428ba5d99c2eaea1a779": {
            "#name": "location",
            "Description": "Specifies the location of the resource.",
            "Required": false,
            "Type": "string"
          },
          "@added_5ed739d5c2e64c4f940d6cc1fe99b5c5": {
            "#name": "tags",
            "Description": "Contains resource tags defined as key/value pairs.",
            "Required": false,
            "Type": "object"
          },
          "@added_0afeb40ec44d44e8aa0165a8bb5282b9": {
            "#name": "sku",
            "Description": "Gets or sets the SKU of the resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "name",
                "Description": "The sku name",
                "Enum": [
                  [
                    "F0",
                    ""
                  ],
                  [
                    "S1",
                    ""
                  ]
                ],
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "tier",
                "Description": "Gets the sku tier. This is based on the SKU name.",
                "Enum": [
                  [
                    "Free",
                    ""
                  ],
                  [
                    "Standard",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            ]
          },
          "@added_8eb5216a7d9241d4af4e142d38be3915": {
            "#name": "kind",
            "Description": "Required. Gets or sets the Kind of the resource.",
            "Enum": [
              [
                "sdk",
                ""
              ],
              [
                "designer",
                ""
              ],
              [
                "bot",
                ""
              ],
              [
                "function",
                ""
              ],
              [
                "azurebot",
                ""
              ]
            ],
            "Required": false,
            "Type": "string"
          },
          "@added_a7cf076b69334a88afd74f9647178e1a": {
            "#name": "etag",
            "Description": "Entity Tag.",
            "Required": false,
            "Type": "string"
          },
          "@added_95d99f18c1854c08a45c488d6c49493b": {
            "#name": "zones",
            "Description": "Entity zones",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_f4822d24339242fb9624abe8a4df5759": {
          "#name": "location",
          "Description": "Specifies the location of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_83c46c67f16d44a68349c3d828f96661": {
          "#name": "tags",
          "Description": "Contains resource tags defined as key/value pairs.",
          "Required": false,
          "Type": "object"
        },
        "@added_8180267471624e77a82a66098bc4689c": {
          "#name": "sku",
          "Description": "Gets or sets the SKU of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The sku name",
              "Enum": [
                [
                  "F0",
                  ""
                ],
                [
                  "S1",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "Gets the sku tier. This is based on the SKU name.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Standard",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_fee85cd7d9aa42558b58c5097551481c": {
          "#name": "kind",
          "Description": "Required. Gets or sets the Kind of the resource.",
          "Enum": [
            [
              "sdk",
              ""
            ],
            [
              "designer",
              ""
            ],
            [
              "bot",
              ""
            ],
            [
              "function",
              ""
            ],
            [
              "azurebot",
              ""
            ]
          ],
          "Required": false,
          "Type": "string"
        },
        "@added_14a17b34751d4e56800fa53919193796": {
          "#name": "etag",
          "Description": "Entity Tag.",
          "Required": false,
          "Type": "string"
        },
        "@added_8bbc1e18bef848319d5ca14fa5cca1db": {
          "#name": "zones",
          "Description": "Entity zones",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        }
      }
    },
    "201": {
      "$properties": {
        "@added_8300277ec56245fcbe911500fbc29896": {
          "#name": "location",
          "Description": "Specifies the location of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_84f9b05186bf4ef49c4da6ede345b9f8": {
          "#name": "tags",
          "Description": "Contains resource tags defined as key/value pairs.",
          "Required": false,
          "Type": "object"
        },
        "@added_dacabf1c66a349b08fee28206c6c20e6": {
          "#name": "sku",
          "Description": "Gets or sets the SKU of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The sku name",
              "Enum": [
                [
                  "F0",
                  ""
                ],
                [
                  "S1",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "Gets the sku tier. This is based on the SKU name.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Standard",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_584e8614dc09458c851e987aa7bd177a": {
          "#name": "kind",
          "Description": "Required. Gets or sets the Kind of the resource.",
          "Enum": [
            [
              "sdk",
              ""
            ],
            [
              "designer",
              ""
            ],
            [
              "bot",
              ""
            ],
            [
              "function",
              ""
            ],
            [
              "azurebot",
              ""
            ]
          ],
          "Required": false,
          "Type": "string"
        },
        "@added_008db2fc6656467c84219bfab1aa076c": {
          "#name": "etag",
          "Description": "Entity Tag.",
          "Required": false,
          "Type": "string"
        },
        "@added_c10dbafa42e74c269104657d251384a3": {
          "#name": "zones",
          "Description": "Entity zones",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        }
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}
{
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 ,
connectionName:
{
Description: The name of the Bot Service Connection Setting resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for updating the Connection Setting. ,
Required: True ,
}
{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Format: password ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state 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 ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Format: password ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state 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 ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Format: password ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state 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 ,
}
,
}
BotConnection_Delete (updated)
Description :  Deletes a Connection Setting registration for a Bot Service
Reference :  Link ¶

⚶ Changes

{
  "#id": "BotConnection_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}
{
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 ,
connectionName:
{
Description: The name of the Bot Service Connection Setting resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
BotConnection_ListWithSecrets (updated)
Description :  Get a Connection Setting registration for a Bot Service
Reference :  Link ¶

⚶ Changes

{
  "#id": "BotConnection_ListWithSecrets",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_70a9f2b54eb044ff83f160076ab71157": {
          "#name": "location",
          "Description": "Specifies the location of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_a6af42d646f44a3d982e9f311496b41a": {
          "#name": "tags",
          "Description": "Contains resource tags defined as key/value pairs.",
          "Required": false,
          "Type": "object"
        },
        "@added_b3bf396aed1943919c28ee012aa03c57": {
          "#name": "sku",
          "Description": "Gets or sets the SKU of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The sku name",
              "Enum": [
                [
                  "F0",
                  ""
                ],
                [
                  "S1",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "Gets the sku tier. This is based on the SKU name.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Standard",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_d359e1f23b784947bcf2c03bce939206": {
          "#name": "kind",
          "Description": "Required. Gets or sets the Kind of the resource.",
          "Enum": [
            [
              "sdk",
              ""
            ],
            [
              "designer",
              ""
            ],
            [
              "bot",
              ""
            ],
            [
              "function",
              ""
            ],
            [
              "azurebot",
              ""
            ]
          ],
          "Required": false,
          "Type": "string"
        },
        "@added_3ea1102881744561a719399aa5e906ce": {
          "#name": "etag",
          "Description": "Entity Tag.",
          "Required": false,
          "Type": "string"
        },
        "@added_7b4eb080d6d840cfa21f55f691833414": {
          "#name": "zones",
          "Description": "Entity zones",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        }
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}/listWithSecrets
{
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 ,
connectionName:
{
Description: The name of the Bot Service Connection Setting resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Format: password ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state 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 ,
}
,
}
Email_CreateSignInUrl (updated)
Description :  Creates an email channel sign in url for a Bot Service
Reference :  Link ¶

⚶ Changes

{
  "#id": "Email_CreateSignInUrl",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/createEmailSignInUrl
{
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)

{
id:
{
Description: Specifies the resource ID. ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: The set of properties specific to sign in url ,
Required: False ,
}
{
url:
{
Description: Sign in url. ,
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 ,
}
,
}
NetworkSecurityPerimeterConfigurations_List (updated)
Description :  List Network Security Perimeter configurations associated with the Bot.
Reference :  Link ¶

⚶ Changes

{
  "#id": "NetworkSecurityPerimeterConfigurations_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The NetworkSecurityPerimeterConfiguration items on this page",
            "old": "A collection of Network Security Perimeter configurations"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "provisioningIssues": {
                    "$properties": {
                      "properties": [
                        {
                          "suggestedResourceIds": {
                            "Description": {
                              "new": "A type definition that refers the id to an Azure Resource Manager resource.",
                              "old": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              ],
              "@removed_fa9b7508f02546dd9f46c11e3e6a6a21": {
                "#name": "id",
                "Description": "Fully qualified identifier of the resource",
                "Required": false,
                "Type": "string"
              },
              "@removed_8b3f8a27fc3a4b3ebad89f2b3110a98a": {
                "#name": "name",
                "Description": "Name of the resource",
                "Required": false,
                "Type": "string"
              },
              "@removed_a1f7f766f02149289bc466da4509f025": {
                "#name": "type",
                "Description": "Type of the resource",
                "Required": false,
                "Type": "string"
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to retrieve next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/networkSecurityPerimeterConfigurations
{
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 NetworkSecurityPerimeterConfiguration items on this page ,
Required: True ,
}
[
{
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 ,
]
,
}
,
}
,
}
,
]
,
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 ,
}
,
}
NetworkSecurityPerimeterConfigurations_Get (updated)
Description :  Gets the specified Network Security Perimeter configuration associated with the Bot.
Reference :  Link ¶

⚶ Changes

{
  "#id": "NetworkSecurityPerimeterConfigurations_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "provisioningIssues": {
              "$properties": {
                "properties": [
                  {
                    "suggestedResourceIds": {
                      "Description": {
                        "new": "A type definition that refers the id to an Azure Resource Manager resource.",
                        "old": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
                      }
                    }
                  }
                ]
              }
            }
          }
        ],
        "@removed_3274c4bcc01b4bb2aa1e50fa5fa04572": {
          "#name": "id",
          "Description": "Fully qualified identifier of the resource",
          "Required": false,
          "Type": "string"
        },
        "@removed_468e365586b740679c75c19962fafaa3": {
          "#name": "name",
          "Description": "Name of the resource",
          "Required": false,
          "Type": "string"
        },
        "@removed_60dec92b2da8433fa1efba4ef61eaccc": {
          "#name": "type",
          "Description": "Type of the resource",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}
{
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 ,
networkSecurityPerimeterConfigurationName:
{
Description: The resource association Name. Composed of parameter guid and association name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
NetworkSecurityPerimeterConfigurations_Reconcile (updated)
Description :  Reconcile the specified Network Security Perimeter configuration associated with the Bot.
Reference :  Link ¶

⚶ Changes

{
  "#id": "NetworkSecurityPerimeterConfigurations_Reconcile",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "provisioningIssues": {
              "$properties": {
                "properties": [
                  {
                    "suggestedResourceIds": {
                      "Description": {
                        "new": "A type definition that refers the id to an Azure Resource Manager resource.",
                        "old": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
                      }
                    }
                  }
                ]
              }
            }
          }
        ],
        "@removed_7ede1e9ce15f4786a393ef31dec8245f": {
          "#name": "id",
          "Description": "Fully qualified identifier of the resource",
          "Required": false,
          "Type": "string"
        },
        "@removed_86d0df1727c946f3b0c332616f9f4519": {
          "#name": "name",
          "Description": "Name of the resource",
          "Required": false,
          "Type": "string"
        },
        "@removed_5376c766bc7a4c81b6d31fb06d6c8da5": {
          "#name": "type",
          "Description": "Type of the resource",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "202": [
      {
        "@added_17ed403629cb48869871c3c7869d8223": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}/reconcile
{
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 ,
networkSecurityPerimeterConfigurationName:
{
Description: The resource association Name. Composed of parameter guid and association name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
]
,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_List (updated)
Description :  List all the private endpoint connections associated with the Bot.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_d3e902a47ebb4d6199093d2f55f6c541": {
          "#name": "nextLink",
          "Description": "The link used to get the next page of private endpoint connections.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateEndpointConnections
{
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: Array of private endpoint connections ,
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 ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of private endpoint connections. ,
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 ,
}
,
}
PrivateEndpointConnections_Get (updated)
Description :  Gets the specified private endpoint connection associated with the Bot.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
PrivateEndpointConnections_Create (updated)
Description :  Update the state of specified private endpoint connection associated with the Bot.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_Create",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ]
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
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 ,
]
,
}
,
}
,
}

⚐ Response (200)

{
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 ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
PrivateEndpointConnections_Delete (updated)
Description :  Deletes the specified private endpoint connection associated with the Bot.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
PrivateLinkResources_ListByBotResource (updated)
Description :  Gets the private link resources that need to be created for a Bot.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateLinkResources_ListByBotResource",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateLinkResources
{
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: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
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 ,
}
,
}