# Azure Bot management API

> Azure Bot management API on Apizie: 31 endpoints (Returns a BotService specified by the parameters., Creates a Bot Service. Bot Service is a resource group wide resource type., Updates a Bot Service, Deletes a Bot Service from the resource group., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/cloud:azure-arm-botservice/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:azure-arm-botservice`
- Category: Cloud
- Status: byok
- Source: https://learn.microsoft.com/rest/api/azure/
- Page: https://www.apizie.tech/api/cloud/azure-arm-botservice
- OpenAPI: https://www.apizie.tech/api/cloud/azure-arm-botservice/openapi.json

Azure Resource Manager API for Bot: manage these Azure resources in your subscription with a Microsoft Entra access token.

## Endpoints

### Returns a BotService specified by the parameters.
`GET https://www.apizie.tech/v1/cloud:azure-arm-botservice/bots-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |

### Creates a Bot Service. Bot Service is a resource group wide resource type.
`POST https://www.apizie.tech/v1/cloud:azure-arm-botservice/bots-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |
| body | object | yes | JSON request body |

### Updates a Bot Service
`POST https://www.apizie.tech/v1/cloud:azure-arm-botservice/bots-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |
| body | object | yes | JSON request body |

### Deletes a Bot Service from the resource group.
`POST https://www.apizie.tech/v1/cloud:azure-arm-botservice/bots-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |

### Returns all the resources of a particular type belonging to a resource group
`GET https://www.apizie.tech/v1/cloud:azure-arm-botservice/bots-list-by-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| subscriptionId | string | yes | Azure Subscription ID. |
| api-version | string | no | Version of the API to be used with the client request. |

### Returns all the resources of a particular type belonging to a subscription.
`GET https://www.apizie.tech/v1/cloud:azure-arm-botservice/bots-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |

### Returns a BotService Channel registration specified by the parameters.
`GET https://www.apizie.tech/v1/cloud:azure-arm-botservice/channels-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| channelName | string | yes | The name of the Bot resource. |
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |

### Creates a Channel registration for a Bot Service
`POST https://www.apizie.tech/v1/cloud:azure-arm-botservice/channels-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| channelName | string | yes | The name of the Channel resource. |
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |
| body | object | yes | JSON request body |

### Updates a Channel registration for a Bot Service
`POST https://www.apizie.tech/v1/cloud:azure-arm-botservice/channels-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| channelName | string | yes | The name of the Channel resource. |
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |
| body | object | yes | JSON request body |

### Deletes a Channel registration from a Bot Service
`POST https://www.apizie.tech/v1/cloud:azure-arm-botservice/channels-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| channelName | string | yes | The name of the Bot resource. |
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |

### Lists a Channel registration for a Bot Service including secrets
`POST https://www.apizie.tech/v1/cloud:azure-arm-botservice/channels-list-with-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| channelName | string | yes | The name of the Channel resource. |
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |

### Returns all the Channel registrations of a particular BotService resource
`GET https://www.apizie.tech/v1/cloud:azure-arm-botservice/channels-list-by-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| subscriptionId | string | yes | Azure Subscription ID. |
| api-version | string | no | Version of the API to be used with the client request. |

### Regenerates secret keys and returns them for the DirectLine Channel of a particular BotService resource
`POST https://www.apizie.tech/v1/cloud:azure-arm-botservice/direct-line-regenerate-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| subscriptionId | string | yes | Azure Subscription ID. |
| channelName | string | yes | The name of the Channel resource for which keys are to be regenerated. |
| api-version | string | no | Version of the API to be used with the client request. |
| body | object | yes | JSON request body |

### Creates an email channel sign in url for a Bot Service
`POST https://www.apizie.tech/v1/cloud:azure-arm-botservice/email-create-sign-in-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |

### Check whether a bot name is available.
`POST https://www.apizie.tech/v1/cloud:azure-arm-botservice/bots-get-check-name-availability` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | Version of the API to be used with the client request. |
| body | object | yes | JSON request body |

### Lists all the available BotService operations.
`GET https://www.apizie.tech/v1/cloud:azure-arm-botservice/operations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | Version of the API to be used with the client request. |

### Lists the available Service Providers for creating Connection Settings
`POST https://www.apizie.tech/v1/cloud:azure-arm-botservice/bot-connection-list-service-providers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |

### Lists the QnA Maker endpoint keys
`POST https://www.apizie.tech/v1/cloud:azure-arm-botservice/qn-amaker-endpoint-keys-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |
| body | object | yes | JSON request body |

### Get a Connection Setting registration for a Bot Service
`POST https://www.apizie.tech/v1/cloud:azure-arm-botservice/bot-connection-list-with-secrets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| connectionName | string | yes | The name of the Bot Service Connection Setting resource. |
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |

### Get a Connection Setting registration for a Bot Service
`GET https://www.apizie.tech/v1/cloud:azure-arm-botservice/bot-connection-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| connectionName | string | yes | The name of the Bot Service Connection Setting resource. |
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |

### Register a new Auth Connection for a Bot Service
`POST https://www.apizie.tech/v1/cloud:azure-arm-botservice/bot-connection-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| connectionName | string | yes | The name of the Bot Service Connection Setting resource. |
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |
| body | object | yes | JSON request body |

### Updates a Connection Setting registration for a Bot Service
`POST https://www.apizie.tech/v1/cloud:azure-arm-botservice/bot-connection-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| connectionName | string | yes | The name of the Bot Service Connection Setting resource. |
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |
| body | object | yes | JSON request body |

### Deletes a Connection Setting registration for a Bot Service
`POST https://www.apizie.tech/v1/cloud:azure-arm-botservice/bot-connection-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| connectionName | string | yes | The name of the Bot Service Connection Setting resource. |
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |

### Returns all the Connection Settings registered to a particular BotService resource
`GET https://www.apizie.tech/v1/cloud:azure-arm-botservice/bot-connection-list-by-bot-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| subscriptionId | string | yes | Azure Subscription ID. |
| api-version | string | no | Version of the API to be used with the client request. |

### Get per subscription settings needed to host bot in compute resource such as Azure App Service
`GET https://www.apizie.tech/v1/cloud:azure-arm-botservice/host-settings-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |

### Get the operation result for a long running operation.
`GET https://www.apizie.tech/v1/cloud:azure-arm-botservice/operation-results-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |
| operationResultId | string | yes | The ID of the operation result to get. |

### List all the private endpoint connections associated with the Bot.
`GET https://www.apizie.tech/v1/cloud:azure-arm-botservice/private-endpoint-connections-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |

### Gets the specified private endpoint connection associated with the Bot.
`GET https://www.apizie.tech/v1/cloud:azure-arm-botservice/private-endpoint-connections-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |
| privateEndpointConnectionName | string | yes | The name of the private endpoint connection associated with the Azure resource |

### Update the state of specified private endpoint connection associated with the Bot.
`POST https://www.apizie.tech/v1/cloud:azure-arm-botservice/private-endpoint-connections-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |
| privateEndpointConnectionName | string | yes | The name of the private endpoint connection associated with the Azure resource |
| body | object | yes | JSON request body |

### Deletes the specified private endpoint connection associated with the Bot.
`POST https://www.apizie.tech/v1/cloud:azure-arm-botservice/private-endpoint-connections-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |
| privateEndpointConnectionName | string | yes | The name of the private endpoint connection associated with the Azure resource |

### Gets the private link resources that need to be created for a Bot.
`GET https://www.apizie.tech/v1/cloud:azure-arm-botservice/private-link-resources-list-by-bot-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceGroupName | string | yes | The name of the Bot resource group in the user subscription. |
| resourceName | string | yes | The name of the Bot resource. |
| api-version | string | no | Version of the API to be used with the client request. |
| subscriptionId | string | yes | Azure Subscription ID. |

## Example
```
curl "https://www.apizie.tech/v1/cloud:azure-arm-botservice/bots-get" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Azure Bot management API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/cloud:azure-arm-botservice/bots-get with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Azure Bot management API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Azure Bot management itself also needs your own key from azure.com.

### Can AI agents use the Azure Bot management API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:azure-arm-botservice.

### What is the status of the Azure Bot management API?
Needs your own provider key (bring your own key)