@azure/arm-relay package

Klassen

Schnittstellen

AccessKeys	Namespace/Relay-Verbindungszeichenfolge
AuthorizationRule	Einzelnes Element in einem Listen- oder Get AuthorizationRule-Vorgang
AuthorizationRuleProperties	Eigenschaften, die zum Erstellen oder Aktualisieren von AuthorizationRule bereitgestellt werden
CheckNameAvailability	Beschreibung der Eigenschaften der Überprüfungsnamenverfügbarkeitsanforderung.
CheckNameAvailabilityResult	Beschreibung der Eigenschaften der Überprüfungsnamenverfügbarkeitsanforderung.
ConnectionState	ConnectionState-Informationen.
ErrorAdditionalInfo	Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben.
HybridConnection	Beschreibung der Hybridverbindungsressource.
HybridConnectionProperties	Eigenschaften von HybridConnection.
HybridConnectionsCreateOrUpdateAuthorizationRuleOptionalParams	Optionale Parameter.
HybridConnectionsCreateOrUpdateOptionalParams	Optionale Parameter.
HybridConnectionsDeleteAuthorizationRuleOptionalParams	Optionale Parameter.
HybridConnectionsDeleteOptionalParams	Optionale Parameter.
HybridConnectionsGetAuthorizationRuleOptionalParams	Optionale Parameter.
HybridConnectionsGetOptionalParams	Optionale Parameter.
HybridConnectionsListAuthorizationRulesOptionalParams	Optionale Parameter.
HybridConnectionsListByNamespaceOptionalParams	Optionale Parameter.
HybridConnectionsListKeysOptionalParams	Optionale Parameter.
HybridConnectionsOperations	Schnittstelle stellt eine HybridConnections-Operation dar.
HybridConnectionsRegenerateKeysOptionalParams	Optionale Parameter.
NWRuleSetIpRules	Die Antwort des Listennamespace-Vorgangs.
NamespacesCheckNameAvailabilityOptionalParams	Optionale Parameter.
NamespacesCreateOrUpdateAuthorizationRuleOptionalParams	Optionale Parameter.
NamespacesCreateOrUpdateNetworkRuleSetOptionalParams	Optionale Parameter.
NamespacesCreateOrUpdateOptionalParams	Optionale Parameter.
NamespacesDeleteAuthorizationRuleOptionalParams	Optionale Parameter.
NamespacesDeleteOptionalParams	Optionale Parameter.
NamespacesGetAuthorizationRuleOptionalParams	Optionale Parameter.
NamespacesGetNetworkRuleSetOptionalParams	Optionale Parameter.
NamespacesGetOptionalParams	Optionale Parameter.
NamespacesListAuthorizationRulesOptionalParams	Optionale Parameter.
NamespacesListByResourceGroupOptionalParams	Optionale Parameter.
NamespacesListKeysOptionalParams	Optionale Parameter.
NamespacesListOptionalParams	Optionale Parameter.
NamespacesOperations	Schnittstelle, die einen Namespaces-Vorgang darstellt.
NamespacesRegenerateKeysOptionalParams	Optionale Parameter.
NamespacesUpdateOptionalParams	Optionale Parameter.
NetworkRuleSet	Beschreibung der Themenressource.
NetworkRuleSetProperties	NetworkRuleSet-Eigenschaften
Operation	Details eines REST-API-Vorgangs, der von der Ressourcenanbieter-Operations-API zurückgegeben wird
OperationDisplay	Lokalisierte Anzeigeinformationen für eine Operation.
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.
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	Eine Ressource, die private Verknüpfungsfunktionen unterstützt.
PrivateLinkResourceProperties	Eigenschaften von PrivateLinkResource
PrivateLinkResourcesGetOptionalParams	Optionale Parameter.
PrivateLinkResourcesListOptionalParams	Optionale Parameter.
PrivateLinkResourcesListResult	Ergebnis des Vorgangs "Private Verknüpfungsressourcen auflisten".
PrivateLinkResourcesOperations	Schnittstelle, die einen PrivateLinkResources-Vorgang darstellt.
ProxyResource	Die Ressourcenmodelldefinition für eine Azure Resource Manager-Proxyressource. Es enthält keine Tags und einen Speicherort.
RegenerateAccessKeyParameters	Parameter, die für den Vorgang zum erneuten Generieren von Autorisierungsregeln bereitgestellt werden, geben an, welcher Schlüssel zurückgesetzt werden muss.
RelayAPIOptionalParams	Optionale Parameter für den Client.
RelayNamespace	Beschreibung einer Namespaceressource.
RelayNamespaceProperties	Eigenschaften des Namespaces.
RelayUpdateParameters	Beschreibung einer Namespaceressource.
Resource	Allgemeine Felder, die in der Antwort für alle Azure Resource Manager-Ressourcen zurückgegeben werden
ResourceNamespacePatch	Definition von Ressource.
RestorePollerOptions
SimplePollerLike	Ein einfacher Poller, der zum Abrufen eines vorgangs mit langer Ausführung verwendet werden kann.
Sku	SKU des Namespace.
SystemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
TrackedResource	Die Ressourcenmodelldefinition für eine Azure Resource Manager-Ressource auf oberster Ebene mit "Tags" und einem "Speicherort"
WcfRelay	Beschreibung der WCF-Relayressource.
WcfRelayProperties	Eigenschaften des WCF-Relays.
wCFRelaysCreateOrUpdateAuthorizationRuleOptionalParams	Optionale Parameter.
wCFRelaysCreateOrUpdateOptionalParams	Optionale Parameter.
wCFRelaysDeleteAuthorizationRuleOptionalParams	Optionale Parameter.
wCFRelaysDeleteOptionalParams	Optionale Parameter.
wCFRelaysGetAuthorizationRuleOptionalParams	Optionale Parameter.
wCFRelaysGetOptionalParams	Optionale Parameter.
wCFRelaysListAuthorizationRulesOptionalParams	Optionale Parameter.
wCFRelaysListByNamespaceOptionalParams	Optionale Parameter.
wCFRelaysListKeysOptionalParams	Optionale Parameter.
wCFRelaysOperations	Schnittstelle, die eine wCFRelays-Operationen darstellt.
wCFRelaysRegenerateKeysOptionalParams	Optionale Parameter.

