@azure/arm-botservice package

Klassen

AzureBotService

Schnittstellen

AcsChatChannel

AcsChat-Kanaldefinition

AlexaChannel

Definition von Alexa-Kanälen

AlexaChannelProperties

Die Parameter, um den Alexa-Kanal bereitzustellen.

AzureBotServiceOptionalParams

Optionale Parameter für den Client.

Bot

Definition von Bot-Ressourcen

BotChannel

Definition von Bot-Kanalressourcen

BotConnectionCreateOptionalParams

Optionale Parameter.

BotConnectionDeleteOptionalParams

Optionale Parameter.

BotConnectionGetOptionalParams

Optionale Parameter.

BotConnectionListByBotServiceOptionalParams

Optionale Parameter.

BotConnectionListServiceProvidersOptionalParams

Optionale Parameter.

BotConnectionListWithSecretsOptionalParams

Optionale Parameter.

BotConnectionOperations

Schnittstelle stellt eine BotConnection-Operation dar.

BotConnectionUpdateOptionalParams

Optionale Parameter.

BotProperties

Die Parameter, um den Bot bereitzustellen.

BotsCreateOptionalParams

Optionale Parameter.

BotsDeleteOptionalParams

Optionale Parameter.

BotsGetCheckNameAvailabilityOptionalParams

Optionale Parameter.

BotsGetOptionalParams

Optionale Parameter.

BotsListByResourceGroupOptionalParams

Optionale Parameter.

BotsListOptionalParams

Optionale Parameter.

BotsOperations

Schnittstelle stellt die Operationen eines Bots dar.

BotsUpdateOptionalParams

Optionale Parameter.

Channel

Kanaldefinition

ChannelSettings

Definition der Kanaleinstellungen

ChannelsCreateOptionalParams

Optionale Parameter.

ChannelsDeleteOptionalParams

Optionale Parameter.

ChannelsGetOptionalParams

Optionale Parameter.

ChannelsListByResourceGroupOptionalParams

Optionale Parameter.

ChannelsListWithKeysOptionalParams

Optionale Parameter.

ChannelsOperations

Schnittstelle stellt die Operationen eines Kanals dar.

ChannelsUpdateOptionalParams

Optionale Parameter.

CheckNameAvailabilityRequestBody

Das Anforderungsorgan für eine Anfrage an das Bot Service Management, um die Verfügbarkeit eines Bot-Namens zu überprüfen.

CheckNameAvailabilityResponseBody

Der Antwort-Body meldete eine Anfrage an das Bot Service Management, um die Verfügbarkeit eines Bot-Namens zu überprüfen.

ConnectionSetting

Definition von Bot-Kanalressourcen

ConnectionSettingParameter

Zusätzlicher Parameter in den Eigenschaften der Verbindungseinstellung, um dienstanbieterspezifische Eigenschaften anzuzeigen

ConnectionSettingProperties

Eigenschaften eines Verbindungseinstellungselements

CreateEmailSignInUrlResponse

Der ARM erstellt eine E-Mail-Anmelde-URL-Operation als Antwort.

CreateEmailSignInUrlResponseProperties

Die Menge der Eigenschaften, die spezifisch für die Sign-in-URL sind

DirectLineChannel

Direct Line-Kanaldefinition

DirectLineChannelProperties

Die Parameter zur Bereitstellung des Direct Line-Kanals.

DirectLineOperations

Schnittstelle, die eine DirectLine-Operation darstellt.

DirectLineRegenerateKeysOptionalParams

Optionale Parameter.

DirectLineSite

Eine Seite für den Direct Line-Kanal

DirectLineSpeechChannel

DirectLine Sprachkanaldefinition

DirectLineSpeechChannelProperties

Die Parameter zur Bereitstellung des DirectLine-Sprachkanals.

EmailChannel

Definition des E-Mail-Kanals

EmailChannelProperties

Die Parameter, die für den E-Mail-Kanal bereitgestellt werden.

EmailCreateSignInUrlOptionalParams

Optionale Parameter.

EmailOperations

Schnittstelle stellt eine E-Mail-Operation dar.

ErrorAdditionalInfo

Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.

ErrorBody

Bot Service-Fehlerkörper.

ErrorDetail

Die Fehlerdetails.

ErrorModel

Bot Service Fehlerobjekt.

ErrorResponse

Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben.

FacebookChannel

Facebook-Kanaldefinition

FacebookChannelProperties

Die Parameter, die für den Facebook-Kanal bereitgestellt werden.

FacebookPage

