Delen via


Microsoft.BotService botServices/channels

Bicep-resourcedefinitie

Het resourcetype botServices/kanalen kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource Microsoft.BotService/botServices/channels wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.BotService/botServices/channels@2022-09-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  kind: 'string'
  parent: resourceSymbolicName
  etag: 'string'
  properties: {
    etag: 'string'
    location: 'string'
    channelName: 'string'
    // For remaining properties, see Channel objects
  }
}

Kanaalobjecten

Stel de eigenschap channelName in om het type object op te geven.

Gebruik voor AcsChatChannel:

  channelName: 'AcsChatChannel'

Gebruik voor AlexaChannel:

  channelName: 'AlexaChannel'
  properties: {
    alexaSkillId: 'string'
    isEnabled: bool
  }

Gebruik voor DirectLineChannel:

  channelName: 'DirectLineChannel'
  properties: {
    DirectLineEmbedCode: 'string'
    extensionKey1: 'string'
    extensionKey2: 'string'
    sites: [
      {
        appId: 'string'
        eTag: 'string'
        isBlockUserUploadEnabled: bool
        isDetailedLoggingEnabled: bool
        isEnabled: bool
        isEndpointParametersEnabled: bool
        isNoStorageEnabled: bool
        isSecureSiteEnabled: bool
        isV1Enabled: bool
        isV3Enabled: bool
        isWebchatPreviewEnabled: bool
        isWebChatSpeechEnabled: bool
        siteName: 'string'
        tenantId: 'string'
        trustedOrigins: [
          'string'
        ]
      }
    ]
  }

Voor DirectLineSpeechChannel gebruikt u:

  channelName: 'DirectLineSpeechChannel'
  properties: {
    cognitiveServiceRegion: 'string'
    cognitiveServiceResourceId: 'string'
    cognitiveServiceSubscriptionKey: 'string'
    customSpeechModelId: 'string'
    customVoiceDeploymentId: 'string'
    isDefaultBotForCogSvcAccount: bool
    isEnabled: bool
  }

Gebruik voor EmailChannel:

  channelName: 'EmailChannel'
  properties: {
    authMethod: int
    emailAddress: 'string'
    isEnabled: bool
    magicCode: 'string'
    password: 'string'
  }

Gebruik voor FacebookChannel:

  channelName: 'FacebookChannel'
  properties: {
    appId: 'string'
    appSecret: 'string'
    isEnabled: bool
    pages: [
      {
        accessToken: 'string'
        id: 'string'
      }
    ]
  }

Voor KikChannel gebruikt u:

  channelName: 'KikChannel'
  properties: {
    apiKey: 'string'
    isEnabled: bool
    isValidated: bool
    userName: 'string'
  }

Gebruik voor LineChannel:

  channelName: 'LineChannel'
  properties: {
    lineRegistrations: [
      {
        channelAccessToken: 'string'
        channelSecret: 'string'
      }
    ]
  }

Gebruik voor M365Extensions:

  channelName: 'M365Extensions'

Voor MsTeamsChannel gebruikt u:

  channelName: 'MsTeamsChannel'
  properties: {
    acceptedTerms: bool
    callingWebhook: 'string'
    deploymentEnvironment: 'string'
    enableCalling: bool
    incomingCallRoute: 'string'
    isEnabled: bool
  }

Gebruik voor Omnichannel:

  channelName: 'Omnichannel'

Gebruik voor OutlookChannel:

  channelName: 'OutlookChannel'

Gebruik voor SearchAssistant:

  channelName: 'SearchAssistant'

Gebruik voor SkypeChannel:

  channelName: 'SkypeChannel'
  properties: {
    callingWebHook: 'string'
    enableCalling: bool
    enableGroups: bool
    enableMediaCards: bool
    enableMessaging: bool
    enableScreenSharing: bool
    enableVideo: bool
    groupsMode: 'string'
    incomingCallRoute: 'string'
    isEnabled: bool
  }

Gebruik voor SlackChannel:

  channelName: 'SlackChannel'
  properties: {
    clientId: 'string'
    clientSecret: 'string'
    isEnabled: bool
    landingPageUrl: 'string'
    registerBeforeOAuthFlow: bool
    scopes: 'string'
    signingSecret: 'string'
    verificationToken: 'string'
  }

Voor SmsChannel gebruikt u:

  channelName: 'SmsChannel'
  properties: {
    accountSID: 'string'
    authToken: 'string'
    isEnabled: bool
    isValidated: bool
    phone: 'string'
  }

Gebruik voor TelegramChannel:

  channelName: 'TelegramChannel'
  properties: {
    accessToken: 'string'
    isEnabled: bool
    isValidated: bool
  }

Gebruik voor TelephonyChannel:

  channelName: 'TelephonyChannel'
  properties: {
    apiConfigurations: [
      {
        cognitiveServiceRegion: 'string'
        cognitiveServiceResourceId: 'string'
        cognitiveServiceSubscriptionKey: 'string'
        defaultLocale: 'string'
        id: 'string'
        providerName: 'string'
      }
    ]
    cognitiveServiceRegion: 'string'
    cognitiveServiceSubscriptionKey: 'string'
    defaultLocale: 'string'
    isEnabled: bool
    phoneNumbers: [
      {
        acsEndpoint: 'string'
        acsResourceId: 'string'
        acsSecret: 'string'
        cognitiveServiceRegion: 'string'
        cognitiveServiceResourceId: 'string'
        cognitiveServiceSubscriptionKey: 'string'
        defaultLocale: 'string'
        id: 'string'
        offerType: 'string'
        phoneNumber: 'string'
      }
    ]
    premiumSKU: 'string'
  }

Gebruik voor WebChatChannel:

  channelName: 'WebChatChannel'
  properties: {
    sites: [
      {
        appId: 'string'
        eTag: 'string'
        isBlockUserUploadEnabled: bool
        isDetailedLoggingEnabled: bool
        isEnabled: bool
        isEndpointParametersEnabled: bool
        isNoStorageEnabled: bool
        isSecureSiteEnabled: bool
        isV1Enabled: bool
        isV3Enabled: bool
        isWebchatPreviewEnabled: bool
        isWebChatSpeechEnabled: bool
        siteName: 'string'
        tenantId: 'string'
        trustedOrigins: [
          'string'
        ]
      }
    ]
  }

Eigenschapswaarden

botServices/kanalen

Naam Description Waarde
naam De resourcenaam

Meer informatie over het instellen van namen en typen voor onderliggende resources in Bicep.
tekenreeks (vereist)

Tekenlimiet: 2-64

Geldige tekens:
Alfanumerieken, onderstrepingstekens, punten en afbreekstreepjes.

Begin met alfanumeriek.
location Hiermee geeft u de locatie van de resource. tekenreeks
tags Bevat resourcetags die zijn gedefinieerd als sleutel-waardeparen. Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
sku Hiermee wordt de SKU van de resource opgehaald of ingesteld. SKU
Soort Vereist. Hiermee wordt het type resource opgehaald of ingesteld. 'azurebot'
'bot'
'ontwerper'
'functie'
'sdk'
Bovenliggende In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd.

Zie Onderliggende resource buiten bovenliggende resource voor meer informatie.
Symbolische naam voor resource van het type: botServices
etag Entiteitstag tekenreeks
properties De set eigenschappen die specifiek zijn voor botkanaalresources Kanaal

Kanaal

Naam Description Waarde
etag Entiteitstag van de resource tekenreeks
location Hiermee geeft u de locatie van de resource. tekenreeks
channelName Het objecttype instellen AcsChatChannel
AlexaChannel
DirectLineChannel
DirectLineSpeechChannel
EmailChannel
FacebookKanaal
KikChannel
LineChannel
M365Extensions
MsTeamsChannel
Omnichannel
OutlookChannel
SearchAssistant
SkypeKanaal
SlackChannel
SmsChannel
TelegramKanaal
Telefoniekanaal
WebChatChannel (vereist)

