@azure/arm-servicebus package

Klassen

ServiceBusManagementClient

Schnittstellen

@azure/arm-servicebus.FailOverProperties

AccessKeys	Namespace/ServiceBus-Verbindungszeichenfolge
Action	Stellt die Filteraktionen dar, die für die Transformation einer Nachricht zulässig sind, die mit einem Filterausdruck abgeglichen wurde.
ArmDisasterRecovery	Einzelnes Element in "List" oder "Get Alias(Disaster Recovery Configuration)"-Vorgang
ArmDisasterRecoveryProperties	Eigenschaften, die für den Create Or Update Alias (Disaster Recovery-Konfigurationen) erforderlich sind
CheckNameAvailability	Beschreibung der Eigenschaften der Verfügbarkeitsanforderung "Überprüfen".
CheckNameAvailabilityResult	Beschreibung der Eigenschaften der Verfügbarkeitsanforderung "Überprüfen".
ConfidentialCompute	Modellschnittstelle: ConfidentialCompute
ConnectionState	ConnectionState-Informationen.
CorrelationFilter	Stellt den Korrelationsfilterausdruck dar.
DisasterRecoveryConfigsBreakPairingOptionalParams	Optionale Parameter.
DisasterRecoveryConfigsCheckNameAvailabilityOptionalParams	Optionale Parameter.
DisasterRecoveryConfigsCreateOrUpdateOptionalParams	Optionale Parameter.
DisasterRecoveryConfigsDeleteOptionalParams	Optionale Parameter.
DisasterRecoveryConfigsFailOverOptionalParams	Optionale Parameter.
DisasterRecoveryConfigsGetAuthorizationRuleOptionalParams	Optionale Parameter.
DisasterRecoveryConfigsGetOptionalParams	Optionale Parameter.
DisasterRecoveryConfigsListAuthorizationRulesOptionalParams	Optionale Parameter.
DisasterRecoveryConfigsListKeysOptionalParams	Optionale Parameter.
DisasterRecoveryConfigsListOptionalParams	Optionale Parameter.
DisasterRecoveryConfigsOperations	Schnittstelle, die eine DisasterRecoveryConfigs-Operation darstellt.
Encryption	Eigenschaften zum Konfigurieren der Verschlüsselung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorResponse	Die Fehlerantwort für die Ressourcenverwaltung.
ErrorResponseError	Das Fehlerobjekt.
FailOver	Modellschnittstellen-FailOver
FailoverProperties	Sicheres Failover besteht darin, anzugeben, dass der Dienst auf den Abschluss der ausstehenden Replikation warten soll, bevor der Wechsel zur sekundären Seite erfolgt.
FailoverPropertiesProperties	Sicheres Failover besteht darin, anzugeben, dass der Dienst auf den Abschluss der ausstehenden Replikation warten soll, bevor der Wechsel zur sekundären Seite erfolgt.
GeoDataReplicationProperties	GeoDR-Replikationseigenschaften
Identity	Eigenschaften zum Konfigurieren von vom Benutzer zugewiesenen Identitäten für die Mitbringen eigener Schlüssel
KeyVaultProperties	Eigenschaften zum Konfigurieren von keyVault-Eigenschaften
MessageCountDetails	Details zur Nachrichtenanzahl.
MigrationConfigProperties	Einzelnes Element in Listen- oder Migrationskonfigurationsvorgang abrufen
MigrationConfigPropertiesProperties	Eigenschaften, die für die Erstellung der Migrationskonfiguration erforderlich sind
MigrationConfigsCompleteMigrationOptionalParams	Optionale Parameter.
MigrationConfigsCreateAndStartMigrationOptionalParams	Optionale Parameter.
MigrationConfigsDeleteOptionalParams	Optionale Parameter.
MigrationConfigsGetOptionalParams	Optionale Parameter.
MigrationConfigsListOptionalParams	Optionale Parameter.
MigrationConfigsOperations	Schnittstelle stellt die Operationen von MigrationConfigs dar.
MigrationConfigsRevertOptionalParams	Optionale Parameter.
NWRuleSetIpRules	Beschreibung der NetWorkRuleSet - IpRules-Ressource.
NWRuleSetVirtualNetworkRules	Beschreibung von VirtualNetworkRules – NetworkRules-Ressource.
NamespaceReplicaLocation	Namespacereplikationseigenschaften
NamespacesCheckNameAvailabilityOptionalParams	Optionale Parameter.
NamespacesCreateOrUpdateAuthorizationRuleOptionalParams	Optionale Parameter.
NamespacesCreateOrUpdateNetworkRuleSetOptionalParams	Optionale Parameter.
NamespacesCreateOrUpdateOptionalParams	Optionale Parameter.
NamespacesDeleteAuthorizationRuleOptionalParams	Optionale Parameter.
NamespacesDeleteOptionalParams	Optionale Parameter.
NamespacesFailoverOptionalParams	Optionale Parameter.
NamespacesGetAuthorizationRuleOptionalParams	Optionale Parameter.
NamespacesGetNetworkRuleSetOptionalParams	Optionale Parameter.
NamespacesGetOptionalParams	Optionale Parameter.
NamespacesListAuthorizationRulesOptionalParams	Optionale Parameter.
NamespacesListByResourceGroupOptionalParams	Optionale Parameter.
NamespacesListKeysOptionalParams	Optionale Parameter.
NamespacesListNetworkRuleSetsOptionalParams	Optionale Parameter.
NamespacesListOptionalParams	Optionale Parameter.
NamespacesOperations	Schnittstelle, die einen Namespaces-Vorgang darstellt.
NamespacesRegenerateKeysOptionalParams	Optionale Parameter.
NamespacesUpdateOptionalParams	Optionale Parameter.
NetworkRuleSet	Beschreibung der NetworkRuleSet-Ressource.
NetworkRuleSetProperties	NetworkRuleSet-Eigenschaften
NetworkSecurityPerimeter	Verwandte Informationen zu NetworkSecurityPerimeter
NetworkSecurityPerimeterConfiguration	Netzwerksicherheitsperimeter-bezogene Konfigurationen eines bestimmten Namespaces
NetworkSecurityPerimeterConfigurationListOptionalParams	Optionale Parameter.
NetworkSecurityPerimeterConfigurationOperations	Schnittstelle, die eine NetworkSecurityPerimeterKonfigurationsoperationen darstellt.
NetworkSecurityPerimeterConfigurationProperties	Eigenschaften von NetworkSecurityPerimeterConfiguration
NetworkSecurityPerimeterConfigurationPropertiesProfile	Informationen zum aktuellen Netzwerkprofil
NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation	Informationen zur Ressourcenzuordnung
NetworkSecurityPerimeterConfigurationsGetResourceAssociationNameOptionalParams	Optionale Parameter.
NetworkSecurityPerimeterConfigurationsOperations	Schnittstelle, die eine NetworkSecurityPerimeterConfigurations-Operationen darstellt.
NetworkSecurityPerimeterConfigurationsReconcileOptionalParams	Optionale Parameter.
NspAccessRule	Informationen zur Zugriffsregel im Netzwerkprofil
NspAccessRuleProperties	Eigenschaften der Access-Regel
NspAccessRulePropertiesSubscriptionsItem	Abonnement für eingehende Regel
Operation	Dienstbus-REST-API-Vorgang
OperationDisplay	Vorgangsanzeigennutzlast
OperationsListOptionalParams	Optionale Parameter.
OperationsOperations	Schnittstelle, die vorgänge darstellt.
PageSettings	Optionen für die byPage-Methode
PagedAsyncIterableIterator	Eine Schnittstelle, die eine asynchrone iterierbare Iteration sowohl zum Abschluss als auch nach Seite ermöglicht.
PlatformCapabilities	Modellschnittstellen PlatformCapabilities
PrivateEndpoint	PrivateEndpoint-Informationen.
PrivateEndpointConnection	Eigenschaften der PrivateEndpointConnection.
PrivateEndpointConnectionProperties	Eigenschaften der privaten Endpunkt-Verbindungsressource.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Optionale Parameter.
PrivateEndpointConnectionsDeleteOptionalParams	Optionale Parameter.
PrivateEndpointConnectionsGetOptionalParams	Optionale Parameter.
PrivateEndpointConnectionsListOptionalParams	Optionale Parameter.
PrivateEndpointConnectionsOperations	Schnittstelle, die eine PrivateEndpointConnections-Vorgänge darstellt.
PrivateLinkResource	Informationen zur Ressource für private Verknüpfungen.
PrivateLinkResourceProperties	Eigenschaften von PrivateLinkResource
PrivateLinkResourcesGetOptionalParams	Optionale Parameter.
PrivateLinkResourcesListResult	Die Antwort eines PrivateLinkResource-Listenvorgangs.
PrivateLinkResourcesOperations	Schnittstelle, die einen PrivateLinkResources-Vorgang darstellt.
ProvisioningIssue	Beschreibt das Bereitstellungsproblem für bestimmte NetworkSecurityPerimeterConfiguration
ProvisioningIssueProperties	Eigenschaften des Bereitstellungsproblems
ProxyResource	Die Ressourcenmodelldefinition für eine Azure Resource Manager-Proxyressource. Es enthält keine Tags und einen Speicherort.
QueuesCreateOrUpdateAuthorizationRuleOptionalParams	Optionale Parameter.
QueuesCreateOrUpdateOptionalParams	Optionale Parameter.
QueuesDeleteAuthorizationRuleOptionalParams	Optionale Parameter.
QueuesDeleteOptionalParams	Optionale Parameter.
QueuesGetAuthorizationRuleOptionalParams	Optionale Parameter.
QueuesGetOptionalParams	Optionale Parameter.
QueuesListAuthorizationRulesOptionalParams	Optionale Parameter.
QueuesListByNamespaceOptionalParams	Optionale Parameter.
QueuesListKeysOptionalParams	Optionale Parameter.
QueuesOperations	Schnittstelle stellt die Operationen einer Warteschlange dar.
QueuesRegenerateKeysOptionalParams	Optionale Parameter.
RegenerateAccessKeyParameters	Parameter, die für den Vorgang "Autorisierungsregel generieren" bereitgestellt werden, gibt an, welcher Schlüssel zurückgesetzt werden muss.
Resource	Allgemeine Felder, die in der Antwort für alle Azure Resource Manager-Ressourcen zurückgegeben werden
ResourceNamespacePatch	Die Ressourcendefinition.
RestorePollerOptions
Rule	Beschreibung der Regelressource.
Ruleproperties	Beschreibung der Regelressource.
RulesCreateOrUpdateOptionalParams	Optionale Parameter.
RulesDeleteOptionalParams	Optionale Parameter.
RulesGetOptionalParams	Optionale Parameter.
RulesListBySubscriptionsOptionalParams	Optionale Parameter.
RulesOperations	Schnittstelle stellt Regeloperationen dar.
SBAuthorizationRule	Beschreibung einer Namespaceautorisierungsregel.
SBAuthorizationRuleProperties	AuthorizationRule-Eigenschaften.
SBClientAffineProperties	Spezifische Eigenschaften für clientaffine Abonnements.
SBNamespace	Beschreibung einer Namespaceressource.
SBNamespaceProperties	Eigenschaften des Namespaces.
SBNamespaceUpdateParameters	Beschreibung einer Namespaceressource.
SBNamespaceUpdateProperties	Eigenschaften des Namespaces.
SBQueue	Beschreibung der Warteschlangenressource.
SBQueueProperties	Die Definition der Warteschlangeneigenschaften.
SBSku	SKU des Namespace.
SBSubscription	Beschreibung der Abonnementressource.
SBSubscriptionProperties	Beschreibung der Abonnementressource.
SBTopic	Beschreibung der Themenressource.
SBTopicProperties	Die Definition der Themeneigenschaften.
ServiceBusManagementClientOptionalParams	Optionale Parameter für den Client.
SimplePollerLike	Ein einfacher Poller, der zum Abrufen eines vorgangs mit langer Ausführung verwendet werden kann.
SqlFilter	Stellt einen Filter dar, der eine Zusammensetzung eines Ausdrucks und eine Aktion darstellt, die in der Pub/Sub-Pipeline ausgeführt wird.
Subnet	Für Subnetz bereitgestellte Eigenschaften
SubscriptionsCreateOrUpdateOptionalParams	Optionale Parameter.
SubscriptionsDeleteOptionalParams	Optionale Parameter.
SubscriptionsGetOptionalParams	Optionale Parameter.
SubscriptionsListByTopicOptionalParams	Optionale Parameter.
SubscriptionsOperations	Schnittstelle stellt die Operationen eines Abonnements dar.
SystemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
TopicsCreateOrUpdateAuthorizationRuleOptionalParams	Optionale Parameter.
TopicsCreateOrUpdateOptionalParams	Optionale Parameter.
TopicsDeleteAuthorizationRuleOptionalParams	Optionale Parameter.
TopicsDeleteOptionalParams	Optionale Parameter.
TopicsGetAuthorizationRuleOptionalParams	Optionale Parameter.
TopicsGetOptionalParams	Optionale Parameter.
TopicsListAuthorizationRulesOptionalParams	Optionale Parameter.
TopicsListByNamespaceOptionalParams	Optionale Parameter.
TopicsListKeysOptionalParams	Optionale Parameter.
TopicsOperations	Schnittstelle stellt die Operationen eines Themas dar.
TopicsRegenerateKeysOptionalParams	Optionale Parameter.
TrackedResource	Die Ressourcenmodelldefinition für eine Azure Resource Manager-Ressource auf oberster Ebene mit "Tags" und einem "Speicherort"
UserAssignedIdentity	Erkannter Wörterbuchwert.
UserAssignedIdentityProperties	Modelloberfläche UserAssignedIdentityProperties

