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.
- najnowsze
- 2023-09-15-podgląd
- 2022-09-15
- 2022-06-15-podgląd
-
2021-05-01-preview - 2021-03-01
- 2020-06-02
- 2018-07-12
- 2017-12-01
Definicja zasobu Bicep
Typ zasobu botServices/kanały 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 integracji dla kanału bota.
param resourceName string = 'acctest0001'
param location string = 'westus'
resource botService 'Microsoft.BotService/botServices@2021-05-01-preview' = {
name: resourceName
location: location
sku: {
name: 'F0'
}
kind: 'bot'
properties: {
cmekKeyVaultUrl: ''
description: ''
developerAppInsightKey: ''
developerAppInsightsApiKey: ''
developerAppInsightsApplicationId: ''
displayName: resourceName
endpoint: ''
iconUrl: 'https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png'
isCmekEnabled: false
isStreamingSupported: false
msaAppId: '12345678-1234-1234-1234-123456789012'
}
}
resource channel 'Microsoft.BotService/botServices/channels@2021-05-01-preview' = {
name: 'AlexaChannel'
location: location
parent: botService
kind: 'bot'
properties: {
channelName: 'AlexaChannel'
properties: {
alexaSkillId: 'amzn1.ask.skill.19126e57-867f-4553-b953-ad0a720dddec'
isEnabled: true
}
}
}
Format zasobu
Aby utworzyć zasób Microsoft.BotService/botServices/channels, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.BotService/botServices/channels@2023-09-15-preview' = {
parent: resourceSymbolicName
etag: 'string'
kind: 'string'
location: 'string'
name: 'string'
properties: {
etag: 'string'
location: 'string'
channelName: 'string'
// For remaining properties, see Channel objects
}
sku: {
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Obiekty kanału
Ustaw właściwość channelName, aby określić typ obiektu.
W przypadku acsChatChannelużyj:
{
channelName: 'AcsChatChannel'
}
W przypadku AlexaChannel użyj:
{
channelName: 'AlexaChannel'
properties: {
alexaSkillId: 'string'
isEnabled: bool
}
}
W przypadku DirectLineChannel użyj:
{
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'
]
}
]
}
}
W przypadku DirectLineSpeechChannelużyj:
{
channelName: 'DirectLineSpeechChannel'
properties: {
cognitiveServiceRegion: 'string'
cognitiveServiceResourceId: 'string'
cognitiveServiceSubscriptionKey: 'string'
customSpeechModelId: 'string'
customVoiceDeploymentId: 'string'
isDefaultBotForCogSvcAccount: bool
isEnabled: bool
}
}
W przypadku EmailChannelużyj:
{
channelName: 'EmailChannel'
properties: {
authMethod: int
emailAddress: 'string'
isEnabled: bool
magicCode: 'string'
password: 'string'
}
}
W przypadku FacebookChannel użyj:
{
channelName: 'FacebookChannel'
properties: {
appId: 'string'
appSecret: 'string'
isEnabled: bool
pages: [
{
accessToken: 'string'
id: 'string'
}
]
}
}
W przypadku KikChannel użyj:
{
channelName: 'KikChannel'
properties: {
apiKey: 'string'
isEnabled: bool
isValidated: bool
userName: 'string'
}
}
W przypadku LineChannelużyj:
{
channelName: 'LineChannel'
properties: {
lineRegistrations: [
{
channelAccessToken: 'string'
channelSecret: 'string'
}
]
}
}
W przypadku M365Extensionsużyj:
{
channelName: 'M365Extensions'
}
W przypadku MsTeamsChannelużyj:
{
channelName: 'MsTeamsChannel'
properties: {
acceptedTerms: bool
callingWebhook: 'string'
deploymentEnvironment: 'string'
enableCalling: bool
incomingCallRoute: 'string'
isEnabled: bool
}
}
W przypadku omnichannelużyj:
{
channelName: 'Omnichannel'
}
W przypadku programu OutlookChannelużyj:
{
channelName: 'OutlookChannel'
}
W przypadku SearchAssistantużyj:
{
channelName: 'SearchAssistant'
}
W przypadku SkypeChannel użyj:
{
channelName: 'SkypeChannel'
properties: {
callingWebHook: 'string'
enableCalling: bool
enableGroups: bool
enableMediaCards: bool
enableMessaging: bool
enableScreenSharing: bool
enableVideo: bool
groupsMode: 'string'
incomingCallRoute: 'string'
isEnabled: bool
}
}
W przypadku SlackChannel użyj:
{
channelName: 'SlackChannel'
properties: {
clientId: 'string'
clientSecret: 'string'
isEnabled: bool
landingPageUrl: 'string'
registerBeforeOAuthFlow: bool
scopes: 'string'
signingSecret: 'string'
verificationToken: 'string'
}
}
W przypadku SmsChannel użyj:
{
channelName: 'SmsChannel'
properties: {
accountSID: 'string'
authToken: 'string'
isEnabled: bool
isValidated: bool
phone: 'string'
}
}
W przypadku TelegramChannelużyj:
{
channelName: 'TelegramChannel'
properties: {
accessToken: 'string'
isEnabled: bool
isValidated: bool
}
}
W przypadku TelefoniiChannelużyj:
{
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'
}
}
W przypadku WebChatChannel użyj:
{
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'
]
}
]
}
}
Wartości właściwości
Microsoft.BotService/usługiBotów/kanały
| Nazwa | Opis | Wartość |
|---|---|---|
| etag | Tag jednostki. | ciąg |
| rodzaj | Wymagane. Pobiera lub ustawia rodzaj zasobu. | "azurebot" "bot" "projektant" "function" "sdk" |
| lokalizacja | Określa lokalizację zasobu. | ciąg |
| nazwa | Nazwa zasobu | "AcsChatChannel" "AlexaChannel" "DirectLineChannel" "DirectLineSpeechChannel" "EmailChannel" "FacebookChannel" "KikChannel" "LineChannel" "M365Extensions" "MsTeamsChannel" "Omnichannel" "OutlookChannel" "SearchAssistant" "SkypeChannel" "SlackChannel" "SmsChannel" "TelegramChannel" "TelefoniaChannel" "WebChatChannel" (wymagane) |
| nadrzędny | W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym. Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym. |
Nazwa symboliczna zasobu typu: botServices |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału bota | kanału |
| Numer jednostki magazynowej | Pobiera lub ustawia jednostkę SKU zasobu. | sku |
| Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
Kanał AcsChatChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "AcsChatChannel" (wymagane) |
AlexaKanał
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "AlexaChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału Alexa | AlexaChannelProperties (Właściwości kanału Alexa) |
AlexaChannelProperties (Właściwości kanału Alexa)
| Nazwa | Opis | Wartość |
|---|---|---|
| alexaSkillId (identyfikator alexaSkillId) | Identyfikator umiejętności Alexa | ciąg (wymagany) |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
Tagi kanału bota
| Nazwa | Opis | Wartość |
|---|
Kanał
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Ustaw wartość "AcsChatChannel" dla typu AcsChatChannel. Ustaw wartość "AlexaChannel" dla typu AlexaChannel. Ustaw wartość "DirectLineChannel" dla typu DirectLineChannel. Ustaw wartość "DirectLineSpeechChannel" dla typu DirectLineSpeechChannel. Ustaw wartość "EmailChannel" dla typu EmailChannel. Ustaw wartość "FacebookChannel" dla typu FacebookChannel. Ustaw wartość "KikChannel" dla typu KikChannel. Ustaw wartość "LineChannel" dla typu LineChannel. Ustaw wartość "M365Extensions" dla typu M365Extensions. Ustaw wartość "MsTeamsChannel" dla typu MsTeamsChannel. Ustaw wartość "Omnichannel" dla typu Omnichannel. Ustaw wartość "OutlookChannel" dla typu OutlookChannel. Ustaw wartość "SearchAssistant" dla typu SearchAssistant. Ustaw wartość "SkypeChannel" dla typu SkypeChannel. Ustaw wartość "SlackChannel" dla typu SlackChannel. Ustaw wartość "SmsChannel" dla typu SmsChannel. Ustaw wartość "TelegramChannel" dla typu TelegramChannel. Ustaw wartość "TelefoniaChannel" dla typu TelefonyChannel. Ustaw wartość "WebChatChannel" dla typu WebChatChannel. | "AcsChatChannel" "AlexaChannel" "DirectLineChannel" "DirectLineSpeechChannel" "EmailChannel" "FacebookChannel" "KikChannel" "LineChannel" "M365Extensions" "MsTeamsChannel" "Omnichannel" "OutlookChannel" "SearchAssistant" "SkypeChannel" "SlackChannel" "SmsChannel" "TelegramChannel" "TelefoniaChannel" "WebChatChannel" (wymagane) |
| etag | Tag jednostki zasobu | ciąg |
| lokalizacja | Określa lokalizację zasobu. | ciąg |
Kanał DirectLineChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "DirectLineChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału direct line | |
Właściwość DirectLineChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| DirectLineEmbedCode | Kod osadzania w wierszu bezpośrednim zasobu | ciąg |
| extensionKey1 (KluczRozszerzenie1) | ExtensionKey1 | ciąg |
| extensionKey2 (Klucz rozszerzenia2) | ExtensionKey2 | ciąg |
| Witryn | Lista witryn direct line | DirectLineSite[] |
DirectLineSite (Witryna bezpośrednia)
| Nazwa | Opis | Wartość |
|---|---|---|
| Identyfikator aplikacji | Identyfikator aplikacji DirectLine | ciąg |
| Znacznik elektroniczny (eTag) | Tag jednostki | ciąg |
| isBlockUserUploadEnabled | Określa, czy ta witryna jest włączona na potrzeby blokowania przekazywania użytkowników. | Bool |
| isDetailedLoggingEnabled | Czy ta witryna jest wyłączona szczegółowe rejestrowanie dla | Bool |
| jest włączony | Czy ta witryna jest włączona dla kanału DirectLine | bool (wymagane) |
| isEndpointParametersEnabled | Czy ta witryna jest włączona dla kanału EndpointParameters | Bool |
| isNoStorageEnabled (Włączona pamięć masowa) | Czy ta lokacja magazynu nie jest wyłączona, szczegółowe rejestrowanie dla | Bool |
| isSecureSiteEnabled (Włączona witryna) | Określa, czy ta witryna jest włączona do uwierzytelniania za pomocą platformy Bot Framework. | Bool |
| isV1Enabled (Włączone w standardzie isV1) | Określa, czy ta witryna jest włączona dla protokołu Bot Framework V1. | Bool |
| isV3Enabled (Obsługa standardu) | Określa, czy ta witryna jest włączona dla protokołu Bot Framework V3. | Bool |
| isWebchatPreviewEnabled | Czy ta witryna jest włączona dla wersji zapoznawczej webchat | Bool |
| isWebChatSpeechEnabled | Określa, czy ta witryna jest włączona dla mowy webchat | Bool |
| nazwa_witryny | Nazwa witryny | ciąg (wymagany) |
| Identyfikator najemcy | Identyfikator dzierżawy | ciąg |
| trustedOrigins (Pochodzenie zaufane) | Lista zaufanych adresów URL źródeł dla tej witryny. To pole ma zastosowanie tylko wtedy, gdy wartość isSecureSiteEnabled ma wartość True. | ciąg znakowy[] |
DirectLineSpeechChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "DirectLineSpeechChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału mowy directline | |
Właściwość DirectLineSpeechChannelProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| Region usług kognitywnych | Region usługi Cognitive Service z tą rejestracją kanału. | ciąg |
| cognitiveServiceResourceId | Identyfikator usługi Cognitive Service z tą rejestracją kanału. | ciąg |
| cognitiveServiceSubscriptionKey | Klucz subskrypcji usługi Cognitive Service do użycia z tą rejestracją kanału. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| customSpeechModelId | Niestandardowy identyfikator wdrożenia głosowego (opcjonalnie). | ciąg |
| customVoiceDeploymentId | Identyfikator niestandardowego modelu mowy (opcjonalnie). | ciąg |
| isDefaultBotForCogSvcAccount | Ustaw go jako domyślnego bota dla wybranego konta usługi Cognitive Service. | Bool |
| jest włączony | Bez względu na to, czy ten kanał jest włączony, czy nie. | Bool |
Kanał poczty e-mail
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "EmailChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału poczty e-mail | |
Właściwości EmailChannelProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| authMethod (metoda uwierzytelniania) | Metoda uwierzytelniania kanału poczty e-mail. 0 Hasło (ustawienie domyślne); 1 Wykres. | Int |
| adres e-mail | Adres e-mail | ciąg (wymagany) |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
| magicCode (kod magiczny) | Kod magiczny do konfigurowania nowoczesnego uwierzytelniania. | ciąg |
| hasło | Hasło adresu e-mail. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | ciąg |
Kanał Facebooka
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "FacebookChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla kanału facebook bota | Właściwości kanału Facebooka |
Właściwości kanału Facebooka
Strona na Facebooku
| Nazwa | Opis | Wartość |
|---|---|---|
| accessToken | Token dostępu do aplikacji serwisu Facebook. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| id | Identyfikator strony | ciąg (wymagany) |
Kanał KikChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "KikChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału Kik | Właściwości KikChannelProperties |
Właściwości KikChannelProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| Klucz apiKey | Klucz interfejsu API Kik. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | ciąg |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
| isValidated (Zweryfikowany) | Czy ten kanał jest weryfikowany dla bota | Bool |
| userName | Nazwa użytkownika Kik | ciąg (wymagany) |
LineChannel (Kanał linii)
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "LineChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału liniowego | Właściwości kanału linii |
Właściwości kanału linii
| Nazwa | Opis | Wartość |
|---|---|---|
| lineRejestracje | Lista rejestracji kanału liniowego | LineRegistration[] (wymagane) |
Rejestracja linii
| Nazwa | Opis | Wartość |
|---|---|---|
| Token dostępu do kanału | Token dostępu do rejestracji kanału liniowego | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| kanałTajne | Wpis tajny rejestracji kanału liniowego | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
Rozszerzenia M365Extensions
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "M365Extensions" (wymagane) |
MsTeamsChannel (kanał MsTeams)
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "MsTeamsChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału usługi Microsoft Teams | MsTeamsChannelProperties |
MsTeamsChannelProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| zaakceptowaneWarunki | Czy ten kanał zaakceptował warunki | Bool |
| wywoływanie elementuWebhook | Element webhook dla wywołań kanału usługi Microsoft Teams | ciąg |
| deploymentEnvironment (środowisko wdrożenia) | Środowisko wdrażania dla wywołań kanału usługi Microsoft Teams | ciąg |
| enableCalling (Połączenia włączone) | Włączanie wywoływania kanału usługi Microsoft Teams | Bool |
| incomingCallRoute (trasa połączenia przychodzącego) | Element webhook dla wywołań kanału usługi Microsoft Teams | ciąg |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
Wielokanałowy
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "Omnichannel" (wymagane) |
Kanał OutlookChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "OutlookChannel" (wymagany) |
Asystent wyszukiwania
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "SearchAssistant" (wymagane) |
Numer jednostki magazynowej
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa | Nazwa jednostki SKU | "F0" "S1" (wymagany) |
Kanał SkypeChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "SkypeChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału Skype | SkypeChannelProperties |
Właściwości kanału SkypeChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| wywoływanie elementuWebHook | Nawiązywanie połączenia z elementem webhook dla kanału Skype | ciąg |
| enableCalling (Połączenia włączone) | Włączanie połączeń dla kanału Skype | Bool |
| enableGroups (grupy włączeń) | Włączanie grup dla kanału Skype | Bool |
| enableMediaCards (włącz karty multimedialne) | Włączanie kart multimedialnych dla kanału Skype | Bool |
| enableMessaging (włącz wiadomości) | Włączanie obsługi wiadomości dla kanału Skype | Bool |
| enableUdostępnianie ekranu | Włączanie udostępniania ekranu dla kanału Skype | Bool |
| enableVideo (włącz wideo) | Włączanie wideo dla kanału Skype | Bool |
| Tryb grup | Tryb grupy dla kanału Skype | ciąg |
| incomingCallRoute (trasa połączenia przychodzącego) | Trasa połączeń przychodzących dla kanału skype'a | ciąg |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
Kanał SlackChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "SlackChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału usługi Slack | |
Właściwości SlackChannelProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| clientId (identyfikator klienta) | Identyfikator klienta usługi Slack | ciąg |
| tajemnica klienta | Wpis tajny klienta usługi Slack. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
| landingPageUrl (adres URL strony docelowej) | Adres URL strony docelowej usługi Slack | ciąg |
| registerBeforeOAuthFlow | Określa, czy należy zarejestrować ustawienia przed wykonaniem weryfikacji protokołu OAuth. Zalecane do wartości True. | Bool |
| Zakresów | Zakresy uprawnień usługi Slack. | ciąg |
| podpisywanie Tajne | Wpis tajny podpisywania usługi Slack. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| verificationToken (token weryfikacji) | Token weryfikacji usługi Slack. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
Kanał SmsChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "SmsChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału sms | SmsChannelProperties |
Właściwości kanału SmsChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| identyfikator konta | Identyfikator SID konta sms. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | ciąg (wymagany) |
| Token uwierzytelniania (authToken) | Token uwierzytelniania wiadomości SMS. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
| isValidated (Zweryfikowany) | Czy ten kanał jest weryfikowany dla bota | Bool |
| Telefon | Telefon SMS | ciąg (wymagany) |
Kanał telegramu
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "TelegramChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału Telegram | TelegramChannelWłaściwości |
TelegramChannelWłaściwości
| Nazwa | Opis | Wartość |
|---|---|---|
| accessToken | Token dostępu usługi Telegram. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
| isValidated (Zweryfikowany) | Czy ten kanał jest weryfikowany dla bota | Bool |
TelefoniaChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "TelefoniaChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału telefonii | TelefoniaChannelWłaściwości |
TelefoniaChannelWłaściwości
| Nazwa | Opis | Wartość |
|---|---|---|
| apiKonfiguracje | Lista konfiguracji interfejsu API telefonii | TelefoniaChannelResourceApiConfiguration[] |
| Region usług kognitywnych | ExtensionKey2 | ciąg |
| cognitiveServiceSubscriptionKey | ExtensionKey1 | ciąg |
| defaultLocale (ustawienia regionalne) | Domyślne ustawienia regionalne kanału | ciąg |
| jest włączony | Czy kanał jest włączony | Bool |
| phoneNumbers (numery telefonów) | Lista numerów telefonów telefonii | telefoniiPhoneNumbers[] |
| Jednostka premium SKU | Jednostka SKU w warstwie Premium zastosowana do kanału | ciąg |
TelefoniaChannelResourceApiConfiguration
| Nazwa | Opis | Wartość |
|---|---|---|
| Region usług kognitywnych | Region usługi Cognitive Service. | ciąg |
| cognitiveServiceResourceId | Identyfikator zasobu usługi Cognitive Service. | ciąg |
| cognitiveServiceSubscriptionKey | Klucz subskrypcji usługi Cognitive Service. | ciąg |
| defaultLocale (ustawienia regionalne) | Domyślne ustawienia regionalne. | ciąg |
| id | Identyfikator konfiguracji. | ciąg |
| nazwaDostawcy | Nazwa dostawcy. | ciąg |
Numer telefonu
| Nazwa | Opis | Wartość |
|---|---|---|
| acsEndpoint (punkt końcowy acs) | Punkt końcowy usługi ACS. | ciąg |
| acsResourceId (identyfikator zasobu) | Identyfikator zasobu usługi ACS. | ciąg |
| acsTajne | Tajemnica ACS. | ciąg |
| Region usług kognitywnych | Region usługi Cognitive Service. | ciąg |
| cognitiveServiceResourceId | Identyfikator zasobu usługi Cognitive Service. | ciąg |
| cognitiveServiceSubscriptionKey | Klucz subskrypcji usługi Cognitive Service. | ciąg |
| defaultLocale (ustawienia regionalne) | Domyślne ustawienia regionalne numeru telefonu. | ciąg |
| id | Identyfikator elementu. | ciąg |
| Typ oferty | Opcjonalna właściwość, która określi typ oferty telefonu. | ciąg |
| numer telefonu | Numer telefonu. | ciąg |
Kanał czatu internetowego
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "WebChatChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału czatu internetowego | WebChatChannelProperties (Właściwości kanału WebChat) |
WebChatChannelProperties (Właściwości kanału WebChat)
| Nazwa | Opis | Wartość |
|---|---|---|
| Witryn | Lista witryn czatu internetowego | WebChatSite [] |
Witryna WebChatSite
| Nazwa | Opis | Wartość |
|---|---|---|
| Identyfikator aplikacji | Identyfikator aplikacji DirectLine | ciąg |
| Znacznik elektroniczny (eTag) | Tag jednostki | ciąg |
| isBlockUserUploadEnabled | Określa, czy ta witryna jest włączona na potrzeby blokowania przekazywania użytkowników. | Bool |
| isDetailedLoggingEnabled | Czy ta witryna jest wyłączona szczegółowe rejestrowanie dla | Bool |
| jest włączony | Czy ta witryna jest włączona dla kanału DirectLine | bool (wymagane) |
| isEndpointParametersEnabled | Czy ta witryna jest włączona dla kanału EndpointParameters | Bool |
| isNoStorageEnabled (Włączona pamięć masowa) | Czy ta lokacja magazynu nie jest wyłączona, szczegółowe rejestrowanie dla | Bool |
| isSecureSiteEnabled (Włączona witryna) | Określa, czy ta witryna jest włączona do uwierzytelniania za pomocą platformy Bot Framework. | Bool |
| isV1Enabled (Włączone w standardzie isV1) | Określa, czy ta witryna jest włączona dla protokołu Bot Framework V1. | Bool |
| isV3Enabled (Obsługa standardu) | Określa, czy ta witryna jest włączona dla protokołu Bot Framework V3. | Bool |
| isWebchatPreviewEnabled | Czy ta witryna jest włączona dla wersji zapoznawczej webchat | Bool |
| isWebChatSpeechEnabled | Określa, czy ta witryna jest włączona dla mowy webchat | Bool |
| nazwa_witryny | Nazwa witryny | ciąg (wymagany) |
| Identyfikator najemcy | Identyfikator dzierżawy | ciąg |
| trustedOrigins (Pochodzenie zaufane) | Lista zaufanych adresów URL źródeł dla tej witryny. To pole ma zastosowanie tylko wtedy, gdy wartość isSecureSiteEnabled ma wartość True. | ciąg znakowy[] |
Definicja zasobu szablonu usługi ARM
Typ zasobu botServices/kanały 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/channels, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.BotService/botServices/channels",
"apiVersion": "2023-09-15-preview",
"name": "string",
"etag": "string",
"kind": "string",
"location": "string",
"properties": {
"etag": "string",
"location": "string",
"channelName": "string"
// For remaining properties, see Channel objects
},
"sku": {
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Obiekty kanału
Ustaw właściwość channelName, aby określić typ obiektu.
W przypadku acsChatChannelużyj:
{
"channelName": "AcsChatChannel"
}
W przypadku AlexaChannel użyj:
{
"channelName": "AlexaChannel",
"properties": {
"alexaSkillId": "string",
"isEnabled": "bool"
}
}
W przypadku DirectLineChannel użyj:
{
"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" ]
}
]
}
}
W przypadku DirectLineSpeechChannelużyj:
{
"channelName": "DirectLineSpeechChannel",
"properties": {
"cognitiveServiceRegion": "string",
"cognitiveServiceResourceId": "string",
"cognitiveServiceSubscriptionKey": "string",
"customSpeechModelId": "string",
"customVoiceDeploymentId": "string",
"isDefaultBotForCogSvcAccount": "bool",
"isEnabled": "bool"
}
}
W przypadku EmailChannelużyj:
{
"channelName": "EmailChannel",
"properties": {
"authMethod": "int",
"emailAddress": "string",
"isEnabled": "bool",
"magicCode": "string",
"password": "string"
}
}
W przypadku FacebookChannel użyj:
{
"channelName": "FacebookChannel",
"properties": {
"appId": "string",
"appSecret": "string",
"isEnabled": "bool",
"pages": [
{
"accessToken": "string",
"id": "string"
}
]
}
}
W przypadku KikChannel użyj:
{
"channelName": "KikChannel",
"properties": {
"apiKey": "string",
"isEnabled": "bool",
"isValidated": "bool",
"userName": "string"
}
}
W przypadku LineChannelużyj:
{
"channelName": "LineChannel",
"properties": {
"lineRegistrations": [
{
"channelAccessToken": "string",
"channelSecret": "string"
}
]
}
}
W przypadku M365Extensionsużyj:
{
"channelName": "M365Extensions"
}
W przypadku MsTeamsChannelużyj:
{
"channelName": "MsTeamsChannel",
"properties": {
"acceptedTerms": "bool",
"callingWebhook": "string",
"deploymentEnvironment": "string",
"enableCalling": "bool",
"incomingCallRoute": "string",
"isEnabled": "bool"
}
}
W przypadku omnichannelużyj:
{
"channelName": "Omnichannel"
}
W przypadku programu OutlookChannelużyj:
{
"channelName": "OutlookChannel"
}
W przypadku SearchAssistantużyj:
{
"channelName": "SearchAssistant"
}
W przypadku SkypeChannel użyj:
{
"channelName": "SkypeChannel",
"properties": {
"callingWebHook": "string",
"enableCalling": "bool",
"enableGroups": "bool",
"enableMediaCards": "bool",
"enableMessaging": "bool",
"enableScreenSharing": "bool",
"enableVideo": "bool",
"groupsMode": "string",
"incomingCallRoute": "string",
"isEnabled": "bool"
}
}
W przypadku SlackChannel użyj:
{
"channelName": "SlackChannel",
"properties": {
"clientId": "string",
"clientSecret": "string",
"isEnabled": "bool",
"landingPageUrl": "string",
"registerBeforeOAuthFlow": "bool",
"scopes": "string",
"signingSecret": "string",
"verificationToken": "string"
}
}
W przypadku SmsChannel użyj:
{
"channelName": "SmsChannel",
"properties": {
"accountSID": "string",
"authToken": "string",
"isEnabled": "bool",
"isValidated": "bool",
"phone": "string"
}
}
W przypadku TelegramChannelużyj:
{
"channelName": "TelegramChannel",
"properties": {
"accessToken": "string",
"isEnabled": "bool",
"isValidated": "bool"
}
}
W przypadku TelefoniiChannelużyj:
{
"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"
}
}
W przypadku WebChatChannel użyj:
{
"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" ]
}
]
}
}
Wartości właściwości
Microsoft.BotService/usługiBotów/kanały
| Nazwa | Opis | Wartość |
|---|---|---|
| apiVersion (wersja interfejsu api) | Wersja interfejsu API | "2023-09-15-preview" |
| etag | Tag jednostki. | ciąg |
| rodzaj | Wymagane. Pobiera lub ustawia rodzaj zasobu. | "azurebot" "bot" "projektant" "function" "sdk" |
| lokalizacja | Określa lokalizację zasobu. | ciąg |
| nazwa | Nazwa zasobu | "AcsChatChannel" "AlexaChannel" "DirectLineChannel" "DirectLineSpeechChannel" "EmailChannel" "FacebookChannel" "KikChannel" "LineChannel" "M365Extensions" "MsTeamsChannel" "Omnichannel" "OutlookChannel" "SearchAssistant" "SkypeChannel" "SlackChannel" "SmsChannel" "TelegramChannel" "TelefoniaChannel" "WebChatChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału bota | kanału |
| Numer jednostki magazynowej | Pobiera lub ustawia jednostkę SKU zasobu. | sku |
| Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
| typ | Typ zasobu | "Microsoft.BotService/botServices/channels" |
Kanał AcsChatChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "AcsChatChannel" (wymagane) |
AlexaKanał
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "AlexaChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału Alexa | AlexaChannelProperties (Właściwości kanału Alexa) |
AlexaChannelProperties (Właściwości kanału Alexa)
| Nazwa | Opis | Wartość |
|---|---|---|
| alexaSkillId (identyfikator alexaSkillId) | Identyfikator umiejętności Alexa | ciąg (wymagany) |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
Tagi kanału bota
| Nazwa | Opis | Wartość |
|---|
Kanał
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Ustaw wartość "AcsChatChannel" dla typu AcsChatChannel. Ustaw wartość "AlexaChannel" dla typu AlexaChannel. Ustaw wartość "DirectLineChannel" dla typu DirectLineChannel. Ustaw wartość "DirectLineSpeechChannel" dla typu DirectLineSpeechChannel. Ustaw wartość "EmailChannel" dla typu EmailChannel. Ustaw wartość "FacebookChannel" dla typu FacebookChannel. Ustaw wartość "KikChannel" dla typu KikChannel. Ustaw wartość "LineChannel" dla typu LineChannel. Ustaw wartość "M365Extensions" dla typu M365Extensions. Ustaw wartość "MsTeamsChannel" dla typu MsTeamsChannel. Ustaw wartość "Omnichannel" dla typu Omnichannel. Ustaw wartość "OutlookChannel" dla typu OutlookChannel. Ustaw wartość "SearchAssistant" dla typu SearchAssistant. Ustaw wartość "SkypeChannel" dla typu SkypeChannel. Ustaw wartość "SlackChannel" dla typu SlackChannel. Ustaw wartość "SmsChannel" dla typu SmsChannel. Ustaw wartość "TelegramChannel" dla typu TelegramChannel. Ustaw wartość "TelefoniaChannel" dla typu TelefonyChannel. Ustaw wartość "WebChatChannel" dla typu WebChatChannel. | "AcsChatChannel" "AlexaChannel" "DirectLineChannel" "DirectLineSpeechChannel" "EmailChannel" "FacebookChannel" "KikChannel" "LineChannel" "M365Extensions" "MsTeamsChannel" "Omnichannel" "OutlookChannel" "SearchAssistant" "SkypeChannel" "SlackChannel" "SmsChannel" "TelegramChannel" "TelefoniaChannel" "WebChatChannel" (wymagane) |
| etag | Tag jednostki zasobu | ciąg |
| lokalizacja | Określa lokalizację zasobu. | ciąg |
Kanał DirectLineChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "DirectLineChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału direct line | |
Właściwość DirectLineChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| DirectLineEmbedCode | Kod osadzania w wierszu bezpośrednim zasobu | ciąg |
| extensionKey1 (KluczRozszerzenie1) | ExtensionKey1 | ciąg |
| extensionKey2 (Klucz rozszerzenia2) | ExtensionKey2 | ciąg |
| Witryn | Lista witryn direct line | DirectLineSite[] |
DirectLineSite (Witryna bezpośrednia)
| Nazwa | Opis | Wartość |
|---|---|---|
| Identyfikator aplikacji | Identyfikator aplikacji DirectLine | ciąg |
| Znacznik elektroniczny (eTag) | Tag jednostki | ciąg |
| isBlockUserUploadEnabled | Określa, czy ta witryna jest włączona na potrzeby blokowania przekazywania użytkowników. | Bool |
| isDetailedLoggingEnabled | Czy ta witryna jest wyłączona szczegółowe rejestrowanie dla | Bool |
| jest włączony | Czy ta witryna jest włączona dla kanału DirectLine | bool (wymagane) |
| isEndpointParametersEnabled | Czy ta witryna jest włączona dla kanału EndpointParameters | Bool |
| isNoStorageEnabled (Włączona pamięć masowa) | Czy ta lokacja magazynu nie jest wyłączona, szczegółowe rejestrowanie dla | Bool |
| isSecureSiteEnabled (Włączona witryna) | Określa, czy ta witryna jest włączona do uwierzytelniania za pomocą platformy Bot Framework. | Bool |
| isV1Enabled (Włączone w standardzie isV1) | Określa, czy ta witryna jest włączona dla protokołu Bot Framework V1. | Bool |
| isV3Enabled (Obsługa standardu) | Określa, czy ta witryna jest włączona dla protokołu Bot Framework V3. | Bool |
| isWebchatPreviewEnabled | Czy ta witryna jest włączona dla wersji zapoznawczej webchat | Bool |
| isWebChatSpeechEnabled | Określa, czy ta witryna jest włączona dla mowy webchat | Bool |
| nazwa_witryny | Nazwa witryny | ciąg (wymagany) |
| Identyfikator najemcy | Identyfikator dzierżawy | ciąg |
| trustedOrigins (Pochodzenie zaufane) | Lista zaufanych adresów URL źródeł dla tej witryny. To pole ma zastosowanie tylko wtedy, gdy wartość isSecureSiteEnabled ma wartość True. | ciąg znakowy[] |
DirectLineSpeechChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "DirectLineSpeechChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału mowy directline | |
Właściwość DirectLineSpeechChannelProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| Region usług kognitywnych | Region usługi Cognitive Service z tą rejestracją kanału. | ciąg |
| cognitiveServiceResourceId | Identyfikator usługi Cognitive Service z tą rejestracją kanału. | ciąg |
| cognitiveServiceSubscriptionKey | Klucz subskrypcji usługi Cognitive Service do użycia z tą rejestracją kanału. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| customSpeechModelId | Niestandardowy identyfikator wdrożenia głosowego (opcjonalnie). | ciąg |
| customVoiceDeploymentId | Identyfikator niestandardowego modelu mowy (opcjonalnie). | ciąg |
| isDefaultBotForCogSvcAccount | Ustaw go jako domyślnego bota dla wybranego konta usługi Cognitive Service. | Bool |
| jest włączony | Bez względu na to, czy ten kanał jest włączony, czy nie. | Bool |
Kanał poczty e-mail
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "EmailChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału poczty e-mail | |
Właściwości EmailChannelProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| authMethod (metoda uwierzytelniania) | Metoda uwierzytelniania kanału poczty e-mail. 0 Hasło (ustawienie domyślne); 1 Wykres. | Int |
| adres e-mail | Adres e-mail | ciąg (wymagany) |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
| magicCode (kod magiczny) | Kod magiczny do konfigurowania nowoczesnego uwierzytelniania. | ciąg |
| hasło | Hasło adresu e-mail. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | ciąg |
Kanał Facebooka
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "FacebookChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla kanału facebook bota | Właściwości kanału Facebooka |
Właściwości kanału Facebooka
Strona na Facebooku
| Nazwa | Opis | Wartość |
|---|---|---|
| accessToken | Token dostępu do aplikacji serwisu Facebook. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| id | Identyfikator strony | ciąg (wymagany) |
Kanał KikChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "KikChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału Kik | Właściwości KikChannelProperties |
Właściwości KikChannelProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| Klucz apiKey | Klucz interfejsu API Kik. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | ciąg |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
| isValidated (Zweryfikowany) | Czy ten kanał jest weryfikowany dla bota | Bool |
| userName | Nazwa użytkownika Kik | ciąg (wymagany) |
LineChannel (Kanał linii)
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "LineChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału liniowego | Właściwości kanału linii |
Właściwości kanału linii
| Nazwa | Opis | Wartość |
|---|---|---|
| lineRejestracje | Lista rejestracji kanału liniowego | LineRegistration[] (wymagane) |
Rejestracja linii
| Nazwa | Opis | Wartość |
|---|---|---|
| Token dostępu do kanału | Token dostępu do rejestracji kanału liniowego | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| kanałTajne | Wpis tajny rejestracji kanału liniowego | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
Rozszerzenia M365Extensions
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "M365Extensions" (wymagane) |
MsTeamsChannel (kanał MsTeams)
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "MsTeamsChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału usługi Microsoft Teams | MsTeamsChannelProperties |
MsTeamsChannelProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| zaakceptowaneWarunki | Czy ten kanał zaakceptował warunki | Bool |
| wywoływanie elementuWebhook | Element webhook dla wywołań kanału usługi Microsoft Teams | ciąg |
| deploymentEnvironment (środowisko wdrożenia) | Środowisko wdrażania dla wywołań kanału usługi Microsoft Teams | ciąg |
| enableCalling (Połączenia włączone) | Włączanie wywoływania kanału usługi Microsoft Teams | Bool |
| incomingCallRoute (trasa połączenia przychodzącego) | Element webhook dla wywołań kanału usługi Microsoft Teams | ciąg |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
Wielokanałowy
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "Omnichannel" (wymagane) |
Kanał OutlookChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "OutlookChannel" (wymagany) |
Asystent wyszukiwania
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "SearchAssistant" (wymagane) |
Numer jednostki magazynowej
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa | Nazwa jednostki SKU | "F0" "S1" (wymagany) |
Kanał SkypeChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "SkypeChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału Skype | SkypeChannelProperties |
Właściwości kanału SkypeChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| wywoływanie elementuWebHook | Nawiązywanie połączenia z elementem webhook dla kanału Skype | ciąg |
| enableCalling (Połączenia włączone) | Włączanie połączeń dla kanału Skype | Bool |
| enableGroups (grupy włączeń) | Włączanie grup dla kanału Skype | Bool |
| enableMediaCards (włącz karty multimedialne) | Włączanie kart multimedialnych dla kanału Skype | Bool |
| enableMessaging (włącz wiadomości) | Włączanie obsługi wiadomości dla kanału Skype | Bool |
| enableUdostępnianie ekranu | Włączanie udostępniania ekranu dla kanału Skype | Bool |
| enableVideo (włącz wideo) | Włączanie wideo dla kanału Skype | Bool |
| Tryb grup | Tryb grupy dla kanału Skype | ciąg |
| incomingCallRoute (trasa połączenia przychodzącego) | Trasa połączeń przychodzących dla kanału skype'a | ciąg |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
Kanał SlackChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "SlackChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału usługi Slack | |
Właściwości SlackChannelProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| clientId (identyfikator klienta) | Identyfikator klienta usługi Slack | ciąg |
| tajemnica klienta | Wpis tajny klienta usługi Slack. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
| landingPageUrl (adres URL strony docelowej) | Adres URL strony docelowej usługi Slack | ciąg |
| registerBeforeOAuthFlow | Określa, czy należy zarejestrować ustawienia przed wykonaniem weryfikacji protokołu OAuth. Zalecane do wartości True. | Bool |
| Zakresów | Zakresy uprawnień usługi Slack. | ciąg |
| podpisywanie Tajne | Wpis tajny podpisywania usługi Slack. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| verificationToken (token weryfikacji) | Token weryfikacji usługi Slack. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
Kanał SmsChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "SmsChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału sms | SmsChannelProperties |
Właściwości kanału SmsChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| identyfikator konta | Identyfikator SID konta sms. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | ciąg (wymagany) |
| Token uwierzytelniania (authToken) | Token uwierzytelniania wiadomości SMS. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
| isValidated (Zweryfikowany) | Czy ten kanał jest weryfikowany dla bota | Bool |
| Telefon | Telefon SMS | ciąg (wymagany) |
Kanał telegramu
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "TelegramChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału Telegram | TelegramChannelWłaściwości |
TelegramChannelWłaściwości
| Nazwa | Opis | Wartość |
|---|---|---|
| accessToken | Token dostępu usługi Telegram. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
| isValidated (Zweryfikowany) | Czy ten kanał jest weryfikowany dla bota | Bool |
TelefoniaChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "TelefoniaChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału telefonii | TelefoniaChannelWłaściwości |
TelefoniaChannelWłaściwości
| Nazwa | Opis | Wartość |
|---|---|---|
| apiKonfiguracje | Lista konfiguracji interfejsu API telefonii | TelefoniaChannelResourceApiConfiguration[] |
| Region usług kognitywnych | ExtensionKey2 | ciąg |
| cognitiveServiceSubscriptionKey | ExtensionKey1 | ciąg |
| defaultLocale (ustawienia regionalne) | Domyślne ustawienia regionalne kanału | ciąg |
| jest włączony | Czy kanał jest włączony | Bool |
| phoneNumbers (numery telefonów) | Lista numerów telefonów telefonii | telefoniiPhoneNumbers[] |
| Jednostka premium SKU | Jednostka SKU w warstwie Premium zastosowana do kanału | ciąg |
TelefoniaChannelResourceApiConfiguration
| Nazwa | Opis | Wartość |
|---|---|---|
| Region usług kognitywnych | Region usługi Cognitive Service. | ciąg |
| cognitiveServiceResourceId | Identyfikator zasobu usługi Cognitive Service. | ciąg |
| cognitiveServiceSubscriptionKey | Klucz subskrypcji usługi Cognitive Service. | ciąg |
| defaultLocale (ustawienia regionalne) | Domyślne ustawienia regionalne. | ciąg |
| id | Identyfikator konfiguracji. | ciąg |
| nazwaDostawcy | Nazwa dostawcy. | ciąg |
Numer telefonu
| Nazwa | Opis | Wartość |
|---|---|---|
| acsEndpoint (punkt końcowy acs) | Punkt końcowy usługi ACS. | ciąg |
| acsResourceId (identyfikator zasobu) | Identyfikator zasobu usługi ACS. | ciąg |
| acsTajne | Tajemnica ACS. | ciąg |
| Region usług kognitywnych | Region usługi Cognitive Service. | ciąg |
| cognitiveServiceResourceId | Identyfikator zasobu usługi Cognitive Service. | ciąg |
| cognitiveServiceSubscriptionKey | Klucz subskrypcji usługi Cognitive Service. | ciąg |
| defaultLocale (ustawienia regionalne) | Domyślne ustawienia regionalne numeru telefonu. | ciąg |
| id | Identyfikator elementu. | ciąg |
| Typ oferty | Opcjonalna właściwość, która określi typ oferty telefonu. | ciąg |
| numer telefonu | Numer telefonu. | ciąg |
Kanał czatu internetowego
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "WebChatChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału czatu internetowego | WebChatChannelProperties (Właściwości kanału WebChat) |
WebChatChannelProperties (Właściwości kanału WebChat)
| Nazwa | Opis | Wartość |
|---|---|---|
| Witryn | Lista witryn czatu internetowego | WebChatSite [] |
Witryna WebChatSite
| Nazwa | Opis | Wartość |
|---|---|---|
| Identyfikator aplikacji | Identyfikator aplikacji DirectLine | ciąg |
| Znacznik elektroniczny (eTag) | Tag jednostki | ciąg |
| isBlockUserUploadEnabled | Określa, czy ta witryna jest włączona na potrzeby blokowania przekazywania użytkowników. | Bool |
| isDetailedLoggingEnabled | Czy ta witryna jest wyłączona szczegółowe rejestrowanie dla | Bool |
| jest włączony | Czy ta witryna jest włączona dla kanału DirectLine | bool (wymagane) |
| isEndpointParametersEnabled | Czy ta witryna jest włączona dla kanału EndpointParameters | Bool |
| isNoStorageEnabled (Włączona pamięć masowa) | Czy ta lokacja magazynu nie jest wyłączona, szczegółowe rejestrowanie dla | Bool |
| isSecureSiteEnabled (Włączona witryna) | Określa, czy ta witryna jest włączona do uwierzytelniania za pomocą platformy Bot Framework. | Bool |
| isV1Enabled (Włączone w standardzie isV1) | Określa, czy ta witryna jest włączona dla protokołu Bot Framework V1. | Bool |
| isV3Enabled (Obsługa standardu) | Określa, czy ta witryna jest włączona dla protokołu Bot Framework V3. | Bool |
| isWebchatPreviewEnabled | Czy ta witryna jest włączona dla wersji zapoznawczej webchat | Bool |
| isWebChatSpeechEnabled | Określa, czy ta witryna jest włączona dla mowy webchat | Bool |
| nazwa_witryny | Nazwa witryny | ciąg (wymagany) |
| Identyfikator najemcy | Identyfikator dzierżawy | ciąg |
| trustedOrigins (Pochodzenie zaufane) | Lista zaufanych adresów URL źródeł dla tej witryny. To pole ma zastosowanie tylko wtedy, gdy wartość isSecureSiteEnabled ma wartość True. | ciąg znakowy[] |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu botServices/kanały 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 integracji dla kanału bota.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westus"
}
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 = var.location
body = {
kind = "bot"
properties = {
cmekKeyVaultUrl = ""
description = ""
developerAppInsightKey = ""
developerAppInsightsApiKey = ""
developerAppInsightsApplicationId = ""
displayName = var.resource_name
endpoint = ""
iconUrl = "https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png"
isCmekEnabled = false
isStreamingSupported = false
msaAppId = "12345678-1234-1234-1234-123456789012"
}
sku = {
name = "F0"
}
}
tags = {
environment = "production"
}
}
resource "azapi_resource" "channel" {
type = "Microsoft.BotService/botServices/channels@2021-05-01-preview"
parent_id = azapi_resource.botService.id
name = "AlexaChannel"
location = var.location
body = {
kind = "bot"
properties = {
channelName = "AlexaChannel"
properties = {
alexaSkillId = "amzn1.ask.skill.19126e57-867f-4553-b953-ad0a720dddec"
isEnabled = true
}
}
}
}
Format zasobu
Aby utworzyć zasób Microsoft.BotService/botServices/channels, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.BotService/botServices/channels@2023-09-15-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
etag = "string"
kind = "string"
properties = {
etag = "string"
location = "string"
channelName = "string"
// For remaining properties, see Channel objects
}
sku = {
name = "string"
}
}
}
Obiekty kanału
Ustaw właściwość channelName, aby określić typ obiektu.
W przypadku acsChatChannelużyj:
{
channelName = "AcsChatChannel"
}
W przypadku AlexaChannel użyj:
{
channelName = "AlexaChannel"
properties = {
alexaSkillId = "string"
isEnabled = bool
}
}
W przypadku DirectLineChannel użyj:
{
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"
]
}
]
}
}
W przypadku DirectLineSpeechChannelużyj:
{
channelName = "DirectLineSpeechChannel"
properties = {
cognitiveServiceRegion = "string"
cognitiveServiceResourceId = "string"
cognitiveServiceSubscriptionKey = "string"
customSpeechModelId = "string"
customVoiceDeploymentId = "string"
isDefaultBotForCogSvcAccount = bool
isEnabled = bool
}
}
W przypadku EmailChannelużyj:
{
channelName = "EmailChannel"
properties = {
authMethod = int
emailAddress = "string"
isEnabled = bool
magicCode = "string"
password = "string"
}
}
W przypadku FacebookChannel użyj:
{
channelName = "FacebookChannel"
properties = {
appId = "string"
appSecret = "string"
isEnabled = bool
pages = [
{
accessToken = "string"
id = "string"
}
]
}
}
W przypadku KikChannel użyj:
{
channelName = "KikChannel"
properties = {
apiKey = "string"
isEnabled = bool
isValidated = bool
userName = "string"
}
}
W przypadku LineChannelużyj:
{
channelName = "LineChannel"
properties = {
lineRegistrations = [
{
channelAccessToken = "string"
channelSecret = "string"
}
]
}
}
W przypadku M365Extensionsużyj:
{
channelName = "M365Extensions"
}
W przypadku MsTeamsChannelużyj:
{
channelName = "MsTeamsChannel"
properties = {
acceptedTerms = bool
callingWebhook = "string"
deploymentEnvironment = "string"
enableCalling = bool
incomingCallRoute = "string"
isEnabled = bool
}
}
W przypadku omnichannelużyj:
{
channelName = "Omnichannel"
}
W przypadku programu OutlookChannelużyj:
{
channelName = "OutlookChannel"
}
W przypadku SearchAssistantużyj:
{
channelName = "SearchAssistant"
}
W przypadku SkypeChannel użyj:
{
channelName = "SkypeChannel"
properties = {
callingWebHook = "string"
enableCalling = bool
enableGroups = bool
enableMediaCards = bool
enableMessaging = bool
enableScreenSharing = bool
enableVideo = bool
groupsMode = "string"
incomingCallRoute = "string"
isEnabled = bool
}
}
W przypadku SlackChannel użyj:
{
channelName = "SlackChannel"
properties = {
clientId = "string"
clientSecret = "string"
isEnabled = bool
landingPageUrl = "string"
registerBeforeOAuthFlow = bool
scopes = "string"
signingSecret = "string"
verificationToken = "string"
}
}
W przypadku SmsChannel użyj:
{
channelName = "SmsChannel"
properties = {
accountSID = "string"
authToken = "string"
isEnabled = bool
isValidated = bool
phone = "string"
}
}
W przypadku TelegramChannelużyj:
{
channelName = "TelegramChannel"
properties = {
accessToken = "string"
isEnabled = bool
isValidated = bool
}
}
W przypadku TelefoniiChannelużyj:
{
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"
}
}
W przypadku WebChatChannel użyj:
{
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"
]
}
]
}
}
Wartości właściwości
Microsoft.BotService/usługiBotów/kanały
| Nazwa | Opis | Wartość |
|---|---|---|
| etag | Tag jednostki. | ciąg |
| rodzaj | Wymagane. Pobiera lub ustawia rodzaj zasobu. | "azurebot" "bot" "projektant" "function" "sdk" |
| lokalizacja | Określa lokalizację zasobu. | ciąg |
| nazwa | Nazwa zasobu | "AcsChatChannel" "AlexaChannel" "DirectLineChannel" "DirectLineSpeechChannel" "EmailChannel" "FacebookChannel" "KikChannel" "LineChannel" "M365Extensions" "MsTeamsChannel" "Omnichannel" "OutlookChannel" "SearchAssistant" "SkypeChannel" "SlackChannel" "SmsChannel" "TelegramChannel" "TelefoniaChannel" "WebChatChannel" (wymagane) |
| parent_id (identyfikator rodzica) | Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. | Identyfikator zasobu typu: botServices |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału bota | kanału |
| Numer jednostki magazynowej | Pobiera lub ustawia jednostkę SKU zasobu. | sku |
| Tagi | Tagi zasobów | Słownik nazw tagów i wartości. |
| typ | Typ zasobu | "Microsoft.BotService/botServices/channels@2023-09-15-preview" |
Kanał AcsChatChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "AcsChatChannel" (wymagane) |
AlexaKanał
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "AlexaChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału Alexa | AlexaChannelProperties (Właściwości kanału Alexa) |
AlexaChannelProperties (Właściwości kanału Alexa)
| Nazwa | Opis | Wartość |
|---|---|---|
| alexaSkillId (identyfikator alexaSkillId) | Identyfikator umiejętności Alexa | ciąg (wymagany) |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
Tagi kanału bota
| Nazwa | Opis | Wartość |
|---|
Kanał
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Ustaw wartość "AcsChatChannel" dla typu AcsChatChannel. Ustaw wartość "AlexaChannel" dla typu AlexaChannel. Ustaw wartość "DirectLineChannel" dla typu DirectLineChannel. Ustaw wartość "DirectLineSpeechChannel" dla typu DirectLineSpeechChannel. Ustaw wartość "EmailChannel" dla typu EmailChannel. Ustaw wartość "FacebookChannel" dla typu FacebookChannel. Ustaw wartość "KikChannel" dla typu KikChannel. Ustaw wartość "LineChannel" dla typu LineChannel. Ustaw wartość "M365Extensions" dla typu M365Extensions. Ustaw wartość "MsTeamsChannel" dla typu MsTeamsChannel. Ustaw wartość "Omnichannel" dla typu Omnichannel. Ustaw wartość "OutlookChannel" dla typu OutlookChannel. Ustaw wartość "SearchAssistant" dla typu SearchAssistant. Ustaw wartość "SkypeChannel" dla typu SkypeChannel. Ustaw wartość "SlackChannel" dla typu SlackChannel. Ustaw wartość "SmsChannel" dla typu SmsChannel. Ustaw wartość "TelegramChannel" dla typu TelegramChannel. Ustaw wartość "TelefoniaChannel" dla typu TelefonyChannel. Ustaw wartość "WebChatChannel" dla typu WebChatChannel. | "AcsChatChannel" "AlexaChannel" "DirectLineChannel" "DirectLineSpeechChannel" "EmailChannel" "FacebookChannel" "KikChannel" "LineChannel" "M365Extensions" "MsTeamsChannel" "Omnichannel" "OutlookChannel" "SearchAssistant" "SkypeChannel" "SlackChannel" "SmsChannel" "TelegramChannel" "TelefoniaChannel" "WebChatChannel" (wymagane) |
| etag | Tag jednostki zasobu | ciąg |
| lokalizacja | Określa lokalizację zasobu. | ciąg |
Kanał DirectLineChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "DirectLineChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału direct line | |
Właściwość DirectLineChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| DirectLineEmbedCode | Kod osadzania w wierszu bezpośrednim zasobu | ciąg |
| extensionKey1 (KluczRozszerzenie1) | ExtensionKey1 | ciąg |
| extensionKey2 (Klucz rozszerzenia2) | ExtensionKey2 | ciąg |
| Witryn | Lista witryn direct line | DirectLineSite[] |
DirectLineSite (Witryna bezpośrednia)
| Nazwa | Opis | Wartość |
|---|---|---|
| Identyfikator aplikacji | Identyfikator aplikacji DirectLine | ciąg |
| Znacznik elektroniczny (eTag) | Tag jednostki | ciąg |
| isBlockUserUploadEnabled | Określa, czy ta witryna jest włączona na potrzeby blokowania przekazywania użytkowników. | Bool |
| isDetailedLoggingEnabled | Czy ta witryna jest wyłączona szczegółowe rejestrowanie dla | Bool |
| jest włączony | Czy ta witryna jest włączona dla kanału DirectLine | bool (wymagane) |
| isEndpointParametersEnabled | Czy ta witryna jest włączona dla kanału EndpointParameters | Bool |
| isNoStorageEnabled (Włączona pamięć masowa) | Czy ta lokacja magazynu nie jest wyłączona, szczegółowe rejestrowanie dla | Bool |
| isSecureSiteEnabled (Włączona witryna) | Określa, czy ta witryna jest włączona do uwierzytelniania za pomocą platformy Bot Framework. | Bool |
| isV1Enabled (Włączone w standardzie isV1) | Określa, czy ta witryna jest włączona dla protokołu Bot Framework V1. | Bool |
| isV3Enabled (Obsługa standardu) | Określa, czy ta witryna jest włączona dla protokołu Bot Framework V3. | Bool |
| isWebchatPreviewEnabled | Czy ta witryna jest włączona dla wersji zapoznawczej webchat | Bool |
| isWebChatSpeechEnabled | Określa, czy ta witryna jest włączona dla mowy webchat | Bool |
| nazwa_witryny | Nazwa witryny | ciąg (wymagany) |
| Identyfikator najemcy | Identyfikator dzierżawy | ciąg |
| trustedOrigins (Pochodzenie zaufane) | Lista zaufanych adresów URL źródeł dla tej witryny. To pole ma zastosowanie tylko wtedy, gdy wartość isSecureSiteEnabled ma wartość True. | ciąg znakowy[] |
DirectLineSpeechChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "DirectLineSpeechChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału mowy directline | |
Właściwość DirectLineSpeechChannelProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| Region usług kognitywnych | Region usługi Cognitive Service z tą rejestracją kanału. | ciąg |
| cognitiveServiceResourceId | Identyfikator usługi Cognitive Service z tą rejestracją kanału. | ciąg |
| cognitiveServiceSubscriptionKey | Klucz subskrypcji usługi Cognitive Service do użycia z tą rejestracją kanału. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| customSpeechModelId | Niestandardowy identyfikator wdrożenia głosowego (opcjonalnie). | ciąg |
| customVoiceDeploymentId | Identyfikator niestandardowego modelu mowy (opcjonalnie). | ciąg |
| isDefaultBotForCogSvcAccount | Ustaw go jako domyślnego bota dla wybranego konta usługi Cognitive Service. | Bool |
| jest włączony | Bez względu na to, czy ten kanał jest włączony, czy nie. | Bool |
Kanał poczty e-mail
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "EmailChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału poczty e-mail | |
Właściwości EmailChannelProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| authMethod (metoda uwierzytelniania) | Metoda uwierzytelniania kanału poczty e-mail. 0 Hasło (ustawienie domyślne); 1 Wykres. | Int |
| adres e-mail | Adres e-mail | ciąg (wymagany) |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
| magicCode (kod magiczny) | Kod magiczny do konfigurowania nowoczesnego uwierzytelniania. | ciąg |
| hasło | Hasło adresu e-mail. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | ciąg |
Kanał Facebooka
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "FacebookChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla kanału facebook bota | Właściwości kanału Facebooka |
Właściwości kanału Facebooka
Strona na Facebooku
| Nazwa | Opis | Wartość |
|---|---|---|
| accessToken | Token dostępu do aplikacji serwisu Facebook. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| id | Identyfikator strony | ciąg (wymagany) |
Kanał KikChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "KikChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału Kik | Właściwości KikChannelProperties |
Właściwości KikChannelProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| Klucz apiKey | Klucz interfejsu API Kik. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | ciąg |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
| isValidated (Zweryfikowany) | Czy ten kanał jest weryfikowany dla bota | Bool |
| userName | Nazwa użytkownika Kik | ciąg (wymagany) |
LineChannel (Kanał linii)
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "LineChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału liniowego | Właściwości kanału linii |
Właściwości kanału linii
| Nazwa | Opis | Wartość |
|---|---|---|
| lineRejestracje | Lista rejestracji kanału liniowego | LineRegistration[] (wymagane) |
Rejestracja linii
| Nazwa | Opis | Wartość |
|---|---|---|
| Token dostępu do kanału | Token dostępu do rejestracji kanału liniowego | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| kanałTajne | Wpis tajny rejestracji kanału liniowego | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
Rozszerzenia M365Extensions
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "M365Extensions" (wymagane) |
MsTeamsChannel (kanał MsTeams)
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "MsTeamsChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału usługi Microsoft Teams | MsTeamsChannelProperties |
MsTeamsChannelProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| zaakceptowaneWarunki | Czy ten kanał zaakceptował warunki | Bool |
| wywoływanie elementuWebhook | Element webhook dla wywołań kanału usługi Microsoft Teams | ciąg |
| deploymentEnvironment (środowisko wdrożenia) | Środowisko wdrażania dla wywołań kanału usługi Microsoft Teams | ciąg |
| enableCalling (Połączenia włączone) | Włączanie wywoływania kanału usługi Microsoft Teams | Bool |
| incomingCallRoute (trasa połączenia przychodzącego) | Element webhook dla wywołań kanału usługi Microsoft Teams | ciąg |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
Wielokanałowy
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "Omnichannel" (wymagane) |
Kanał OutlookChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "OutlookChannel" (wymagany) |
Asystent wyszukiwania
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "SearchAssistant" (wymagane) |
Numer jednostki magazynowej
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa | Nazwa jednostki SKU | "F0" "S1" (wymagany) |
Kanał SkypeChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "SkypeChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału Skype | SkypeChannelProperties |
Właściwości kanału SkypeChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| wywoływanie elementuWebHook | Nawiązywanie połączenia z elementem webhook dla kanału Skype | ciąg |
| enableCalling (Połączenia włączone) | Włączanie połączeń dla kanału Skype | Bool |
| enableGroups (grupy włączeń) | Włączanie grup dla kanału Skype | Bool |
| enableMediaCards (włącz karty multimedialne) | Włączanie kart multimedialnych dla kanału Skype | Bool |
| enableMessaging (włącz wiadomości) | Włączanie obsługi wiadomości dla kanału Skype | Bool |
| enableUdostępnianie ekranu | Włączanie udostępniania ekranu dla kanału Skype | Bool |
| enableVideo (włącz wideo) | Włączanie wideo dla kanału Skype | Bool |
| Tryb grup | Tryb grupy dla kanału Skype | ciąg |
| incomingCallRoute (trasa połączenia przychodzącego) | Trasa połączeń przychodzących dla kanału skype'a | ciąg |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
Kanał SlackChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "SlackChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału usługi Slack | |
Właściwości SlackChannelProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| clientId (identyfikator klienta) | Identyfikator klienta usługi Slack | ciąg |
| tajemnica klienta | Wpis tajny klienta usługi Slack. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
| landingPageUrl (adres URL strony docelowej) | Adres URL strony docelowej usługi Slack | ciąg |
| registerBeforeOAuthFlow | Określa, czy należy zarejestrować ustawienia przed wykonaniem weryfikacji protokołu OAuth. Zalecane do wartości True. | Bool |
| Zakresów | Zakresy uprawnień usługi Slack. | ciąg |
| podpisywanie Tajne | Wpis tajny podpisywania usługi Slack. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| verificationToken (token weryfikacji) | Token weryfikacji usługi Slack. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
Kanał SmsChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "SmsChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału sms | SmsChannelProperties |
Właściwości kanału SmsChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| identyfikator konta | Identyfikator SID konta sms. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | ciąg (wymagany) |
| Token uwierzytelniania (authToken) | Token uwierzytelniania wiadomości SMS. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
| isValidated (Zweryfikowany) | Czy ten kanał jest weryfikowany dla bota | Bool |
| Telefon | Telefon SMS | ciąg (wymagany) |
Kanał telegramu
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "TelegramChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału Telegram | TelegramChannelWłaściwości |
TelegramChannelWłaściwości
| Nazwa | Opis | Wartość |
|---|---|---|
| accessToken | Token dostępu usługi Telegram. Wartość zwracana tylko za pośrednictwem funkcji POST do interfejsu API listy kanałów akcji, w przeciwnym razie jest pusta. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| jest włączony | Czy ten kanał jest włączony dla bota | bool (wymagane) |
| isValidated (Zweryfikowany) | Czy ten kanał jest weryfikowany dla bota | Bool |
TelefoniaChannel
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "TelefoniaChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału telefonii | TelefoniaChannelWłaściwości |
TelefoniaChannelWłaściwości
| Nazwa | Opis | Wartość |
|---|---|---|
| apiKonfiguracje | Lista konfiguracji interfejsu API telefonii | TelefoniaChannelResourceApiConfiguration[] |
| Region usług kognitywnych | ExtensionKey2 | ciąg |
| cognitiveServiceSubscriptionKey | ExtensionKey1 | ciąg |
| defaultLocale (ustawienia regionalne) | Domyślne ustawienia regionalne kanału | ciąg |
| jest włączony | Czy kanał jest włączony | Bool |
| phoneNumbers (numery telefonów) | Lista numerów telefonów telefonii | telefoniiPhoneNumbers[] |
| Jednostka premium SKU | Jednostka SKU w warstwie Premium zastosowana do kanału | ciąg |
TelefoniaChannelResourceApiConfiguration
| Nazwa | Opis | Wartość |
|---|---|---|
| Region usług kognitywnych | Region usługi Cognitive Service. | ciąg |
| cognitiveServiceResourceId | Identyfikator zasobu usługi Cognitive Service. | ciąg |
| cognitiveServiceSubscriptionKey | Klucz subskrypcji usługi Cognitive Service. | ciąg |
| defaultLocale (ustawienia regionalne) | Domyślne ustawienia regionalne. | ciąg |
| id | Identyfikator konfiguracji. | ciąg |
| nazwaDostawcy | Nazwa dostawcy. | ciąg |
Numer telefonu
| Nazwa | Opis | Wartość |
|---|---|---|
| acsEndpoint (punkt końcowy acs) | Punkt końcowy usługi ACS. | ciąg |
| acsResourceId (identyfikator zasobu) | Identyfikator zasobu usługi ACS. | ciąg |
| acsTajne | Tajemnica ACS. | ciąg |
| Region usług kognitywnych | Region usługi Cognitive Service. | ciąg |
| cognitiveServiceResourceId | Identyfikator zasobu usługi Cognitive Service. | ciąg |
| cognitiveServiceSubscriptionKey | Klucz subskrypcji usługi Cognitive Service. | ciąg |
| defaultLocale (ustawienia regionalne) | Domyślne ustawienia regionalne numeru telefonu. | ciąg |
| id | Identyfikator elementu. | ciąg |
| Typ oferty | Opcjonalna właściwość, która określi typ oferty telefonu. | ciąg |
| numer telefonu | Numer telefonu. | ciąg |
Kanał czatu internetowego
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa_kanału | Nazwa kanału | "WebChatChannel" (wymagane) |
| Właściwości | Zestaw właściwości specyficznych dla zasobu kanału czatu internetowego | WebChatChannelProperties (Właściwości kanału WebChat) |
WebChatChannelProperties (Właściwości kanału WebChat)
| Nazwa | Opis | Wartość |
|---|---|---|
| Witryn | Lista witryn czatu internetowego | WebChatSite [] |
Witryna WebChatSite
| Nazwa | Opis | Wartość |
|---|---|---|
| Identyfikator aplikacji | Identyfikator aplikacji DirectLine | ciąg |
| Znacznik elektroniczny (eTag) | Tag jednostki | ciąg |
| isBlockUserUploadEnabled | Określa, czy ta witryna jest włączona na potrzeby blokowania przekazywania użytkowników. | Bool |
| isDetailedLoggingEnabled | Czy ta witryna jest wyłączona szczegółowe rejestrowanie dla | Bool |
| jest włączony | Czy ta witryna jest włączona dla kanału DirectLine | bool (wymagane) |
| isEndpointParametersEnabled | Czy ta witryna jest włączona dla kanału EndpointParameters | Bool |
| isNoStorageEnabled (Włączona pamięć masowa) | Czy ta lokacja magazynu nie jest wyłączona, szczegółowe rejestrowanie dla | Bool |
| isSecureSiteEnabled (Włączona witryna) | Określa, czy ta witryna jest włączona do uwierzytelniania za pomocą platformy Bot Framework. | Bool |
| isV1Enabled (Włączone w standardzie isV1) | Określa, czy ta witryna jest włączona dla protokołu Bot Framework V1. | Bool |
| isV3Enabled (Obsługa standardu) | Określa, czy ta witryna jest włączona dla protokołu Bot Framework V3. | Bool |
| isWebchatPreviewEnabled | Czy ta witryna jest włączona dla wersji zapoznawczej webchat | Bool |
| isWebChatSpeechEnabled | Określa, czy ta witryna jest włączona dla mowy webchat | Bool |
| nazwa_witryny | Nazwa witryny | ciąg (wymagany) |
| Identyfikator najemcy | Identyfikator dzierżawy | ciąg |
| trustedOrigins (Pochodzenie zaufane) | Lista zaufanych adresów URL źródeł dla tej witryny. To pole ma zastosowanie tylko wtedy, gdy wartość isSecureSiteEnabled ma wartość True. | ciąg znakowy[] |