AcsChatChannel

Naam Description Waarde
channelName De kanaalnaam AcsChatChannel (vereist)

AlexaChannel

Naam Description Waarde
channelName De kanaalnaam 'AlexaChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor de resource van het Alexa-kanaal AlexaChannelProperties

AlexaChannelProperties

Naam Description Waarde
alexaSkillId De Alexa-vaardigheids-id tekenreeks (vereist)
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)

DirectLineChannel

Naam Description Waarde
channelName De kanaalnaam 'DirectLineChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor Direct Line kanaalresource DirectLineChannelProperties

DirectLineChannelProperties

Naam Description Waarde
DirectLineEmbedCode Direct Line insluitcode van de resource tekenreeks
extensionKey1 De extensionKey1 tekenreeks
extensionKey2 De extensionKey2 tekenreeks
sites De lijst met Direct Line sites DirectLineSite[]

DirectLineSite

Naam Description Waarde
appId DirectLine-toepassings-id tekenreeks
eTag Entiteitstag tekenreeks
isBlockUserUploadEnabled Of deze site is ingeschakeld voor het blokkeren van gebruikersuploads. booleaans
isDetailedLoggingEnabled Of deze site is uitgeschakeld voor gedetailleerde logboekregistratie voor booleaans
isEnabled Of deze site is ingeschakeld voor DirectLine-kanaal bool (vereist)
isEndpointParametersEnabled Of op deze site EndpointParameters is ingeschakeld voor kanaal booleaans
isNoStorageEnabled Of deze site zonder opslag is uitgeschakeld voor gedetailleerde logboekregistratie voor booleaans
isSecureSiteEnabled Of deze site is ingeschakeld voor verificatie met Bot Framework. booleaans
isV1Enabled Of deze site is ingeschakeld voor het Bot Framework V1-protocol. booleaans
isV3Enabled Of deze site is ingeschakeld voor het Bot Framework V3-protocol. booleaans
isWebchatPreviewEnabled Of deze site is ingeschakeld voor preview-versies van Webchat booleaans
isWebChatSpeechEnabled Of deze site is ingeschakeld voor Webchat Speech booleaans
siteName Sitenaam tekenreeks (vereist)
tenantId Tenant-id tekenreeks
trustedOrigins Lijst met VERTROUWDE OORSPRONG-URL's voor deze site. Dit veld is alleen van toepassing als isSecureSiteEnabled waar is. tekenreeks[]

DirectLineSpeechChannel

Naam Description Waarde
channelName De kanaalnaam 'DirectLineSpeechChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor de DirectLine Speech-kanaalresource DirectLineSpeechChannelEigenschappen

DirectLineSpeechChannelEigenschappen

Naam Description Waarde
cognitiveServiceRegion De cognitieve serviceregio met dit kanaalregistratie. tekenreeks
cognitiveServiceResourceId De cognitive service-id met dit kanaalregistratie. tekenreeks
cognitiveServiceSubscriptionKey De cognitive service-abonnementssleutel die moet worden gebruikt met deze kanaalregistratie. tekenreeks
customSpeechModelId Aangepaste spraakimplementatie-id (optioneel). tekenreeks
customVoiceDeploymentId Aangepaste spraakmodel-id (optioneel). tekenreeks
isDefaultBotForCogSvcAccount Maak hiervan een standaardbot voor het gekozen Cognitive Service-account. booleaans
isEnabled Of dit kanaal is ingeschakeld of niet. booleaans

EmailChannel

Naam Description Waarde
channelName De kanaalnaam 'EmailChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor e-mailkanaalresources EmailChannelProperties

EmailChannelProperties

Naam Description Waarde
authMethod Email methode voor kanaalverificatie. 0 Wachtwoord (standaard); 1 Grafiek. int
emailAddress Het e-mailadres tekenreeks (vereist)
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)
magicCode De magische code voor het instellen van de moderne verificatie. tekenreeks
wachtwoord Het wachtwoord voor het e-mailadres. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks

FacebookKanaal

Naam Description Waarde
channelName De kanaalnaam 'FacebookChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor het Facebook-kanaal van de bot FacebookChannelProperties

FacebookChannelProperties

Naam Description Waarde
appId Facebook-toepassings-id tekenreeks (vereist)
appSecret Facebook-toepassingsgeheim. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)
pagina's De lijst met Facebook-pagina's FacebookPage[]

FacebookPage

Naam Description Waarde
accessToken Toegangstoken voor Facebook-toepassing. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks
id Pagina-id tekenreeks (vereist)

KikChannel

Naam Description Waarde
channelName De kanaalnaam 'KikChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor kik-kanaalresource KikChannelProperties

KikChannelProperties

Naam Description Waarde
apiKey Kik API-sleutel. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)
isValidated Of dit kanaal is gevalideerd voor de bot booleaans
userName De Kik-gebruikersnaam tekenreeks (vereist)

LineChannel

Naam Description Waarde
channelName De kanaalnaam 'LineChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor de lijnkanaalresource LineChannelProperties

LineChannelProperties

Naam Description Waarde
lineRegistrations De lijst met regelkanaalregistraties LineRegistration[] (vereist)

LineRegistration

Naam Description Waarde
channelAccessToken Toegangstoken voor de registratie van het regelkanaal tekenreeks
channelSecret Geheim voor de registratie van het regelkanaal tekenreeks

M365Extensions

Naam Description Waarde
channelName De kanaalnaam 'M365Extensions' (vereist)

MsTeamsChannel

Naam Description Waarde
channelName De kanaalnaam 'MsTeamsChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor microsoft teams-kanaalresources MsTeamsChannelProperties

MsTeamsChannelProperties

Naam Description Waarde
acceptedTerms Of dit kanaal voorwaarden heeft geaccepteerd booleaans
callingWebhook Webhook voor Microsoft Teams-kanaaloproepen tekenreeks
deploymentEnvironment Implementatieomgeving voor Microsoft Teams-kanaaloproepen tekenreeks
enableCalling Bellen inschakelen voor Microsoft Teams-kanaal booleaans
incomingCallRoute Webhook voor Microsoft Teams-kanaaloproepen tekenreeks
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)

Omnichannel

Naam Description Waarde
channelName De kanaalnaam 'Omnichannel' (vereist)

OutlookChannel

Naam Description Waarde
channelName De kanaalnaam 'OutlookChannel' (vereist)

SearchAssistant

Naam Description Waarde
channelName De kanaalnaam SearchAssistant (vereist)

SkypeKanaal

Naam Description Waarde
channelName De kanaalnaam 'SkypeChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor skype-kanaalresources SkypeChannelEigenschappen

SkypeChannelEigenschappen

Naam Description Waarde
callingWebHook Webhook voor Skype-kanaal bellen tekenreeks
enableCalling Bellen inschakelen voor Skype-kanaal booleaans
enableGroups Groepen inschakelen voor Skype-kanaal booleaans
enableMediaCards Mediakaarten inschakelen voor Skype-kanaal booleaans
enableMessaging Berichten inschakelen voor Skype-kanaal booleaans
enableScreenSharing Scherm delen inschakelen voor Skype-kanaal booleaans
enableVideo Video inschakelen voor Skype-kanaal booleaans
groupsMode Groepsmodus voor Skype-kanaal tekenreeks
incomingCallRoute Route voor binnenkomende oproepen voor Skype-kanaal tekenreeks
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)

SlackChannel

Naam Description Waarde
channelName De kanaalnaam 'SlackChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor slack-kanaalresource SlackChannelProperties

SlackChannelProperties