Eine Facebook-Seite zur Registrierung eines Facebook-Kanals

HostSettingsGetOptionalParams

Optionale Parameter.

HostSettingsOperations

Benutzeroberfläche, die HostSettings-Operationen darstellt.

HostSettingsResponse

Der Antwort-Body meldete eine Anfrage an das Bot Service Management, um pro Abonnement HostSettings zu überprüfen

KikChannel

Kik-Kanaldefinition

KikChannelProperties

Die Parameter, um den Kik-Kanal bereitzustellen.

LineChannel

Linienkanaldefinition

LineChannelProperties

Die Parameter zur Bereitstellung des Line-Kanals.

LineRegistration

Die Eigenschaften, die einer Leitungskanalregistrierung entsprechen

ListChannelWithKeysResponse

Der ARM-Kanal des Listenkanals mit Keys-Operationsantwort.

M365Extensions

Definition von M365-Erweiterungen

MsTeamsChannel

Microsoft Teams Kanaldefinition

MsTeamsChannelProperties

Die Parameter, die für den Microsoft Teams-Kanal bereitgestellt werden sollen.

NetworkSecurityPerimeter

Informationen zum Network Security Perimeter

NetworkSecurityPerimeterConfiguration

Netzwerksicherheitsperimeter-Konfiguration

NetworkSecurityPerimeterConfigurationProperties

Eigenschaften der Netzwerksicherheitsperimeterkonfiguration

NetworkSecurityPerimeterConfigurationsGetOptionalParams

Optionale Parameter.

NetworkSecurityPerimeterConfigurationsListOptionalParams

Optionale Parameter.

NetworkSecurityPerimeterConfigurationsOperations

Schnittstelle, die eine NetworkSecurityPerimeterConfigurations-Operationen darstellt.

NetworkSecurityPerimeterConfigurationsReconcileOptionalParams

Optionale Parameter.

NspAccessRule

Information der Zugangsregel in einem Profil

NspAccessRuleProperties

Eigenschaften der Access-Regel

NspAccessRulePropertiesSubscriptionsItem

Abonnement für eingehende Regel

Omnichannel

Omnichannel-Kanaldefinition

OperationDisplayInfo

Der Betrieb wird von Bot Service Management unterstützt.

OperationEntity

Die Operationen werden von Bot Service Management unterstützt.

OperationResultsDescription

Die Eigenschaften, die das Operationsergebnis einer Operation auf einem Dienst anzeigen.

OperationResultsGetOptionalParams

Optionale Parameter.

OperationResultsOperations

Schnittstelle, die einen OperationResults-Vorgang darstellt.

OperationsListOptionalParams

Optionale Parameter.

OperationsOperations

Schnittstelle, die eine Operationsoperation darstellt.

OutlookChannel

Outlook-Kanaldefinition

PageSettings

Optionen für die byPage-Methode

PagedAsyncIterableIterator

Eine Schnittstelle, die eine asynchrone, iterierbare Iteration sowohl bis zur Fertigstellung als auch nach Seite ermöglicht.

PrivateEndpoint

Die Private Endpoint-Ressource.

PrivateEndpointConnection

Die Private Endpoint Connection-Ressource.

PrivateEndpointConnectionProperties

Eigenschaften der PrivateEndpointConnectProperties.

PrivateEndpointConnectionsCreateOptionalParams

Optionale Parameter.

PrivateEndpointConnectionsDeleteOptionalParams

Optionale Parameter.

PrivateEndpointConnectionsGetOptionalParams

Optionale Parameter.

PrivateEndpointConnectionsListOptionalParams

Optionale Parameter.

PrivateEndpointConnectionsOperations

Schnittstelle, die eine PrivateEndpointConnections-Vorgänge darstellt.

PrivateLinkResource

Eine private Verknüpfungsressource

PrivateLinkResourceBase

Gemeinsame Felder, die in der Antwort für alle BotService Private Link Resources zurückgegeben werden.

PrivateLinkResourceListResult

Eine Liste der privaten Linkressourcen

PrivateLinkResourceProperties

Eigenschaften einer privaten Verknüpfungsressource.

PrivateLinkResourcesListByBotResourceOptionalParams

Optionale Parameter.

PrivateLinkResourcesOperations

Schnittstelle, die einen PrivateLinkResources-Vorgang darstellt.

PrivateLinkServiceConnectionState

Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.

Profile

Informationen zum Profil

ProvisioningIssue

Beschreibt das Bereitstellungsproblem für eine bestimmte Netzwerksicherheitsperimeterkonfiguration