Typaliase

AccessRights	Art von AccessRights
AzureSupportedClouds	Die unterstützten Werte für die Cloud-Einstellung als Zeichenfolgenliteraltyp
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. Application: Die Entität wurde von einer Anwendung erstellt. ManagedIdentity-: Die Entität wurde durch eine verwaltete Identität erstellt. Key: Die Entität wurde mit einem Schlüssel erstellt.
DefaultAction	Standardaktion für Netzwerkregelwerk KnownDefaultAction austauschbar mit DefaultAction verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden zulassen verweigern
EndPointProvisioningState	Bereitstellungsstatus der privaten Endpunktverbindung. KnownEndPointProvisioningState- austauschbar mit EndPointProvisioningState verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Erstellen von Aktualisieren von Löschen von erfolgreich Abgebrochene Fehlgeschlagene
EntityStatus	Status der Entität.
FilterType	Arten von Regelfiltern
GeoDRRoleType	GeoDR-Rollentypen KnownGeoDRRoleType kann austauschbar mit GeoDRRoleType verwendet werden; dieses Enum enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Primary Sekundär
KeyType	Die Zugriffstaste, die neu generiert werden soll.
ManagedServiceIdentityType	Typ der verwalteten Dienstidentität.
MigrationConfigurationName	Art der MigrationKonfigurationName
Mode	Einstellung zum Aktivieren oder Deaktivieren von Confidential Computing KnownMode- austauschbar mit Mode verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Deaktiviert Aktivierte
NetworkRuleIPAction	Die IP-Filteraktion KnownNetworkRuleIPAction austauschbar mit NetworkRuleIPAction verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden zulassen
NetworkSecurityPerimeterConfigurationProvisioningState	Bereitstellungszustand der NetworkSecurityPerimeter-Konfigurationspropagation KnownNetworkSecurityPerimeterConfigurationProvisioningState austauschbar mit NetworkSecurityPerimeterConfigurationProvisioningState verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Unbekannt Erstellen von Aktualisieren von akzeptierten InvalidResponse- erfolgreich SucceededWithIssues Fehlgeschlagene Löschen von Gelöscht Abgebrochene
NspAccessRuleDirection	Zugangsrichtungsregel KnownNspAccessRuleDirection austauschbar mit NspAccessRuleDirection verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Eingang Ausgehend
PrivateLinkConnectionStatus	Status der Verbindung. KnownPrivateLinkConnectionStatus- austauschbar mit PrivateLinkConnectionStatus verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden ausstehende genehmigte Abgelehnte Getrennten
ProvisioningStateDR	Bereitstellungsstatus des Alias(Notfallwiederherstellungskonfiguration) – mögliche Werte "Akzeptiert" oder "Erfolgreich" oder "Fehlgeschlagen"
PublicNetworkAccess	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert. 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 Aktivierte Deaktiviert SecuredByPerimeter-
PublicNetworkAccessFlag	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert. KnownPublicNetworkAccessFlag austauschbar mit PublicNetworkAccessFlag verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Aktivierte Deaktiviert
ResourceAssociationAccessMode	Zugangsmodus der Ressourcenassoziation KnownResourceAssociationAccessMode austauschbar mit ResourceAssociationAccessMode verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden NoAssociationMode- EnforcedMode- LearningMode- AuditMode- unspecifiedMode-
RoleDisasterRecovery	Rolle des Namespaces in GEO DR - mögliche Werte "Primary" oder "PrimaryNotReplicating" oder "Secondary"
SkuName	Name dieser SKU.
SkuTier	Die Abrechnungsebene dieser speziellen SKU.
TlsVersion	Die minimale TLS-Version, die der Cluster unterstützen muss, z. B. '1.3' KnownTlsVersion- austauschbar mit TlsVersion verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden 1.0 1.1 1.2 1.3
UnavailableReason	Gibt den Grund für die Nichtverfügbarkeit des Diensts an.