Naam Description Waarde
clientId De Slack-client-id tekenreeks
clientSecret Het Slack-clientgeheim. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)
landingPageUrl De URL van de Slack-landingspagina tekenreeks
registerBeforeOAuthFlow Of de instellingen moeten worden geregistreerd voordat OAuth-validatie wordt uitgevoerd. Aanbevolen naar Waar. booleaans
bereiken De Slack-machtigingsbereiken. tekenreeks
signingSecret Het Slack-ondertekeningsgeheim. tekenreeks
verificationToken Het Slack-verificatietoken. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks

SmsChannel

Naam Description Waarde
channelName De kanaalnaam 'SmsChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor sms-kanaalresource SmsChannelProperties

SmsChannelProperties

Naam Description Waarde
accountSID De SID van het sms-account. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks (vereist)
authToken Het sms-verificatietoken. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)
isValidated Of dit kanaal is gevalideerd voor de bot booleaans
telefoon De sms-telefoon tekenreeks (vereist)

TelegramKanaal

Naam Description Waarde
channelName De kanaalnaam TelegramChannel (vereist)
properties De set eigenschappen die specifiek zijn voor telegramkanaalresource TelegramChannelProperties

TelegramChannelProperties

Naam Description Waarde
accessToken Het Telegram-toegangstoken. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)
isValidated Of dit kanaal is gevalideerd voor de bot booleaans

Telefoniekanaal

Naam Description Waarde
channelName De kanaalnaam 'TelephonyChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor telefoniekanaalresource TelephonyChannelProperties

TelephonyChannelProperties

Naam Description Waarde
apiConfigurations De lijst met telefonie-API-configuraties TelephonyChannelResourceApiConfiguration[]
cognitiveServiceRegion De extensionKey2 tekenreeks
cognitiveServiceSubscriptionKey De extensionKey1 tekenreeks
defaultLocale De standaardlandinstelling van het kanaal tekenreeks
isEnabled Of het kanaal is ingeschakeld booleaans
phoneNumbers De lijst met telefoonnummers voor telefonie TelephonyPhoneNumbers[]
premiumSKU De Premium-SKU die is toegepast op het kanaal tekenreeks

TelephonyChannelResourceApiConfiguration

Naam Description Waarde
cognitiveServiceRegion De cognitieve serviceregio. tekenreeks
cognitiveServiceResourceId De resourceId van de cognitive service. tekenreeks
cognitiveServiceSubscriptionKey De abonnementssleutel van de Cognitive Service. tekenreeks
defaultLocale De standaardlandinstelling. tekenreeks
id De id van de configuratie. tekenreeks
providerName De naam van de provider. tekenreeks

TelefonieTelefoonnummers

Naam Description Waarde
acsEndpoint Het eindpunt van ACS. tekenreeks
acsResourceId De resource-id van ACS. tekenreeks
acsSecret Het geheim van ACS. tekenreeks
cognitiveServiceRegion De serviceregio van cognitive service. tekenreeks
cognitiveServiceResourceId De resource-id van cognitive service. tekenreeks
cognitiveServiceSubscriptionKey De abonnementssleutel van cognitive service. tekenreeks
defaultLocale De standaardlandinstelling van het telefoonnummer. tekenreeks
id De element-id. tekenreeks
offerType Optionele eigenschap die het aanbiedingstype van de telefoon bepaalt. tekenreeks
phoneNumber Het telefoonnummer. tekenreeks

WebChatChannel

Naam Description Waarde
channelName De kanaalnaam 'WebChatChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor Webchat kanaalresource WebChatChannelProperties

WebChatChannelProperties

Naam Description Waarde
sites De lijst met Webchat sites WebChatSite[]

WebChatSite

Naam Description Waarde
appId DirectLine-toepassings-id tekenreeks
eTag Entiteitstag tekenreeks
isBlockUserUploadEnabled Of deze site is ingeschakeld voor het blokkeren van gebruikersuploads. booleaans
isDetailedLoggingEnabled Of deze site is uitgeschakeld voor gedetailleerde logboekregistratie voor booleaans
isEnabled Of deze site is ingeschakeld voor DirectLine-kanaal bool (vereist)
isEndpointParametersEnabled Of op deze site EndpointParameters is ingeschakeld voor kanaal booleaans
isNoStorageEnabled Of deze site zonder opslag is uitgeschakeld voor gedetailleerde logboekregistratie voor booleaans
isSecureSiteEnabled Of deze site is ingeschakeld voor verificatie met Bot Framework. booleaans
isV1Enabled Of deze site is ingeschakeld voor het Bot Framework V1-protocol. booleaans
isV3Enabled Of deze site is ingeschakeld voor het Bot Framework V3-protocol. booleaans
isWebchatPreviewEnabled Of deze site is ingeschakeld voor preview-versies van Webchat booleaans
isWebChatSpeechEnabled Of deze site is ingeschakeld voor Webchat Speech booleaans
siteName Sitenaam tekenreeks (vereist)
tenantId Tenant-id tekenreeks
trustedOrigins Lijst met VERTROUWDE OORSPRONG-URL's voor deze site. Dit veld is alleen van toepassing als isSecureSiteEnabled waar is. tekenreeks[]

Sku

Naam Description Waarde
naam De naam van de SKU 'F0'
'S1' (vereist)

Resourcedefinitie van ARM-sjabloon

Het resourcetype botServices/kanalen kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.BotService/botServices/channels-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.BotService/botServices/channels",
  "apiVersion": "2022-09-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "kind": "string",
  "etag": "string",
  "properties": {
    "etag": "string",
    "location": "string",
    "channelName": "string"
    // For remaining properties, see Channel objects
  }
}

Kanaalobjecten

Stel de eigenschap channelName in om het type object op te geven.

Gebruik voor AcsChatChannel:

  "channelName": "AcsChatChannel"

Gebruik voor AlexaChannel:

  "channelName": "AlexaChannel",
  "properties": {
    "alexaSkillId": "string",
    "isEnabled": "bool"
  }

Gebruik voor DirectLineChannel:

  "channelName": "DirectLineChannel",
  "properties": {
    "DirectLineEmbedCode": "string",
    "extensionKey1": "string",
    "extensionKey2": "string",
    "sites": [
      {
        "appId": "string",
        "eTag": "string",
        "isBlockUserUploadEnabled": "bool",
        "isDetailedLoggingEnabled": "bool",
        "isEnabled": "bool",
        "isEndpointParametersEnabled": "bool",
        "isNoStorageEnabled": "bool",
        "isSecureSiteEnabled": "bool",
        "isV1Enabled": "bool",
        "isV3Enabled": "bool",
        "isWebchatPreviewEnabled": "bool",
        "isWebChatSpeechEnabled": "bool",
        "siteName": "string",
        "tenantId": "string",
        "trustedOrigins": [ "string" ]
      }
    ]
  }

Gebruik voor DirectLineSpeechChannel:

  "channelName": "DirectLineSpeechChannel",
  "properties": {
    "cognitiveServiceRegion": "string",
    "cognitiveServiceResourceId": "string",
    "cognitiveServiceSubscriptionKey": "string",
    "customSpeechModelId": "string",
    "customVoiceDeploymentId": "string",
    "isDefaultBotForCogSvcAccount": "bool",
    "isEnabled": "bool"
  }

Gebruik voor EmailChannel:

  "channelName": "EmailChannel",
  "properties": {
    "authMethod": "int",
    "emailAddress": "string",
    "isEnabled": "bool",
    "magicCode": "string",
    "password": "string"
  }

Gebruik voor FacebookChannel:

  "channelName": "FacebookChannel",
  "properties": {
    "appId": "string",
    "appSecret": "string",
    "isEnabled": "bool",
    "pages": [
      {
        "accessToken": "string",
        "id": "string"
      }
    ]
  }

Gebruik voor KikChannel:

  "channelName": "KikChannel",
  "properties": {
    "apiKey": "string",
    "isEnabled": "bool",
    "isValidated": "bool",
    "userName": "string"
  }