ProvisioningIssueProperties

Eigenschaften des Bereitstellungsproblems

ProxyResource

Die Ressourcenmodelldefinition für eine Azure Resource Manager-Proxyressource. Es enthält keine Tags und einen Speicherort.

QnAMakerEndpointKeysGetOptionalParams

Optionale Parameter.

QnAMakerEndpointKeysOperations

Schnittstelle stellt eine QnAMakerEndpointKeys-Operation dar.

QnAMakerEndpointKeysRequestBody

Der Anforderungskörper für eine Anfrage an Bot Service Management, QnA Maker Endpunktschlüssel aufzulisten.

QnAMakerEndpointKeysResponse

Schema für EndpointKeys-Generierungs-/Aktualisierungsoperationen.

Resource

Allgemeine Felder, die in der Antwort für alle Azure Resource Manager-Ressourcen zurückgegeben werden

ResourceAssociation

Informationen zur Ressourcenzuordnung

RestorePollerOptions
SearchAssistant

SearchAssistant-Definition

ServiceProvider

Definition des Dienstanbieters

ServiceProviderParameter

Zusätzliche Parameter, die für jeden Dienstleister spezifisch sind

ServiceProviderParameterMetadata

Metadaten für den Dienstanbieter

ServiceProviderParameterMetadataConstraints

die Einschränkungen der Metadaten des Bots.

ServiceProviderProperties

Das Objekt, das verwendet wird, um einen vom Bot Service unterstützten Dienstanbieter zu beschreiben

ServiceProviderResponseList

Die Antwort der Liste der Bot-Dienstleister.

SimplePollerLike

Ein einfacher Poller, der zum Abrufen eines vorgangs mit langer Ausführung verwendet werden kann.

Site

Eine Seite für den Kanal

SiteInfo

Site-Informationen für WebChat- oder DirectLine-Kanäle, um zu identifizieren, für welche Seite Schlüssel neu generiert werden sollen.

Sku

Die SKU des Kognitiven Dienstkontos.

SkypeChannel

Skype-Kanaldefinition

SkypeChannelProperties

Die Parameter, die für den Microsoft Teams-Kanal bereitgestellt werden sollen.

SlackChannel

Slack-Kanaldefinition

SlackChannelProperties

Die Parameter zur Bereitstellung des Slack-Kanals.

SmsChannel

SMS-Kanaldefinition

SmsChannelProperties

Die Parameter, um den SMS-Kanal bereitzustellen.

SystemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

TelegramChannel

Definition des Telegram-Kanals

TelegramChannelProperties

Die Parameter, um den Telegram-Kanal bereitzustellen.

TelephonyChannel

Definition von Telefonkanalen

TelephonyChannelProperties

Die Parameter zur Bereitstellung des Direct Line-Kanals.

TelephonyChannelResourceApiConfiguration

Eine Ressourcen-Api-Konfiguration für den Telefoniekanal

TelephonyPhoneNumbers

Eine Telefonnummer für den Telefoniekanal

WebChatChannel

Definition des Webchat-Kanals

WebChatChannelProperties

Die Parameter, die für den Webchat-Kanal bereitgestellt werden.

WebChatSite

Eine Seite für den Webchat-Kanal

Typaliase

AccessMode

Zugangsmodus der Ressourcenassoziation
KnownAccessMode- austauschbar mit AccessMode verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Erzwungen
Weiterbildung
Überwachung

AzureSupportedClouds

Die unterstützten Werte für die Cloud-Einstellung als Zeichenfolgenliteraltyp

ChannelName

Art von ChannelName

ChannelUnion

Alias für ChannelUnion

ContinuablePage

Eine Schnittstelle, die eine Seite mit Ergebnissen beschreibt.

CreatedByType

Die Art der Entität, die die Ressource erstellt hat.
KnownCreatedByType austauschbar mit CreatedByType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Benutzer: Die Entität wurde von einem Benutzer erstellt.
Anwendung: Die Entität wurde von einer Anwendung erstellt.
ManagedIdentity: Die Entität wurde von einer verwalteten Identität erstellt.
Schlüssel: Die Entität wurde durch einen Schlüssel erstellt.

EmailChannelAuthMethod

E-Mail-Kanal-Authentifizierungsmethode. 0 Kennwort (Standard); 1 Graph.

Key

Bestimmt, welcher Schlüssel neu generiert werden soll.

Kind

Gibt die Art des Bot-Dienstes an
KnownKind austauschbar mit Kind verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