Typaliase

AccessRights	Art von AccessRights
ActionType	Erweiterbare Enumeration. Gibt den Aktionstyp an. "Intern" bezieht sich auf Aktionen, die nur für interne APIs gelten. KnownActionType kann austauschbar mit ActionType verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Interne: Aktionen gelten nur für interne APIs.
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 kann austauschbar mit CreatedByType verwendet werden, diese Enumeration enthält 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 Erlauben Deny (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 Aktualisieren von Löschen von Erfolgreich Abgesagt Fehler
KeyType	Die Zugriffstaste, die neu generiert werden soll. KnownKeyType- austauschbar mit KeyType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden PrimaryKey- SecondaryKey-
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 Erlauben
Origin	Der beabsichtigte Ausführungsführer des Vorgangs; wie bei der ressourcenbasierten Zugriffssteuerung (Resource Based Access Control, RBAC) und der UX für Überwachungsprotokolle. Standardwert ist "User,System" KnownOrigin kann austauschbar mit Origin verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Benutzer-: Gibt an, dass der Vorgang von einem Benutzer initiiert wird. System-: Gibt an, dass der Vorgang von einem System initiiert wird. Benutzer,System: Gibt an, dass der Vorgang von einem Benutzer oder System initiiert wird.
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 Ausstehend Genehmigt Rejected Getrennt
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 Aktiviert Disabled SecuredByPerimeter
Relaytype	WCF-Relaytyp.
SkuName	Name dieser 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 Standard
SkuTier	Die Ebene dieser SKU. KnownSkuTier- austauschbar mit SkuTier verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Standard
UnavailableReason	Gibt den Grund für die Nichtverfügbarkeit des Diensts an. KnownUnavailableReason kann austauschbar mit UnavailableReason verwendet werden; dieses Enum enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden None InvalidName SubscriptionIsDisabled NameInUse NameInLockdown Zu vieleNamespaceInCurrentSubscription

Enumerationen

AzureClouds	Ein Enum zur Beschreibung von Azure Cloud-Umgebungen.
KnownAccessRights	Bekannte Werte von AccessRights, die der Dienst akzeptiert.
KnownActionType	Erweiterbare Enumeration. Gibt den Aktionstyp an. "Intern" bezieht sich auf Aktionen, die nur für interne APIs gelten.
KnownCreatedByType	Die Art der Entität, die die Ressource erstellt hat.
KnownDefaultAction	Standardaktion für netzwerkregelsatz
KnownEndPointProvisioningState	Bereitstellungsstatus der privaten Endpunktverbindung.
KnownKeyType	Die Zugriffstaste, die neu generiert werden soll.
KnownNetworkRuleIPAction	Die IP-Filteraktion
KnownOrigin	Der beabsichtigte Ausführungsführer des Vorgangs; wie bei der ressourcenbasierten Zugriffssteuerung (Resource Based Access Control, RBAC) und der UX für Überwachungsprotokolle. Standardwert ist "User,System"
KnownPrivateLinkConnectionStatus	Status der Verbindung.
KnownPublicNetworkAccess	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert.
KnownSkuName	Name dieser SKU.
KnownSkuTier	Die Ebene dieser SKU.
KnownUnavailableReason	Gibt den Grund für die Nichtverfügbarkeit des Diensts an.
KnownVersions	Die verfügbaren API-Versionen.

Functions

isRestError(unknown)	Typeguard für RestError
restorePoller<TResponse, TResult>(RelayAPI, 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.

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>(RelayAPI, 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: RelayAPI, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameter

client: RelayAPI

serializedState: string

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

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Gibt zurück

PollerLike<OperationState<TResult>, TResult>

RestError

Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen.

RestError: RestErrorConstructor

Typ

RestErrorConstructor

@azure/arm-relay package

Klassen

Schnittstellen

Typaliase

Bekannte Werte, die vom Dienst unterstützt werden

Bekannte Werte, die vom Dienst unterstützt werden

Bekannte Werte, die vom Dienst unterstützt werden

Bekannte Werte, die vom Dienst unterstützt werden

Bekannte Werte, die vom Dienst unterstützt werden

Bekannte Werte, die vom Dienst unterstützt werden

Bekannte Werte, die vom Dienst unterstützt werden

Bekannte Werte, die vom Dienst unterstützt werden

Bekannte Werte, die vom Dienst unterstützt werden

Bekannte Werte, die vom Dienst unterstützt werden

Bekannte Werte, die vom Dienst unterstützt werden

Bekannte Werte, die vom Dienst unterstützt werden

Enumerationen

Functions

Variablen

Details zur Funktion

isRestError(unknown)

Parameter

Gibt zurück

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

Parameter

Gibt zurück

Details zu Variablen

RestError

Typ

Feedback