Gebruik voor LineChannel:

  "channelName": "LineChannel",
  "properties": {
    "lineRegistrations": [
      {
        "channelAccessToken": "string",
        "channelSecret": "string"
      }
    ]
  }

Gebruik voor M365Extensions:

  "channelName": "M365Extensions"

Gebruik voor MsTeamsChannel:

  "channelName": "MsTeamsChannel",
  "properties": {
    "acceptedTerms": "bool",
    "callingWebhook": "string",
    "deploymentEnvironment": "string",
    "enableCalling": "bool",
    "incomingCallRoute": "string",
    "isEnabled": "bool"
  }

Gebruik voor Omnichannel:

  "channelName": "Omnichannel"

Gebruik voor OutlookChannel:

  "channelName": "OutlookChannel"

Gebruik voor SearchAssistant:

  "channelName": "SearchAssistant"

Gebruik voor SkypeChannel:

  "channelName": "SkypeChannel",
  "properties": {
    "callingWebHook": "string",
    "enableCalling": "bool",
    "enableGroups": "bool",
    "enableMediaCards": "bool",
    "enableMessaging": "bool",
    "enableScreenSharing": "bool",
    "enableVideo": "bool",
    "groupsMode": "string",
    "incomingCallRoute": "string",
    "isEnabled": "bool"
  }

Gebruik voor SlackChannel:

  "channelName": "SlackChannel",
  "properties": {
    "clientId": "string",
    "clientSecret": "string",
    "isEnabled": "bool",
    "landingPageUrl": "string",
    "registerBeforeOAuthFlow": "bool",
    "scopes": "string",
    "signingSecret": "string",
    "verificationToken": "string"
  }

Voor SmsChannel gebruikt u:

  "channelName": "SmsChannel",
  "properties": {
    "accountSID": "string",
    "authToken": "string",
    "isEnabled": "bool",
    "isValidated": "bool",
    "phone": "string"
  }

Gebruik voor TelegramChannel:

  "channelName": "TelegramChannel",
  "properties": {
    "accessToken": "string",
    "isEnabled": "bool",
    "isValidated": "bool"
  }

Gebruik voor TelephonyChannel:

  "channelName": "TelephonyChannel",
  "properties": {
    "apiConfigurations": [
      {
        "cognitiveServiceRegion": "string",
        "cognitiveServiceResourceId": "string",
        "cognitiveServiceSubscriptionKey": "string",
        "defaultLocale": "string",
        "id": "string",
        "providerName": "string"
      }
    ],
    "cognitiveServiceRegion": "string",
    "cognitiveServiceSubscriptionKey": "string",
    "defaultLocale": "string",
    "isEnabled": "bool",
    "phoneNumbers": [
      {
        "acsEndpoint": "string",
        "acsResourceId": "string",
        "acsSecret": "string",
        "cognitiveServiceRegion": "string",
        "cognitiveServiceResourceId": "string",
        "cognitiveServiceSubscriptionKey": "string",
        "defaultLocale": "string",
        "id": "string",
        "offerType": "string",
        "phoneNumber": "string"
      }
    ],
    "premiumSKU": "string"
  }

Gebruik voor WebChatChannel:

  "channelName": "WebChatChannel",
  "properties": {
    "sites": [
      {
        "appId": "string",
        "eTag": "string",
        "isBlockUserUploadEnabled": "bool",
        "isDetailedLoggingEnabled": "bool",
        "isEnabled": "bool",
        "isEndpointParametersEnabled": "bool",
        "isNoStorageEnabled": "bool",
        "isSecureSiteEnabled": "bool",
        "isV1Enabled": "bool",
        "isV3Enabled": "bool",
        "isWebchatPreviewEnabled": "bool",
        "isWebChatSpeechEnabled": "bool",
        "siteName": "string",
        "tenantId": "string",
        "trustedOrigins": [ "string" ]
      }
    ]
  }

Eigenschapswaarden

botServices/kanalen

Naam Description Waarde
type Het resourcetype 'Microsoft.BotService/botServices/channels'
apiVersion De resource-API-versie '2022-09-15'
naam De resourcenaam

Meer informatie over het instellen van namen en typen voor onderliggende resources in JSON ARM-sjablonen.
tekenreeks (vereist)

Tekenlimiet: 2-64

Geldige tekens:
Alfanumerieken, onderstrepingstekens, punten en afbreekstreepjes.

Begin met alfanumeriek.
location Hiermee geeft u de locatie van de resource op. tekenreeks
tags Bevat resourcetags die zijn gedefinieerd als sleutel-waardeparen. Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
sku Hiermee wordt de SKU van de resource opgehaald of ingesteld. SKU
Soort Vereist. Hiermee wordt het type resource opgehaald of ingesteld. 'azurebot'
'bot'
'ontwerper'
'functie'
'sdk'
etag Entiteitstag tekenreeks
properties De set eigenschappen die specifiek zijn voor botkanaalresources Kanaal

Kanaal

Naam Description Waarde
etag Entiteitstag van de resource tekenreeks
location Hiermee geeft u de locatie van de resource op. tekenreeks
channelName Het objecttype instellen AcsChatChannel
AlexaChannel
DirectLineChannel
DirectLineSpeechChannel
EmailChannel
FacebookKanaal
KikChannel
LineChannel
M365Extensions
MsTeamsChannel
Omnichannel
OutlookChannel
SearchAssistant
SkypeKanaal
SlackChannel
SmsChannel
TelegramKanaal
Telefoniekanaal
WebChatChannel (vereist)

AcsChatChannel

Naam Description Waarde
channelName De kanaalnaam AcsChatChannel (vereist)

AlexaChannel

Naam Description Waarde
channelName De kanaalnaam 'AlexaChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor de resource van het Alexa-kanaal AlexaChannelProperties

AlexaChannelProperties

Naam Description Waarde
alexaSkillId De Alexa-vaardigheids-id tekenreeks (vereist)
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)

DirectLineChannel

Naam Description Waarde
channelName De kanaalnaam 'DirectLineChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor Direct Line kanaalresource DirectLineChannelProperties

DirectLineChannelProperties

Naam Description Waarde
DirectLineEmbedCode Direct Line insluitcode van de resource tekenreeks
extensionKey1 De extensionKey1 tekenreeks
extensionKey2 De extensionKey2 tekenreeks
sites De lijst met Direct Line sites DirectLineSite[]

DirectLineSite

Naam Description Waarde
appId DirectLine-toepassings-id tekenreeks
eTag Entiteitstag tekenreeks
isBlockUserUploadEnabled Of deze site is ingeschakeld voor het blokkeren van gebruikersupload. booleaans
isDetailedLoggingEnabled Of deze site is uitgeschakeld voor gedetailleerde logboekregistratie voor booleaans
isEnabled Of deze site is ingeschakeld voor DirectLine-kanaal bool (vereist)
isEndpointParametersEnabled Of endpointparameters zijn ingeschakeld voor deze site voor kanaal booleaans
isNoStorageEnabled Of deze site zonder opslag is uitgeschakeld, gedetailleerde logboekregistratie voor booleaans
isSecureSiteEnabled Of deze site is ingeschakeld voor verificatie met Bot Framework. booleaans
isV1Enabled Of deze site is ingeschakeld voor het Bot Framework V1-protocol. booleaans
isV3Enabled Of deze site is ingeschakeld voor het Bot Framework V3-protocol. booleaans
isWebchatPreviewEnabled Of deze site is ingeschakeld voor preview-versies van Webchat booleaans
isWebChatSpeechEnabled Of deze site is ingeschakeld voor Webchat Speech booleaans
siteName Sitenaam tekenreeks (vereist)
tenantId Tenant-id tekenreeks
trustedOrigins Lijst met URL's van vertrouwde oorsprong voor deze site. Dit veld is alleen van toepassing als isSecureSiteEnabled Waar is. tekenreeks[]

DirectLineSpeechChannel