Enumerationen

AzureClouds	Ein Enum zur Beschreibung von Azure Cloud-Umgebungen.
KnownCreatedByType	Die Art der Entität, die die Ressource erstellt hat.
KnownDefaultAction	Standardaktion für netzwerkregelsatz
KnownEndPointProvisioningState	Bereitstellungsstatus der privaten Endpunktverbindung.
KnownGeoDRRoleType	GeoDR-Rollentypen
KnownMigrationConfigurationName	Bekannte Werte von MigrationConfigurationName, die der Dienst akzeptiert.
KnownMode	Einstellung zum Aktivieren oder Deaktivieren von vertraulichem Computing
KnownNetworkRuleIPAction	Die IP-Filteraktion
KnownNetworkSecurityPerimeterConfigurationProvisioningState	Bereitstellungsstatus der NetworkSecurityPerimeter-Konfigurationsverteilung
KnownNspAccessRuleDirection	Richtung der Zugriffsregel
KnownPrivateLinkConnectionStatus	Status der Verbindung.
KnownPublicNetworkAccess	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert.
KnownPublicNetworkAccessFlag	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert.
KnownResourceAssociationAccessMode	Zugriffsmodus der Ressourcenzuordnung
KnownTlsVersion	Die minimale TLS-Version, die der Cluster unterstützen muss, z. B. '1.3'
KnownVersions	Die verfügbaren API-Versionen.

Functions

isRestError(unknown)	Typeguard für RestError
restorePoller<TResponse, TResult>(ServiceBusManagementClient, 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 Umfragen auf einem anderen Host erstellen möchten oder ein Poller erstellt werden muss, nachdem das ursprüngliche Abfragefeld nicht im Gültigkeitsbereich liegt.

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>(ServiceBusManagementClient, 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 Umfragen auf einem anderen Host erstellen möchten oder ein Poller erstellt werden muss, nachdem das ursprüngliche Abfragefeld nicht im Gültigkeitsbereich liegt.

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

Parameter

client

ServiceBusManagementClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Gibt zurück

PollerLike<OperationState<TResult>, TResult>

Details zu Variablen

RestError

Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen.

RestError: RestErrorConstructor

Typ

RestErrorConstructor