BotServices Microsoft.BotServices 2022-09-15

Artigo
04/14/2023

Definição de recurso do Bicep

O tipo de recurso botServices pode ser implementado com operações que visam:

Grupos de recursos – veja os comandos de implementação do grupo de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.BotService/botServices, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.BotService/botServices@2022-09-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  kind: 'string'
  etag: 'string'
  properties: {
    allSettings: {}
    appPasswordHint: 'string'
    cmekKeyVaultUrl: 'string'
    description: 'string'
    developerAppInsightKey: 'string'
    developerAppInsightsApiKey: 'string'
    developerAppInsightsApplicationId: 'string'
    disableLocalAuth: bool
    displayName: 'string'
    endpoint: 'string'
    iconUrl: 'string'
    isCmekEnabled: bool
    isStreamingSupported: bool
    luisAppIds: [
      'string'
    ]
    luisKey: 'string'
    manifestUrl: 'string'
    msaAppId: 'string'
    msaAppMSIResourceId: 'string'
    msaAppTenantId: 'string'
    msaAppType: 'string'
    openWithHint: 'string'
    parameters: {}
    publicNetworkAccess: 'string'
    publishingCredentials: 'string'
    schemaTransformationVersion: 'string'
    storageResourceId: 'string'
    tenantId: 'string'
  }
}

Valores de propriedade

botServices

Nome	Descrição	Valor
name	O nome do recurso	cadeia (obrigatório) Limite de carateres: 2-64 Carateres válidos: Alfanuméricos, carateres de sublinhado, períodos e hífenes. Comece com alfanumérico. O nome do recurso tem de ser exclusivo em todo o Azure.
localização	Especifica a localização do recurso.	string
etiquetas	Contém etiquetas de recursos definidas como pares chave/valor.	Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
sku	Obtém ou define o SKU do recurso.	Sku
tipo	Obrigatório. Obtém ou define o Tipo do recurso.	"azurebot" 'bot' 'designer' "função" 'sdk'
etag	Etiqueta de Entidade	string
propriedades	O conjunto de propriedades específicas do recurso do bot	BotProperties

BotProperties

Nome	Descrição	Valor
allSettings	Contém todas as definições de recursos definidas como pares chave/valor.	objeto
appPasswordHint	A sugestão (por exemplo, keyVault secret resourceId) sobre como obter o segredo da aplicação	string
cmekKeyVaultUrl	O URL da CMK	string
descrição	A descrição do bot	string
developerAppInsightKey	A chave do Application Insights	string
developerAppInsightsApiKey	A Chave de API do Application Insights	string
developerAppInsightsApplicationId	O ID da Aplicação do Application Insights	string
disableLocalAuth	Opte ativamente por não participar na autenticação local e garanta que apenas o MSI e o AAD podem ser utilizados exclusivamente para autenticação.	bool
displayName	O Nome do bot	cadeia (obrigatório)
endpoint	O ponto final do bot	cadeia (obrigatório)
iconUrl	O URL do Ícone do bot	string
isCmekEnabled	Se o Cmek está ativado	bool
isStreamingSupported	Se o bot é suportado para transmissão em fluxo	bool
luisAppIds	Coleção de IDs da Aplicação LUIS	string[]
luisKey	A Chave LUIS	string
manifestUrl	O URL de manifesto do bot	string
msaAppId	ID da Aplicação Microsoft para o bot	cadeia (obrigatório)
msaAppMSIResourceId	ID do Recurso de Identidade Gerida da Aplicação Microsoft para o bot	string
msaAppTenantId	ID do Inquilino da Aplicação Microsoft para o bot	string
msaAppType	Tipo de Aplicação Microsoft para o bot	"MultiTenant" "SingleTenant" "UserAssignedMSI"
openWithHint	A sugestão para o browser (por exemplo, processador de protocolos) sobre como abrir o bot para criação	string
parâmetros	Contém parâmetros de recursos definidos como pares chave/valor.	objeto
publicNetworkAccess	Se o bot está numa rede isolada	"Desativado" "Ativado"
publishingCredentials	Publicar credenciais do recurso	string
schemaTransformationVersion	A versão de transformação do esquema do canal para o bot	string
storageResourceId	O resourceId de armazenamento do bot	string
tenantId	O ID do Inquilino do bot	string

Sku

Nome	Descrição	Valor
name	O nome do SKU	'F0' "S1" (obrigatório)

Definição de recurso do modelo arm

O tipo de recurso botServices pode ser implementado com operações que visam:

Grupos de recursos – veja os comandos de implementação do grupo de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.BotService/botServices, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.BotService/botServices",
  "apiVersion": "2022-09-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "kind": "string",
  "etag": "string",
  "properties": {
    "allSettings": {},
    "appPasswordHint": "string",
    "cmekKeyVaultUrl": "string",
    "description": "string",
    "developerAppInsightKey": "string",
    "developerAppInsightsApiKey": "string",
    "developerAppInsightsApplicationId": "string",
    "disableLocalAuth": "bool",
    "displayName": "string",
    "endpoint": "string",
    "iconUrl": "string",
    "isCmekEnabled": "bool",
    "isStreamingSupported": "bool",
    "luisAppIds": [ "string" ],
    "luisKey": "string",
    "manifestUrl": "string",
    "msaAppId": "string",
    "msaAppMSIResourceId": "string",
    "msaAppTenantId": "string",
    "msaAppType": "string",
    "openWithHint": "string",
    "parameters": {},
    "publicNetworkAccess": "string",
    "publishingCredentials": "string",
    "schemaTransformationVersion": "string",
    "storageResourceId": "string",
    "tenantId": "string"
  }
}

Valores de propriedade

botServices

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.BotService/botServices"
apiVersion	A versão da API de recursos	'2022-09-15'
name	O nome do recurso	cadeia (obrigatório) Limite de carateres: 2-64 Carateres válidos: Alfanuméricos, carateres de sublinhado, períodos e hífenes. Comece com alfanumérico. O nome do recurso tem de ser exclusivo em todo o Azure.
localização	Especifica a localização do recurso.	string
etiquetas	Contém etiquetas de recursos definidas como pares chave/valor.	Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
sku	Obtém ou define o SKU do recurso.	Sku
tipo	Obrigatório. Obtém ou define o Tipo do recurso.	"azurebot" 'bot' 'designer' "função" 'sdk'
etag	Etiqueta de Entidade	string
propriedades	O conjunto de propriedades específicas do recurso do bot	BotProperties

BotProperties

Nome	Descrição	Valor
allSettings	Contém todas as definições de recursos definidas como pares chave/valor.	objeto
appPasswordHint	A sugestão (por exemplo, keyVault secret resourceId) sobre como obter o segredo da aplicação	string
cmekKeyVaultUrl	O URL da CMK	string
descrição	A descrição do bot	string
developerAppInsightKey	A chave do Application Insights	string
developerAppInsightsApiKey	A Chave de API do Application Insights	string
developerAppInsightsApplicationId	O ID da Aplicação do Application Insights	string
disableLocalAuth	Opte ativamente por não participar na autenticação local e garanta que apenas o MSI e o AAD podem ser utilizados exclusivamente para autenticação.	bool
displayName	O Nome do bot	cadeia (obrigatório)
endpoint	O ponto final do bot	cadeia (obrigatório)
iconUrl	O URL do Ícone do bot	string
isCmekEnabled	Se o Cmek está ativado	bool
isStreamingSupported	Se o bot é suportado para transmissão em fluxo	bool
luisAppIds	Coleção de IDs da Aplicação LUIS	string[]
luisKey	A Chave LUIS	string
manifestUrl	O URL de manifesto do bot	string
msaAppId	ID da Aplicação Microsoft para o bot	cadeia (obrigatório)
msaAppMSIResourceId	ID do Recurso de Identidade Gerida da Aplicação Microsoft para o bot	string
msaAppTenantId	ID do Inquilino da Aplicação Microsoft para o bot	string
msaAppType	Tipo de Aplicação Microsoft para o bot	"MultiTenant" "SingleTenant" "UserAssignedMSI"
openWithHint	A sugestão para o browser (por exemplo, processador de protocolos) sobre como abrir o bot para criação	string
parâmetros	Contém parâmetros de recursos definidos como pares chave/valor.	objeto
publicNetworkAccess	Se o bot está numa rede isolada	"Desativado" "Ativado"
publishingCredentials	Publicar credenciais do recurso	string
schemaTransformationVersion	A versão de transformação do esquema do canal para o bot	string
storageResourceId	O resourceId de armazenamento do bot	string
tenantId	O ID do Inquilino do bot	string

Sku

Nome	Descrição	Valor
name	O nome do SKU	'F0' "S1" (obrigatório)

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso botServices pode ser implementado com operações que visam:

Grupos de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.BotService/botServices, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.BotService/botServices@2022-09-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      allSettings = {}
      appPasswordHint = "string"
      cmekKeyVaultUrl = "string"
      description = "string"
      developerAppInsightKey = "string"
      developerAppInsightsApiKey = "string"
      developerAppInsightsApplicationId = "string"
      disableLocalAuth = bool
      displayName = "string"
      endpoint = "string"
      iconUrl = "string"
      isCmekEnabled = bool
      isStreamingSupported = bool
      luisAppIds = [
        "string"
      ]
      luisKey = "string"
      manifestUrl = "string"
      msaAppId = "string"
      msaAppMSIResourceId = "string"
      msaAppTenantId = "string"
      msaAppType = "string"
      openWithHint = "string"
      parameters = {}
      publicNetworkAccess = "string"
      publishingCredentials = "string"
      schemaTransformationVersion = "string"
      storageResourceId = "string"
      tenantId = "string"
    }
    sku = {
      name = "string"
    }
    kind = "string"
    etag = "string"
  })
}

Valores de propriedade

botServices

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.BotService/botServices@2022-09-15"
name	O nome do recurso	cadeia (obrigatório) Limite de carateres: 2-64 Carateres válidos: Alfanuméricos, carateres de sublinhado, períodos e hífenes. Comece com alfanumérico. O nome do recurso tem de ser exclusivo em todo o Azure.
localização	Especifica a localização do recurso.	string
parent_id	Para implementar num grupo de recursos, utilize o ID desse grupo de recursos.	cadeia (obrigatório)
etiquetas	Contém etiquetas de recursos definidas como pares chave/valor.	Dicionário de nomes e valores de etiquetas.
sku	Obtém ou define o SKU do recurso.	Sku
tipo	Obrigatório. Obtém ou define o Tipo do recurso.	"azurebot" "bot" "designer" "função" "sdk"
etag	Etiqueta de Entidade	string
propriedades	O conjunto de propriedades específicas do recurso do bot	BotProperties

BotProperties

Nome	Descrição	Valor
allSettings	Contém todas as definições de recursos definidas como pares chave/valor.	objeto
appPasswordHint	A sugestão (por exemplo, keyVault secret resourceId) sobre como obter o segredo da aplicação	string
cmekKeyVaultUrl	O URL da CMK	string
descrição	A descrição do bot	string
developerAppInsightKey	A chave do Application Insights	string
developerAppInsightsApiKey	A Chave da API do Application Insights	string
developerAppInsightsApplicationId	O ID da Aplicação do Application Insights	string
disableLocalAuth	Opte ativamente por não participar na autenticação local e certifique-se de que apenas o MSI e o AAD podem ser utilizados exclusivamente para autenticação.	bool
displayName	O Nome do bot	cadeia (obrigatório)
endpoint	O ponto final do bot	cadeia (obrigatório)
iconUrl	O Url do Ícone do bot	string
isCmekEnabled	Se o Cmek está ativado	bool
isStreamingSupported	Se o bot é suportado pela transmissão em fluxo	bool
luisAppIds	Coleção de IDs da Aplicação LUIS	cadeia[]
luisKey	A Chave LUIS	string
manifestUrl	O URL de manifesto do bot	string
msaAppId	ID da Aplicação Microsoft para o bot	cadeia (obrigatório)
msaAppMSIResourceId	ID do Recurso de Identidade Gerida da Aplicação Microsoft para o bot	string
msaAppTenantId	ID do Inquilino da Aplicação Microsoft para o bot	string
msaAppType	Tipo de Aplicação Microsoft para o bot	"MultiTenant" "SingleTenant" "UserAssignedMSI"
openWithHint	A sugestão para o browser (por exemplo, processador de protocolos) sobre como abrir o bot para criação	string
parâmetros	Contém parâmetros de recursos definidos como pares chave/valor.	objeto
publicNetworkAccess	Se o bot está numa rede isolada	"Desativado" "Ativado"
publishingCredentials	Publicar credenciais do recurso	string
schemaTransformationVersion	A versão de transformação do esquema de canal para o bot	string
storageResourceId	O resourceId de armazenamento do bot	string
tenantId	O ID do Inquilino do bot	string

Sku

Nome	Descrição	Valor
name	O nome do sku	"F0" "S1" (obrigatório)

BotServices Microsoft.BotServices 2022-09-15

Definição de recurso do Bicep

Formato do recurso

Valores de propriedade

botServices

BotProperties

Sku

Definição de recurso do modelo arm

Formato do recurso

Valores de propriedade

botServices

BotProperties

Sku

Definição de recurso terraform (fornecedor AzAPI)

Formato do recurso

Valores de propriedade

botServices

BotProperties

Sku

Recursos adicionais

Recursos adicionais