Naam Description Waarde
channelName De kanaalnaam 'DirectLineSpeechChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor de DirectLine Speech-kanaalresource DirectLineSpeechChannelProperties

DirectLineSpeechChannelProperties

Naam Description Waarde
cognitiveServiceRegion De cognitieve serviceregio met deze kanaalregistratie. tekenreeks
cognitiveServiceResourceId De cognitive service-id met deze kanaalregistratie. tekenreeks
cognitiveServiceSubscriptionKey De cognitive service-abonnementssleutel die moet worden gebruikt voor deze kanaalregistratie. tekenreeks
customSpeechModelId Aangepaste spraakimplementatie-id (optioneel). tekenreeks
customVoiceDeploymentId Aangepaste spraakmodel-id (optioneel). tekenreeks
isDefaultBotForCogSvcAccount Maak hiervan een standaardbot voor het gekozen Cognitive Service-account. booleaans
isEnabled Of dit kanaal is ingeschakeld of niet. booleaans

EmailChannel

Naam Description Waarde
channelName De kanaalnaam 'EmailChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor e-mailkanaalresources EmailChannelProperties

EmailChannelProperties

Naam Description Waarde
authMethod Email methode voor kanaalverificatie. 0 Wachtwoord (standaard); 1 grafiek. int
emailAddress Het e-mailadres tekenreeks (vereist)
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)
magicCode De magische code voor het instellen van de moderne verificatie. tekenreeks
wachtwoord Het wachtwoord voor het e-mailadres. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks

FacebookKanaal

Naam Description Waarde
channelName De kanaalnaam 'FacebookChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor het Facebook-kanaal van de bot FacebookChannelProperties

FacebookChannelProperties

Naam Description Waarde
appId Facebook-toepassings-id tekenreeks (vereist)
appSecret Facebook-toepassingsgeheim. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)
pagina's De lijst met Facebook-pagina's FacebookPage[]

FacebookPage

Naam Description Waarde
accessToken Toegangstoken voor Facebook-toepassing. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks
id Pagina-id tekenreeks (vereist)

KikChannel

Naam Description Waarde
channelName De kanaalnaam 'KikChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor kik-kanaalresource KikChannelProperties

KikChannelProperties

Naam Description Waarde
apiKey Kik API-sleutel. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)
isValidated Of dit kanaal is gevalideerd voor de bot booleaans
userName De Kik-gebruikersnaam tekenreeks (vereist)

LineChannel

Naam Description Waarde
channelName De kanaalnaam 'LineChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor de lijnkanaalresource LineChannelProperties

LineChannelProperties

Naam Description Waarde
lineRegistrations De lijst met regelkanaalregistraties LineRegistration[] (vereist)

LineRegistration

Naam Description Waarde
channelAccessToken Toegangstoken voor de registratie van het regelkanaal tekenreeks
channelSecret Geheim voor de registratie van het regelkanaal tekenreeks

M365Extensions

Naam Description Waarde
channelName De kanaalnaam 'M365Extensions' (vereist)

MsTeamsChannel

Naam Description Waarde
channelName De kanaalnaam 'MsTeamsChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor microsoft teams-kanaalresources MsTeamsChannelProperties

MsTeamsChannelProperties

Naam Description Waarde
acceptedTerms Of dit kanaal voorwaarden heeft geaccepteerd booleaans
callingWebhook Webhook voor Microsoft Teams-kanaaloproepen tekenreeks
deploymentEnvironment Implementatieomgeving voor Microsoft Teams-kanaaloproepen tekenreeks
enableCalling Bellen inschakelen voor Microsoft Teams-kanaal booleaans
incomingCallRoute Webhook voor Microsoft Teams-kanaaloproepen tekenreeks
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)

Omnichannel

Naam Description Waarde
channelName De kanaalnaam 'Omnichannel' (vereist)

OutlookChannel

Naam Description Waarde
channelName De kanaalnaam 'OutlookChannel' (vereist)

SearchAssistant

Naam Description Waarde
channelName De kanaalnaam SearchAssistant (vereist)

SkypeKanaal

Naam Description Waarde
channelName De kanaalnaam 'SkypeChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor skype-kanaalresources SkypeChannelEigenschappen

SkypeChannelEigenschappen

Naam Description Waarde
callingWebHook Webhook voor Skype-kanaal bellen tekenreeks
enableCalling Bellen inschakelen voor Skype-kanaal booleaans
enableGroups Groepen inschakelen voor Skype-kanaal booleaans
enableMediaCards Mediakaarten inschakelen voor Skype-kanaal booleaans
enableMessaging Berichten inschakelen voor Skype-kanaal booleaans
enableScreenSharing Scherm delen inschakelen voor Skype-kanaal booleaans
enableVideo Video inschakelen voor Skype-kanaal booleaans
groupsMode Groepsmodus voor Skype-kanaal tekenreeks
incomingCallRoute Route voor binnenkomende oproepen voor Skype-kanaal tekenreeks
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)

SlackChannel

Naam Description Waarde
channelName De kanaalnaam 'SlackChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor slack-kanaalresource SlackChannelProperties

SlackChannelProperties

Naam Description Waarde
clientId De Slack-client-id tekenreeks
clientSecret Het Slack-clientgeheim. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)
landingPageUrl De URL van de Slack-landingspagina tekenreeks
registerBeforeOAuthFlow Of de instellingen moeten worden geregistreerd voordat OAuth-validatie wordt uitgevoerd. Aanbevolen voor Waar. booleaans
bereiken De Slack-machtigingsbereiken. tekenreeks
signingSecret Het slack-ondertekeningsgeheim. tekenreeks
verificationToken Het Slack-verificatietoken. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks

SmsChannel

Naam Description Waarde
channelName De kanaalnaam 'SmsChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor de sms-kanaalresource SmsChannelProperties

SmsChannelProperties

Naam Description Waarde
accountSID De SMS-account-SID. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks (vereist)
authToken Het sms-verificatietoken. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)
isValidated Of dit kanaal is gevalideerd voor de bot booleaans
telefoon De sms-telefoon tekenreeks (vereist)

TelegramKanaal

Naam Description Waarde
channelName De kanaalnaam TelegramChannel (vereist)
properties De set eigenschappen die specifiek zijn voor de telegramkanaalresource TelegramChannelProperties

TelegramChannelProperties

Naam Description Waarde
accessToken Het Telegram-toegangstoken. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)
isValidated Of dit kanaal is gevalideerd voor de bot booleaans

Telefoniekanaal

Naam Description Waarde
channelName De kanaalnaam Telefoniekanaal (vereist)
properties De set eigenschappen die specifiek zijn voor telefoniekanaalresources TelephonyChannelProperties

TelephonyChannelProperties

Naam Description Waarde
apiConfigurations De lijst met telefonie-API-configuratie TelephonyChannelResourceApiConfiguration[]
cognitiveServiceRegion De extensionKey2 tekenreeks
cognitiveServiceSubscriptionKey De extensionKey1 tekenreeks
defaultLocale De standaardlandinstelling van het kanaal tekenreeks
isEnabled Of het kanaal is ingeschakeld booleaans
phoneNumbers De lijst met telefoonnummers voor telefonie TelephonyPhoneNumbers[]
premiumSKU De Premium-SKU die is toegepast op het kanaal tekenreeks

TelephonyChannelResourceApiConfiguration

Naam Description Waarde
cognitiveServiceRegion De cognitive service-regio. tekenreeks
cognitiveServiceResourceId De cognitive service resourceId. tekenreeks
cognitiveServiceSubscriptionKey De abonnementssleutel van de Cognitive Service. tekenreeks
defaultLocale De standaardlandinstelling. tekenreeks
id De id van de configuratie. tekenreeks
providerName De naam van de provider. tekenreeks

TelefonieTelefoonNummers