SDK
Designer
Bot
Funktion
azurebot

MsaAppType

Microsoft-App-Typ für den Bot
KnownMsaAppType kann austauschbar mit MsaAppType verwendet werden; dieses Enum enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

UserAssignedMSI
SingleTenant
MultiTenant

NspAccessRuleDirection

Zugangsrichtungsregel
KnownNspAccessRuleDirection kann austauschbar mit NspAccessRuleDirection verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Eingehend
Ausgehend

OperationResultStatus

Der Status der durchgeführten Operation.
KnownOperationResultStatus kann austauschbar mit OperationResultStatus verwendet werden, dieses Enum enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Abgesagt
Erfolgreich
Fehler
Angefordert
Läuft

PrivateEndpointConnectionProvisioningState

Der aktuelle Bereitstellungsstatus.
KnownPrivateEndpointConnectionProvisioningState- austauschbar mit PrivateEndpointConnectionProvisioningState verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Erfolgreich
Erstellen von
Löschen von
Fehler

PrivateEndpointServiceConnectionStatus

Der Status der privaten Endpunktverbindung.
KnownPrivateEndpointServiceConnectionStatus kann austauschbar mit PrivateEndpointServiceConnectionStatus verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Ausstehend
Genehmigt
Rejected

ProvisioningState

Typ des ProvisioningState

PublicNetworkAccess

Ob sich der Bot in einem isolierten Netzwerk befindet
KnownPublicNetworkAccess austauschbar mit PublicNetworkAccess verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Aktiviert
Deaktiviert
SecuredByPerimeter

RegenerateKeysChannelName

Art von RegenerateKeysChannelName

Severity

Bereitstellungszustand der Network Security Perimeter-Konfigurationspropagation
KnownSeverity kann austauschbar mit Schweregrad verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Warnung
Error

SkuName

Der Name der SKU.
KnownSkuName austauschbar mit SkuName verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

F0
S1

SkuTier

Ruft den SKU-Tarif ab. Dies basiert auf dem SKU-Namen.
KnownSkuTier kann austauschbar mit SkuTier verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Kostenlos
Standard

Enumerationen

AzureClouds

Ein Enum zur Beschreibung von Azure Cloud-Umgebungen.

KnownAccessMode

Zugriffsmodus der Ressourcenzuordnung

KnownCreatedByType

Die Art der Entität, die die Ressource erstellt hat.

KnownKind

Gibt die Art des Bot-Dienstes an

KnownMsaAppType

Microsoft App-Typ für den Bot

KnownNspAccessRuleDirection

Regel für die Zugriffsrichtung

KnownOperationResultStatus

Der Status der durchgeführten Operation.

KnownPrivateEndpointConnectionProvisioningState

Der aktuelle Bereitstellungsstatus.

KnownPrivateEndpointServiceConnectionStatus

Der Status der privaten Endpunktverbindung.

KnownProvisioningState

Bekannte Werte von ProvisioningState, die der Dienst akzeptiert.

KnownPublicNetworkAccess

Gibt an, ob sich der Bot in einem isolierten Netzwerk befindet.

KnownSeverity

Bereitstellungsstatus der Weitergabe der Netzwerksicherheitsperimeterkonfiguration

KnownSkuName

Der Name der SKU.

KnownSkuTier

Ruft den SKU-Tarif ab. Dies basiert auf dem SKU-Namen.

KnownVersions

Die verfügbaren API-Versionen.

Functions

isRestError(unknown)

Typeguard für RestError

restorePoller<TResponse, TResult>(AzureBotService, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Poller auf einem anderen Host erstellen möchten oder wenn ein Poller erstellt werden muss, nachdem der ursprüngliche Poller nicht im Gültigkeitsbereich ist.

Variablen

RestError

Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen.

Details zur Funktion

isRestError(unknown)

Typeguard für RestError

function isRestError(e: unknown): e

Parameter

e

unknown

Etwas, das von einer Catch-Klausel abgefangen wird.

Gibt zurück

e

restorePoller<TResponse, TResult>(AzureBotService, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Poller auf einem anderen Host erstellen möchten oder wenn ein Poller erstellt werden muss, nachdem der ursprüngliche Poller nicht im Gültigkeitsbereich ist.

function restorePoller<TResponse, TResult>(client: AzureBotService, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameter

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Gibt zurück

PollerLike<OperationState<TResult>, TResult>

Details zu Variablen

RestError

Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen.

RestError: RestErrorConstructor

Typ