Notatka
Dostęp do tej strony wymaga autoryzacji. Może spróbować zalogować się lub zmienić katalogi.
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować zmienić katalogi.
Definicja zasobu Bicep
Typ zasobu botServices można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Przykłady użycia
Przykłady Bicep
Podstawowy przykład wdrażania usługi Azure Bot Service.
param resourceName string = 'acctest0001'
param location string = 'westeurope'
param clientId string
resource botService 'Microsoft.BotService/botServices@2021-05-01-preview' = {
name: resourceName
location: 'global'
sku: {
name: 'F0'
}
kind: 'sdk'
properties: {
developerAppInsightKey: ''
developerAppInsightsApiKey: ''
developerAppInsightsApplicationId: ''
displayName: resourceName
endpoint: ''
luisAppIds: []
luisKey: ''
msaAppId: clientId
}
tags: {
environment: 'production'
}
}
Format zasobu
Aby utworzyć zasób Microsoft.BotService/botServices, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.BotService/botServices@2023-09-15-preview' = {
etag: 'string'
kind: 'string'
location: 'string'
name: 'string'
properties: {
allSettings: {
{customized property}: 'string'
}
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: {
{customized property}: 'string'
}
publicNetworkAccess: 'string'
publishingCredentials: 'string'
schemaTransformationVersion: 'string'
storageResourceId: 'string'
tenantId: 'string'
}
sku: {
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Wartości właściwości
Microsoft.BotService/botServices
| Name | Description | Value |
|---|---|---|
| etag | Tag jednostki. | ciąg |
| kind | Required. Pobiera lub ustawia rodzaj zasobu. | 'azurebot' 'bot' 'designer' 'function' 'sdk' |
| lokalizacja | Określa lokalizację zasobu. | ciąg |
| name | Nazwa zasobu | string Constraints: Minimalna długość = 2 Maksymalna długość = 64 Wzorzec = ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ (wymagane) |
| properties | Zestaw właściwości specyficznych dla zasobu bota | BotProperties |
| sku | Pobiera lub ustawia jednostkę SKU zasobu. | Sku |
| tags | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
BotProperties
| Name | Description | Value |
|---|---|---|
| allSettings | Zawiera wszystkie ustawienia zasobu zdefiniowane jako pary klucz/wartość. | BotPropertiesAllSettings |
| appPasswordHint | Wskazówka (np. keyVault secret resourceId) dotycząca pobierania wpisu tajnego aplikacji | ciąg |
| cmekKeyVaultUrl | Adres URL klucza zarządzanego przez klienta | ciąg |
| description | Opis bota | ciąg |
| developerAppInsightKey | Klucz usługi Application Insights | ciąg |
| developerAppInsightsApiKey | Klucz interfejsu API usługi Application Insights | ciąg |
| developerAppInsightsApplicationId | Identyfikator aplikacji usługi Application Insights | ciąg |
| disableLocalAuth | Rezygnacja z uwierzytelniania lokalnego i upewnienie się, że do uwierzytelniania można używać tylko tożsamości usługi zarządzanej i usługi AAD. | bool |
| displayName | Nazwa bota | ciąg (wymagany) |
| punkt końcowy | Punkt końcowy bota | ciąg (wymagany) |
| iconUrl | Adres URL ikony bota | ciąg |
| isCmekEnabled | Czy cmek jest włączony | bool |
| isStreamingSupported | Czy bot jest obsługiwany do przesyłania strumieniowego | bool |
| luisAppIds | Kolekcja identyfikatorów aplikacji usługi LUIS | string[] |
| luisKey | Klucz usługi LUIS | ciąg |
| manifestUrl | Adres URL manifestu bota | ciąg |
| msaAppId | Identyfikator aplikacji firmy Microsoft dla bota | ciąg (wymagany) |
| msaAppMSIResourceId | Identyfikator zasobu tożsamości zarządzanej aplikacji firmy Microsoft dla bota | ciąg |
| msaAppTenantId | Identyfikator dzierżawy aplikacji firmy Microsoft dla bota | ciąg |
| msaAppType | Typ aplikacji firmy Microsoft dla bota | 'MultiTenant' 'SingleTenant' 'UserAssignedMSI' |
| openWithHint | Wskazówka dotycząca przeglądarki (np. obsługi protokołów) na temat otwierania bota na potrzeby tworzenia | ciąg |
| parameters | Zawiera parametry zasobu zdefiniowane jako pary klucz/wartość. | BotPropertiesParameters |
| publicNetworkAccess | Czy bot znajduje się w izolowanej sieci | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
| publishingCredentials | Publikowanie poświadczeń zasobu | ciąg |
| schemaTransformationVersion | Wersja przekształcenia schematu kanału dla bota | ciąg |
| storageResourceId | Identyfikator zasobu magazynu bota | ciąg |
| tenantId | Identyfikator dzierżawy bota | ciąg |
BotPropertiesAllSettings
| Name | Description | Value |
|---|
BotPropertiesParameters
| Name | Description | Value |
|---|
BotTagi
| Name | Description | Value |
|---|
Sku
| Name | Description | Value |
|---|---|---|
| name | Nazwa jednostki SKU | 'F0' "S1" (wymagane) |
Definicja zasobu szablonu usługi ARM
Typ zasobu botServices można wdrożyć przy użyciu operacji docelowych:
- Grupy zasobów – Zobacz polecenia wdrożenia grup zasobów Aby uzyskać listę zmienionych właściwości w każdej wersji API, zobacz log zmian.
Przykłady użycia
Format zasobu
Aby utworzyć zasób Microsoft.BotService/botServices, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.BotService/botServices",
"apiVersion": "2023-09-15-preview",
"name": "string",
"etag": "string",
"kind": "string",
"location": "string",
"properties": {
"allSettings": {
"{customized property}": "string"
},
"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": {
"{customized property}": "string"
},
"publicNetworkAccess": "string",
"publishingCredentials": "string",
"schemaTransformationVersion": "string",
"storageResourceId": "string",
"tenantId": "string"
},
"sku": {
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Wartości właściwości
Microsoft.BotService/botServices
| Name | Description | Value |
|---|---|---|
| apiVersion | Wersja interfejsu API | '2023-09-15-preview' |
| etag | Tag jednostki. | ciąg |
| kind | Required. Pobiera lub ustawia rodzaj zasobu. | 'azurebot' 'bot' 'designer' 'function' 'sdk' |
| lokalizacja | Określa lokalizację zasobu. | ciąg |
| name | Nazwa zasobu | string Constraints: Minimalna długość = 2 Maksymalna długość = 64 Wzorzec = ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ (wymagane) |
| properties | Zestaw właściwości specyficznych dla zasobu bota | BotProperties |
| sku | Pobiera lub ustawia jednostkę SKU zasobu. | Sku |
| tags | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
| typ | Typ zasobu | 'Microsoft.BotService/botServices' |
BotProperties
| Name | Description | Value |
|---|---|---|
| allSettings | Zawiera wszystkie ustawienia zasobu zdefiniowane jako pary klucz/wartość. | BotPropertiesAllSettings |
| appPasswordHint | Wskazówka (np. keyVault secret resourceId) dotycząca pobierania wpisu tajnego aplikacji | ciąg |
| cmekKeyVaultUrl | Adres URL klucza zarządzanego przez klienta | ciąg |
| description | Opis bota | ciąg |
| developerAppInsightKey | Klucz usługi Application Insights | ciąg |
| developerAppInsightsApiKey | Klucz interfejsu API usługi Application Insights | ciąg |
| developerAppInsightsApplicationId | Identyfikator aplikacji usługi Application Insights | ciąg |
| disableLocalAuth | Rezygnacja z uwierzytelniania lokalnego i upewnienie się, że do uwierzytelniania można używać tylko tożsamości usługi zarządzanej i usługi AAD. | bool |
| displayName | Nazwa bota | ciąg (wymagany) |
| punkt końcowy | Punkt końcowy bota | ciąg (wymagany) |
| iconUrl | Adres URL ikony bota | ciąg |
| isCmekEnabled | Czy cmek jest włączony | bool |
| isStreamingSupported | Czy bot jest obsługiwany do przesyłania strumieniowego | bool |
| luisAppIds | Kolekcja identyfikatorów aplikacji usługi LUIS | string[] |
| luisKey | Klucz usługi LUIS | ciąg |
| manifestUrl | Adres URL manifestu bota | ciąg |
| msaAppId | Identyfikator aplikacji firmy Microsoft dla bota | ciąg (wymagany) |
| msaAppMSIResourceId | Identyfikator zasobu tożsamości zarządzanej aplikacji firmy Microsoft dla bota | ciąg |
| msaAppTenantId | Identyfikator dzierżawy aplikacji firmy Microsoft dla bota | ciąg |
| msaAppType | Typ aplikacji firmy Microsoft dla bota | 'MultiTenant' 'SingleTenant' 'UserAssignedMSI' |
| openWithHint | Wskazówka dotycząca przeglądarki (np. obsługi protokołów) na temat otwierania bota na potrzeby tworzenia | ciąg |
| parameters | Zawiera parametry zasobu zdefiniowane jako pary klucz/wartość. | BotPropertiesParameters |
| publicNetworkAccess | Czy bot znajduje się w izolowanej sieci | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
| publishingCredentials | Publikowanie poświadczeń zasobu | ciąg |
| schemaTransformationVersion | Wersja przekształcenia schematu kanału dla bota | ciąg |
| storageResourceId | Identyfikator zasobu magazynu bota | ciąg |
| tenantId | Identyfikator dzierżawy bota | ciąg |
BotPropertiesAllSettings
| Name | Description | Value |
|---|
BotPropertiesParameters
| Name | Description | Value |
|---|
BotTagi
| Name | Description | Value |
|---|
Sku
| Name | Description | Value |
|---|---|---|
| name | Nazwa jednostki SKU | 'F0' "S1" (wymagane) |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu botServices można wdrożyć przy użyciu operacji docelowych:
- Grupy zasobów Listę zmienionych właściwości w każdej wersji API można znaleźć w dzienniku zmian.
Przykłady użycia
Przykłady programu Terraform
Podstawowy przykład wdrażania usługi Azure Bot Service.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
azurerm = {
source = "hashicorp/azurerm"
}
}
}
provider "azurerm" {
features {
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
data "azurerm_client_config" "current" {
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "botService" {
type = "Microsoft.BotService/botServices@2021-05-01-preview"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = "global"
body = {
kind = "sdk"
properties = {
developerAppInsightKey = ""
developerAppInsightsApiKey = ""
developerAppInsightsApplicationId = ""
displayName = var.resource_name
endpoint = ""
luisAppIds = [
]
luisKey = ""
msaAppId = data.azurerm_client_config.current.client_id
}
sku = {
name = "F0"
}
tags = {
environment = "production"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Moduły zweryfikowane na platformie Azure
Następujące moduły zweryfikowane platformy Azure mogą służyć do wdrażania tego typu zasobu.
| Module | Description |
|---|---|
| Usługa botów | AVM Resource Module for Bot Service |
Format zasobu
Aby utworzyć zasób Microsoft.BotService/botServices, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.BotService/botServices@2023-09-15-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
etag = "string"
kind = "string"
properties = {
allSettings = {
{customized property} = "string"
}
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 = {
{customized property} = "string"
}
publicNetworkAccess = "string"
publishingCredentials = "string"
schemaTransformationVersion = "string"
storageResourceId = "string"
tenantId = "string"
}
sku = {
name = "string"
}
}
}
Wartości właściwości
Microsoft.BotService/botServices
| Name | Description | Value |
|---|---|---|
| etag | Tag jednostki. | ciąg |
| kind | Required. Pobiera lub ustawia rodzaj zasobu. | 'azurebot' 'bot' 'designer' 'function' 'sdk' |
| lokalizacja | Określa lokalizację zasobu. | ciąg |
| name | Nazwa zasobu | string Constraints: Minimalna długość = 2 Maksymalna długość = 64 Wzorzec = ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ (wymagane) |
| properties | Zestaw właściwości specyficznych dla zasobu bota | BotProperties |
| sku | Pobiera lub ustawia jednostkę SKU zasobu. | Sku |
| tags | Tagi zasobów | Słownik nazw tagów i wartości. |
| typ | Typ zasobu | "Microsoft.BotService/botServices@2023-09-15-preview" |
BotProperties
| Name | Description | Value |
|---|---|---|
| allSettings | Zawiera wszystkie ustawienia zasobu zdefiniowane jako pary klucz/wartość. | BotPropertiesAllSettings |
| appPasswordHint | Wskazówka (np. keyVault secret resourceId) dotycząca pobierania wpisu tajnego aplikacji | ciąg |
| cmekKeyVaultUrl | Adres URL klucza zarządzanego przez klienta | ciąg |
| description | Opis bota | ciąg |
| developerAppInsightKey | Klucz usługi Application Insights | ciąg |
| developerAppInsightsApiKey | Klucz interfejsu API usługi Application Insights | ciąg |
| developerAppInsightsApplicationId | Identyfikator aplikacji usługi Application Insights | ciąg |
| disableLocalAuth | Rezygnacja z uwierzytelniania lokalnego i upewnienie się, że do uwierzytelniania można używać tylko tożsamości usługi zarządzanej i usługi AAD. | bool |
| displayName | Nazwa bota | ciąg (wymagany) |
| punkt końcowy | Punkt końcowy bota | ciąg (wymagany) |
| iconUrl | Adres URL ikony bota | ciąg |
| isCmekEnabled | Czy cmek jest włączony | bool |
| isStreamingSupported | Czy bot jest obsługiwany do przesyłania strumieniowego | bool |
| luisAppIds | Kolekcja identyfikatorów aplikacji usługi LUIS | string[] |
| luisKey | Klucz usługi LUIS | ciąg |
| manifestUrl | Adres URL manifestu bota | ciąg |
| msaAppId | Identyfikator aplikacji firmy Microsoft dla bota | ciąg (wymagany) |
| msaAppMSIResourceId | Identyfikator zasobu tożsamości zarządzanej aplikacji firmy Microsoft dla bota | ciąg |
| msaAppTenantId | Identyfikator dzierżawy aplikacji firmy Microsoft dla bota | ciąg |
| msaAppType | Typ aplikacji firmy Microsoft dla bota | 'MultiTenant' 'SingleTenant' 'UserAssignedMSI' |
| openWithHint | Wskazówka dotycząca przeglądarki (np. obsługi protokołów) na temat otwierania bota na potrzeby tworzenia | ciąg |
| parameters | Zawiera parametry zasobu zdefiniowane jako pary klucz/wartość. | BotPropertiesParameters |
| publicNetworkAccess | Czy bot znajduje się w izolowanej sieci | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
| publishingCredentials | Publikowanie poświadczeń zasobu | ciąg |
| schemaTransformationVersion | Wersja przekształcenia schematu kanału dla bota | ciąg |
| storageResourceId | Identyfikator zasobu magazynu bota | ciąg |
| tenantId | Identyfikator dzierżawy bota | ciąg |
BotPropertiesAllSettings
| Name | Description | Value |
|---|
BotPropertiesParameters
| Name | Description | Value |
|---|
BotTagi
| Name | Description | Value |
|---|
Sku
| Name | Description | Value |
|---|---|---|
| name | Nazwa jednostki SKU | 'F0' "S1" (wymagane) |