Naam Description Waarde
acsEndpoint Het eindpunt van ACS. tekenreeks
acsResourceId De resource-id van ACS. tekenreeks
acsSecret Het geheim van ACS. tekenreeks
cognitiveServiceRegion De serviceregio van cognitive service. tekenreeks
cognitiveServiceResourceId De resource-id van cognitive service. tekenreeks
cognitiveServiceSubscriptionKey De abonnementssleutel van cognitive service. tekenreeks
defaultLocale De standaardlandinstelling van het telefoonnummer. tekenreeks
id De element-id. tekenreeks
offerType Optionele eigenschap die het aanbiedingstype van de telefoon bepaalt. tekenreeks
phoneNumber Het telefoonnummer. tekenreeks

WebChatChannel

Naam Description Waarde
channelName De kanaalnaam 'WebChatChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor Webchat kanaalresource WebChatChannelProperties

WebChatChannelProperties

Naam Description Waarde
sites De lijst met Webchat sites WebChatSite[]

WebChatSite

Naam Description Waarde
appId DirectLine-toepassings-id tekenreeks
eTag Entiteitstag tekenreeks
isBlockUserUploadEnabled Of deze site is ingeschakeld voor het blokkeren van gebruikersupload. booleaans
isDetailedLoggingEnabled Of deze site is uitgeschakeld voor gedetailleerde logboekregistratie voor booleaans
isEnabled Of deze site is ingeschakeld voor DirectLine-kanaal bool (vereist)
isEndpointParametersEnabled Of endpointparameters zijn ingeschakeld voor deze site voor kanaal booleaans
isNoStorageEnabled Of deze site zonder opslag is uitgeschakeld, gedetailleerde logboekregistratie voor booleaans
isSecureSiteEnabled Of deze site is ingeschakeld voor verificatie met Bot Framework. booleaans
isV1Enabled Of deze site is ingeschakeld voor het Bot Framework V1-protocol. booleaans
isV3Enabled Of deze site is ingeschakeld voor het Bot Framework V3-protocol. booleaans
isWebchatPreviewEnabled Of deze site is ingeschakeld voor preview-versies van Webchat booleaans
isWebChatSpeechEnabled Of deze site is ingeschakeld voor Webchat Speech booleaans
siteName Sitenaam tekenreeks (vereist)
tenantId Tenant-id tekenreeks
trustedOrigins Lijst met URL's van vertrouwde oorsprong voor deze site. Dit veld is alleen van toepassing als isSecureSiteEnabled Waar is. tekenreeks[]

Sku

Naam Description Waarde
naam De SKU-naam 'F0'
'S1' (vereist)

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype botServices/kanalen kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • Resourcegroepen

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource Microsoft.BotService/botServices/channels wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.BotService/botServices/channels@2022-09-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      etag = "string"
      location = "string"
      channelName = "string"
      // For remaining properties, see Channel objects
    }
    sku = {
      name = "string"
    }
    kind = "string"
    etag = "string"
  })
}

Kanaalobjecten

Stel de eigenschap channelName in om het type object op te geven.

Gebruik voor AcsChatChannel:

  channelName = "AcsChatChannel"

Gebruik voor AlexaChannel:

  channelName = "AlexaChannel"
  properties = {
    alexaSkillId = "string"
    isEnabled = bool
  }

Gebruik voor DirectLineChannel:

  channelName = "DirectLineChannel"
  properties = {
    DirectLineEmbedCode = "string"
    extensionKey1 = "string"
    extensionKey2 = "string"
    sites = [
      {
        appId = "string"
        eTag = "string"
        isBlockUserUploadEnabled = bool
        isDetailedLoggingEnabled = bool
        isEnabled = bool
        isEndpointParametersEnabled = bool
        isNoStorageEnabled = bool
        isSecureSiteEnabled = bool
        isV1Enabled = bool
        isV3Enabled = bool
        isWebchatPreviewEnabled = bool
        isWebChatSpeechEnabled = bool
        siteName = "string"
        tenantId = "string"
        trustedOrigins = [
          "string"
        ]
      }
    ]
  }

Voor DirectLineSpeechChannel gebruikt u:

  channelName = "DirectLineSpeechChannel"
  properties = {
    cognitiveServiceRegion = "string"
    cognitiveServiceResourceId = "string"
    cognitiveServiceSubscriptionKey = "string"
    customSpeechModelId = "string"
    customVoiceDeploymentId = "string"
    isDefaultBotForCogSvcAccount = bool
    isEnabled = bool
  }

Gebruik voor EmailChannel:

  channelName = "EmailChannel"
  properties = {
    authMethod = int
    emailAddress = "string"
    isEnabled = bool
    magicCode = "string"
    password = "string"
  }

Gebruik voor FacebookChannel:

  channelName = "FacebookChannel"
  properties = {
    appId = "string"
    appSecret = "string"
    isEnabled = bool
    pages = [
      {
        accessToken = "string"
        id = "string"
      }
    ]
  }

Voor KikChannel gebruikt u:

  channelName = "KikChannel"
  properties = {
    apiKey = "string"
    isEnabled = bool
    isValidated = bool
    userName = "string"
  }

Gebruik voor LineChannel:

  channelName = "LineChannel"
  properties = {
    lineRegistrations = [
      {
        channelAccessToken = "string"
        channelSecret = "string"
      }
    ]
  }

Gebruik voor M365Extensions:

  channelName = "M365Extensions"

Voor MsTeamsChannel gebruikt u:

  channelName = "MsTeamsChannel"
  properties = {
    acceptedTerms = bool
    callingWebhook = "string"
    deploymentEnvironment = "string"
    enableCalling = bool
    incomingCallRoute = "string"
    isEnabled = bool
  }

Gebruik voor Omnichannel:

  channelName = "Omnichannel"

Gebruik voor OutlookChannel:

  channelName = "OutlookChannel"

Gebruik voor SearchAssistant:

  channelName = "SearchAssistant"

Gebruik voor SkypeChannel:

  channelName = "SkypeChannel"
  properties = {
    callingWebHook = "string"
    enableCalling = bool
    enableGroups = bool
    enableMediaCards = bool
    enableMessaging = bool
    enableScreenSharing = bool
    enableVideo = bool
    groupsMode = "string"
    incomingCallRoute = "string"
    isEnabled = bool
  }

Gebruik voor SlackChannel:

  channelName = "SlackChannel"
  properties = {
    clientId = "string"
    clientSecret = "string"
    isEnabled = bool
    landingPageUrl = "string"
    registerBeforeOAuthFlow = bool
    scopes = "string"
    signingSecret = "string"
    verificationToken = "string"
  }

Voor SmsChannel gebruikt u:

  channelName = "SmsChannel"
  properties = {
    accountSID = "string"
    authToken = "string"
    isEnabled = bool
    isValidated = bool
    phone = "string"
  }

Gebruik voor TelegramChannel:

  channelName = "TelegramChannel"
  properties = {
    accessToken = "string"
    isEnabled = bool
    isValidated = bool
  }

Gebruik voor TelephonyChannel:

  channelName = "TelephonyChannel"
  properties = {
    apiConfigurations = [
      {
        cognitiveServiceRegion = "string"
        cognitiveServiceResourceId = "string"
        cognitiveServiceSubscriptionKey = "string"
        defaultLocale = "string"
        id = "string"
        providerName = "string"
      }
    ]
    cognitiveServiceRegion = "string"
    cognitiveServiceSubscriptionKey = "string"
    defaultLocale = "string"
    isEnabled = bool
    phoneNumbers = [
      {
        acsEndpoint = "string"
        acsResourceId = "string"
        acsSecret = "string"
        cognitiveServiceRegion = "string"
        cognitiveServiceResourceId = "string"
        cognitiveServiceSubscriptionKey = "string"
        defaultLocale = "string"
        id = "string"
        offerType = "string"
        phoneNumber = "string"
      }
    ]
    premiumSKU = "string"
  }

Gebruik voor WebChatChannel:

  channelName = "WebChatChannel"
  properties = {
    sites = [
      {
        appId = "string"
        eTag = "string"
        isBlockUserUploadEnabled = bool
        isDetailedLoggingEnabled = bool
        isEnabled = bool
        isEndpointParametersEnabled = bool
        isNoStorageEnabled = bool
        isSecureSiteEnabled = bool
        isV1Enabled = bool
        isV3Enabled = bool
        isWebchatPreviewEnabled = bool
        isWebChatSpeechEnabled = bool
        siteName = "string"
        tenantId = "string"
        trustedOrigins = [
          "string"
        ]
      }
    ]
  }

Eigenschapswaarden

botServices/kanalen

Naam Description Waarde
type Het resourcetype "Microsoft.BotService/botServices/channels@2022-09-15"
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 2-64

Geldige tekens:
Alfanumerieken, onderstrepingstekens, punten en afbreekstreepjes.

Begin met alfanumeriek.
location Hiermee geeft u de locatie van de resource op. tekenreeks
parent_id De id van de resource die het bovenliggende item voor deze resource is. Id voor resource van type: botServices
tags Bevat resourcetags die zijn gedefinieerd als sleutel-waardeparen. Woordenlijst met tagnamen en -waarden.
sku Hiermee wordt de SKU van de resource opgehaald of ingesteld. SKU
Soort Vereist. Hiermee wordt het type resource opgehaald of ingesteld. "azurebot"
"bot"
"ontwerper"
"functie"
"sdk"
etag Entiteitstag tekenreeks
properties De set eigenschappen die specifiek zijn voor botkanaalresources Kanaal

Kanaal

Naam Description Waarde
etag Entiteitstag van de resource tekenreeks
location Hiermee geeft u de locatie van de resource op. tekenreeks
channelName Het objecttype instellen AcsChatChannel
AlexaChannel
DirectLineChannel
DirectLineSpeechChannel
EmailChannel
FacebookKanaal
KikChannel
LineChannel
M365Extensions
MsTeamsChannel
Omnichannel
OutlookChannel
SearchAssistant
SkypeKanaal
SlackChannel
SmsChannel
TelegramKanaal
Telefoniekanaal
WebChatChannel (vereist)

AcsChatChannel

Naam Description Waarde
channelName De kanaalnaam AcsChatChannel (vereist)

AlexaChannel

Naam Description Waarde
channelName De kanaalnaam "AlexaChannel" (vereist)
properties De set eigenschappen die specifiek zijn voor de resource van het Alexa-kanaal AlexaChannelProperties

AlexaChannelProperties

Naam Description Waarde
alexaSkillId De Alexa-vaardigheids-id tekenreeks (vereist)
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)

DirectLineChannel

Naam Description Waarde
channelName De kanaalnaam "DirectLineChannel" (vereist)
properties De set eigenschappen die specifiek zijn voor Direct Line kanaalresource DirectLineChannelProperties

DirectLineChannelProperties

Naam Description Waarde
DirectLineEmbedCode Direct Line insluitcode van de resource tekenreeks
extensionKey1 De extensionKey1 tekenreeks
extensionKey2 De extensionKey2 tekenreeks
sites De lijst met Direct Line sites DirectLineSite[]

DirectLineSite

Naam Description Waarde
appId DirectLine-toepassings-id tekenreeks
eTag Entiteitstag tekenreeks
isBlockUserUploadEnabled Of deze site is ingeschakeld voor het blokkeren van gebruikersuploads. booleaans
isDetailedLoggingEnabled Of deze site is uitgeschakeld voor gedetailleerde logboekregistratie voor booleaans
isEnabled Of deze site is ingeschakeld voor DirectLine-kanaal bool (vereist)
isEndpointParametersEnabled Of op deze site EndpointParameters is ingeschakeld voor kanaal booleaans
isNoStorageEnabled Of deze site zonder opslag is uitgeschakeld voor gedetailleerde logboekregistratie voor booleaans
isSecureSiteEnabled Of deze site is ingeschakeld voor verificatie met Bot Framework. booleaans
isV1Enabled Of deze site is ingeschakeld voor het Bot Framework V1-protocol. booleaans
isV3Enabled Of deze site is ingeschakeld voor het Bot Framework V3-protocol. booleaans
isWebchatPreviewEnabled Of deze site is ingeschakeld voor preview-versies van Webchat booleaans
isWebChatSpeechEnabled Of deze site is ingeschakeld voor Webchat Speech booleaans
siteName Sitenaam tekenreeks (vereist)
tenantId Tenant-id tekenreeks
trustedOrigins Lijst met VERTROUWDE OORSPRONG-URL's voor deze site. Dit veld is alleen van toepassing als isSecureSiteEnabled waar is. tekenreeks[]

DirectLineSpeechChannel

Naam Description Waarde
channelName De kanaalnaam "DirectLineSpeechChannel" (vereist)
properties De set eigenschappen die specifiek zijn voor de DirectLine Speech-kanaalresource DirectLineSpeechChannelEigenschappen

DirectLineSpeechChannelEigenschappen

Naam Description Waarde
cognitiveServiceRegion De cognitieve serviceregio met dit kanaalregistratie. tekenreeks
cognitiveServiceResourceId De cognitive service-id met dit kanaalregistratie. tekenreeks
cognitiveServiceSubscriptionKey De cognitive service-abonnementssleutel die moet worden gebruikt met deze kanaalregistratie. tekenreeks
customSpeechModelId Aangepaste spraakimplementatie-id (optioneel). tekenreeks
customVoiceDeploymentId Aangepaste spraakmodel-id (optioneel). tekenreeks
isDefaultBotForCogSvcAccount Maak hiervan een standaardbot voor het gekozen Cognitive Service-account. booleaans
isEnabled Of dit kanaal is ingeschakeld of niet. booleaans

EmailChannel

Naam Description Waarde
channelName De kanaalnaam 'EmailChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor e-mailkanaalresources EmailChannelProperties

EmailChannelProperties

Naam Description Waarde
authMethod Email methode voor kanaalverificatie. 0 Wachtwoord (standaard); 1 grafiek. int
emailAddress Het e-mailadres tekenreeks (vereist)
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)
magicCode De magic-code voor het instellen van de moderne verificatie. tekenreeks
wachtwoord Het wachtwoord voor het e-mailadres. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks

FacebookKanaal

Naam Description Waarde
channelName De kanaalnaam 'FacebookChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor het Facebook-kanaal van de bot FacebookChannelProperties

FacebookChannelProperties

Naam Description Waarde
appId Facebook-toepassings-id tekenreeks (vereist)
appSecret Facebook-toepassingsgeheim. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)
pagina's De lijst met Facebook-pagina's FacebookPage[]

FacebookPagina

Naam Description Waarde
accessToken Toegangstoken voor Facebook-toepassing. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks
id Pagina-id tekenreeks (vereist)

KikChannel

Naam Description Waarde
channelName De kanaalnaam "KikChannel" (vereist)
properties De set eigenschappen die specifiek zijn voor kik-kanaalresource KikChannelProperties

KikChannelProperties

Naam Description Waarde
apiKey Kik API-sleutel. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)
isValidated Of dit kanaal is gevalideerd voor de bot booleaans
userName De Kik-gebruikersnaam tekenreeks (vereist)

LineChannel

Naam Description Waarde
channelName De kanaalnaam "LineChannel" (vereist)
properties De set eigenschappen die specifiek zijn voor de lijnkanaalresource LineChannelProperties

LineChannelProperties

Naam Description Waarde
lineRegistrations De lijst met regelkanaalregistraties LineRegistration[] (vereist)

LineRegistration

Naam Description Waarde
channelAccessToken Toegangstoken voor de registratie van het regelkanaal tekenreeks
channelSecret Geheim voor de registratie van het regelkanaal tekenreeks

M365Extensions

Naam Description Waarde
channelName De kanaalnaam "M365Extensions" (vereist)

MsTeamsChannel

Naam Description Waarde
channelName De kanaalnaam 'MsTeamsChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor microsoft teams-kanaalresources MsTeamsChannelProperties

MsTeamsChannelProperties

Naam Description Waarde
acceptedTerms Of dit kanaal voorwaarden heeft geaccepteerd booleaans
callingWebhook Webhook voor Microsoft Teams-kanaaloproepen tekenreeks
deploymentEnvironment Implementatieomgeving voor Microsoft Teams-kanaaloproepen tekenreeks
enableCalling Bellen inschakelen voor Microsoft Teams-kanaal booleaans
incomingCallRoute Webhook voor Microsoft Teams-kanaaloproepen tekenreeks
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)

Omnichannel

Naam Description Waarde
channelName De kanaalnaam Omnichannel (vereist)

OutlookChannel

Naam Description Waarde
channelName De kanaalnaam 'OutlookChannel' (vereist)

SearchAssistant

Naam Description Waarde
channelName De kanaalnaam "SearchAssistant" (vereist)

SkypeKanaal

Naam Description Waarde
channelName De kanaalnaam 'SkypeChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor skype-kanaalresources SkypeChannelEigenschappen

SkypeChannelEigenschappen

Naam Description Waarde
callingWebHook Webhook voor Skype-kanaal bellen tekenreeks
enableCalling Bellen inschakelen voor Skype-kanaal booleaans
enableGroups Groepen inschakelen voor Skype-kanaal booleaans
enableMediaCards Mediakaarten inschakelen voor Skype-kanaal booleaans
enableMessaging Berichten inschakelen voor Skype-kanaal booleaans
enableScreenSharing Scherm delen inschakelen voor Skype-kanaal booleaans
enableVideo Video inschakelen voor Skype-kanaal booleaans
groupsMode Groepsmodus voor Skype-kanaal tekenreeks
incomingCallRoute Route voor binnenkomende oproepen voor Skype-kanaal tekenreeks
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)

SlackChannel

Naam Description Waarde
channelName De kanaalnaam "SlackChannel" (vereist)
properties De set eigenschappen die specifiek zijn voor slack-kanaalresource SlackChannelProperties

SlackChannelProperties

Naam Description Waarde
clientId De Slack-client-id tekenreeks
clientSecret Het Slack-clientgeheim. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)
landingPageUrl De URL van de Slack-landingspagina tekenreeks
registerBeforeOAuthFlow Of de instellingen moeten worden geregistreerd voordat OAuth-validatie wordt uitgevoerd. Aanbevolen voor Waar. booleaans
bereiken De Slack-machtigingsbereiken. tekenreeks
signingSecret Het slack-ondertekeningsgeheim. tekenreeks
verificationToken Het Slack-verificatietoken. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks

SmsChannel

Naam Description Waarde
channelName De kanaalnaam "SmsChannel" (vereist)
properties De set eigenschappen die specifiek zijn voor de sms-kanaalresource SmsChannelProperties

SmsChannelProperties

Naam Description Waarde
accountSID De SMS-account-SID. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks (vereist)
authToken Het sms-verificatietoken. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)
isValidated Of dit kanaal is gevalideerd voor de bot booleaans
telefoon De sms-telefoon tekenreeks (vereist)

TelegramKanaal

Naam Description Waarde
channelName De kanaalnaam "TelegramChannel" (vereist)
properties De set eigenschappen die specifiek zijn voor telegramkanaalresource TelegramChannelProperties

TelegramChannelProperties

Naam Description Waarde
accessToken Het Telegram-toegangstoken. De waarde wordt alleen geretourneerd via POST naar de API van de actiekanaallijst, anders leeg. tekenreeks
isEnabled Of dit kanaal is ingeschakeld voor de bot bool (vereist)
isValidated Of dit kanaal is gevalideerd voor de bot booleaans

Telefoniekanaal

Naam Description Waarde
channelName De kanaalnaam "TelephonyChannel" (vereist)
properties De set eigenschappen die specifiek zijn voor telefoniekanaalresource TelephonyChannelProperties

TelephonyChannelProperties

Naam Description Waarde
apiConfigurations De lijst met telefonie-API-configuraties TelephonyChannelResourceApiConfiguration[]
cognitiveServiceRegion De extensionKey2 tekenreeks
cognitiveServiceSubscriptionKey De extensionKey1 tekenreeks
defaultLocale De standaardlandinstelling van het kanaal tekenreeks
isEnabled Of het kanaal is ingeschakeld booleaans
phoneNumbers De lijst met telefoonnummers voor telefonie TelephonyPhoneNumbers[]
premiumSKU De Premium-SKU die is toegepast op het kanaal tekenreeks

TelephonyChannelResourceApiConfiguration

Naam Description Waarde
cognitiveServiceRegion De cognitieve serviceregio. tekenreeks
cognitiveServiceResourceId De resourceId van de cognitive service. tekenreeks
cognitiveServiceSubscriptionKey De abonnementssleutel van de Cognitive Service. tekenreeks
defaultLocale De standaardlandinstelling. tekenreeks
id De id van de configuratie. tekenreeks
providerName De naam van de provider. tekenreeks

TelefonieTelefoonnummers

Naam Description Waarde
acsEndpoint Het eindpunt van ACS. tekenreeks
acsResourceId De resource-id van ACS. tekenreeks
acsSecret Het geheim van ACS. tekenreeks
cognitiveServiceRegion De serviceregio van cognitive service. tekenreeks
cognitiveServiceResourceId De resource-id van cognitive service. tekenreeks
cognitiveServiceSubscriptionKey De abonnementssleutel van cognitive service. tekenreeks
defaultLocale De standaardlandinstelling van het telefoonnummer. tekenreeks
id De element-id. tekenreeks
offerType Optionele eigenschap die het aanbiedingstype van de telefoon bepaalt. tekenreeks
phoneNumber Het telefoonnummer. tekenreeks

WebChatChannel

Naam Description Waarde
channelName De kanaalnaam 'WebChatChannel' (vereist)
properties De set eigenschappen die specifiek zijn voor Webchat kanaalresource WebChatChannelProperties

WebChatChannelProperties

Naam Description Waarde
sites De lijst met Webchat sites WebChatSite[]

WebChatSite

Naam Description Waarde
appId DirectLine-toepassings-id tekenreeks
eTag Entiteitstag tekenreeks
isBlockUserUploadEnabled Of deze site is ingeschakeld voor het blokkeren van gebruikersupload. booleaans
isDetailedLoggingEnabled Of deze site is uitgeschakeld voor gedetailleerde logboekregistratie voor booleaans
isEnabled Of deze site is ingeschakeld voor DirectLine-kanaal bool (vereist)
isEndpointParametersEnabled Of endpointparameters zijn ingeschakeld voor deze site voor kanaal booleaans
isNoStorageEnabled Of deze site zonder opslag is uitgeschakeld, gedetailleerde logboekregistratie voor booleaans
isSecureSiteEnabled Of deze site is ingeschakeld voor verificatie met Bot Framework. booleaans
isV1Enabled Of deze site is ingeschakeld voor het Bot Framework V1-protocol. booleaans
isV3Enabled Of deze site is ingeschakeld voor het Bot Framework V3-protocol. booleaans
isWebchatPreviewEnabled Of deze site is ingeschakeld voor preview-versies van Webchat booleaans
isWebChatSpeechEnabled Of deze site is ingeschakeld voor Webchat Speech booleaans
siteName Sitenaam tekenreeks (vereist)
tenantId Tenant-id tekenreeks
trustedOrigins Lijst met URL's van vertrouwde oorsprong voor deze site. Dit veld is alleen van toepassing als isSecureSiteEnabled Waar is. tekenreeks[]

Sku

Naam Description Waarde
naam De SKU-naam "F0"
"S1" (vereist)