@azure/arm-relay package
Třídy
| RelayAPI |
Rozhraní
| AccessKeys |
Obor názvů nebo připojovací řetězec služby Relay |
| AuthorizationRule |
Jedna položka v operaci Seznam nebo Získání autorizačního pravidla |
| AuthorizationRuleProperties |
Vlastnosti zadané k vytvoření nebo aktualizaci autorizačního pravidla |
| CheckNameAvailability |
Popis vlastností žádosti o dostupnost názvu kontroly |
| CheckNameAvailabilityResult |
Popis vlastností žádosti o dostupnost názvu kontroly |
| ConnectionState |
Informace o stavu připojení |
| ErrorAdditionalInfo |
Další informace o chybě při správě prostředků |
| ErrorDetail |
Podrobnosti o chybě. |
| ErrorResponse |
Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace |
| HybridConnection |
Popis prostředku hybridního připojení |
| HybridConnectionProperties |
Vlastnosti HybridConnection. |
| HybridConnectionsCreateOrUpdateAuthorizationRuleOptionalParams |
Volitelné parametry. |
| HybridConnectionsCreateOrUpdateOptionalParams |
Volitelné parametry. |
| HybridConnectionsDeleteAuthorizationRuleOptionalParams |
Volitelné parametry. |
| HybridConnectionsDeleteOptionalParams |
Volitelné parametry. |
| HybridConnectionsGetAuthorizationRuleOptionalParams |
Volitelné parametry. |
| HybridConnectionsGetOptionalParams |
Volitelné parametry. |
| HybridConnectionsListAuthorizationRulesOptionalParams |
Volitelné parametry. |
| HybridConnectionsListByNamespaceOptionalParams |
Volitelné parametry. |
| HybridConnectionsListKeysOptionalParams |
Volitelné parametry. |
| HybridConnectionsOperations |
Rozhraní reprezentující operace HybridConnections. |
| HybridConnectionsRegenerateKeysOptionalParams |
Volitelné parametry. |
| NWRuleSetIpRules |
Odpověď z operace Seznam oboru názvů. |
| NamespacesCheckNameAvailabilityOptionalParams |
Volitelné parametry. |
| NamespacesCreateOrUpdateAuthorizationRuleOptionalParams |
Volitelné parametry. |
| NamespacesCreateOrUpdateNetworkRuleSetOptionalParams |
Volitelné parametry. |
| NamespacesCreateOrUpdateOptionalParams |
Volitelné parametry. |
| NamespacesDeleteAuthorizationRuleOptionalParams |
Volitelné parametry. |
| NamespacesDeleteOptionalParams |
Volitelné parametry. |
| NamespacesGetAuthorizationRuleOptionalParams |
Volitelné parametry. |
| NamespacesGetNetworkRuleSetOptionalParams |
Volitelné parametry. |
| NamespacesGetOptionalParams |
Volitelné parametry. |
| NamespacesListAuthorizationRulesOptionalParams |
Volitelné parametry. |
| NamespacesListByResourceGroupOptionalParams |
Volitelné parametry. |
| NamespacesListKeysOptionalParams |
Volitelné parametry. |
| NamespacesListOptionalParams |
Volitelné parametry. |
| NamespacesOperations |
Rozhraní reprezentující operace se jmennými prostory. |
| NamespacesRegenerateKeysOptionalParams |
Volitelné parametry. |
| NamespacesUpdateOptionalParams |
Volitelné parametry. |
| NetworkRuleSet |
Popis zdroje témat. |
| NetworkRuleSetProperties |
Vlastnosti NetworkRuleSet |
| Operation |
Podrobnosti o operaci ROZHRANÍ REST API vrácené z rozhraní API pro operace poskytovatele prostředků |
| OperationDisplay |
Lokalizované zobrazovací informace pro operaci. |
| OperationsListOptionalParams |
Volitelné parametry. |
| OperationsOperations |
Rozhraní představující operace operací |
| PageSettings |
Možnosti pro metodu byPage |
| PagedAsyncIterableIterator |
Rozhraní, které umožňuje asynchronní iteraci k dokončení i po stránce. |
| PrivateEndpoint |
Informace o privátním koncovém bodu |
| PrivateEndpointConnection |
Vlastnosti PrivateEndpointConnection. |
| PrivateEndpointConnectionProperties |
Vlastnosti zdroje připojení soukromého koncového zařízení. |
| PrivateEndpointConnectionsCreateOrUpdateOptionalParams |
Volitelné parametry. |
| PrivateEndpointConnectionsDeleteOptionalParams |
Volitelné parametry. |
| PrivateEndpointConnectionsGetOptionalParams |
Volitelné parametry. |
| PrivateEndpointConnectionsListOptionalParams |
Volitelné parametry. |
| PrivateEndpointConnectionsOperations |
Rozhraní představující PrivateEndpointConnections operace. |
| PrivateLinkResource |
Prostředek, který podporuje možnosti privátního propojení. |
| PrivateLinkResourceProperties |
Vlastnosti PrivateLinkResource |
| PrivateLinkResourcesGetOptionalParams |
Volitelné parametry. |
| PrivateLinkResourcesListOptionalParams |
Volitelné parametry. |
| PrivateLinkResourcesListResult |
Výsledek operace vypsat prostředky privátního propojení |
| PrivateLinkResourcesOperations |
Rozhraní představující operace PrivateLinkResources. |
| ProxyResource |
Definice modelu prostředků pro prostředek proxy serveru Azure Resource Manageru. Nebude obsahovat značky a umístění. |
| RegenerateAccessKeyParameters |
Parametry zadané pro operaci opětovného vygenerování autorizačního pravidla určují, který klíč je třeba resetovat. |
| RelayAPIOptionalParams |
Volitelné parametry pro klienta. |
| RelayNamespace |
Popis prostředku oboru názvů |
| RelayNamespaceProperties |
Vlastnosti oboru názvů |
| RelayUpdateParameters |
Popis prostředku oboru názvů |
| Resource |
Běžná pole vrácená v odpovědi pro všechny prostředky Azure Resource Manageru |
| ResourceNamespacePatch |
Definice zdroje. |
| RestorePollerOptions | |
| SimplePollerLike |
Jednoduchý poller, který lze použít k dotazování dlouhotrvající operace. |
| Sku |
Skladová položka oboru názvů. |
| SystemData |
Metadata týkající se vytvoření a poslední změny prostředku. |
| TrackedResource |
Definice modelu prostředků pro Prostředek Azure Resource Manageru sledovala prostředek nejvyšší úrovně, který má značky a umístění. |
| WcfRelay |
Popis prostředku služby WCF relay |
| WcfRelayProperties |
Vlastnosti předávání WCF. |
| wCFRelaysCreateOrUpdateAuthorizationRuleOptionalParams |
Volitelné parametry. |
| wCFRelaysCreateOrUpdateOptionalParams |
Volitelné parametry. |
| wCFRelaysDeleteAuthorizationRuleOptionalParams |
Volitelné parametry. |
| wCFRelaysDeleteOptionalParams |
Volitelné parametry. |
| wCFRelaysGetAuthorizationRuleOptionalParams |
Volitelné parametry. |
| wCFRelaysGetOptionalParams |
Volitelné parametry. |
| wCFRelaysListAuthorizationRulesOptionalParams |
Volitelné parametry. |
| wCFRelaysListByNamespaceOptionalParams |
Volitelné parametry. |
| wCFRelaysListKeysOptionalParams |
Volitelné parametry. |
| wCFRelaysOperations |
Rozhraní reprezentující operace wCFRelays. |
| wCFRelaysRegenerateKeysOptionalParams |
Volitelné parametry. |
Aliasy typu
| AccessRights |
Typ přístupových práv |
| ActionType |
Rozšiřitelný výčt. Označuje typ akce. Interní označuje akce, které jsou určené pouze pro interní rozhraní API. Známé hodnoty podporované službouInterní: Akce jsou určené pouze pro interní rozhraní API. |
| AzureSupportedClouds |
Podporované hodnoty pro nastavení cloudu jako typ řetězcového literálu |
| ContinuablePage |
Rozhraní, které popisuje stránku výsledků. |
| CreatedByType |
Druh entity, která prostředek vytvořila. Známé hodnoty podporované službou
user: Entita byla vytvořena uživatelem. |
| DefaultAction |
Výchozí akce pro síťovou sadu pravidel Známé hodnoty podporované službou
Povolit |
| EndPointProvisioningState |
Stav zřizování připojení privátního koncového bodu Známé hodnoty podporované službouvytváření |
| KeyType |
Přístupový klíč, který se má znovu vygenerovat. Známé hodnoty podporované službou
primárního klíče |
| NetworkRuleIPAction |
Akce IP filtru Známé hodnoty podporované službouPovolit |
| Origin |
Zamýšlený vykonavatel operace; například v řízení přístupu založeném na prostředcích (RBAC) a v uživatelském rozhraní auditních protokolů. Výchozí hodnota je user, system. Známé hodnoty podporované službou
uživatel: Označuje, že operace je inicializována uživatelem. |
| PrivateLinkConnectionStatus |
Stav připojení. Známé hodnoty podporované službou
Pending |
| PublicNetworkAccess |
To určuje, jestli je provoz povolený přes veřejnou síť. Ve výchozím nastavení je povolená. Známé hodnoty podporované službou
Enabled |
| Relaytype |
Typ přenosu WCF. |
| SkuName |
Název této skladové položky. Známé hodnoty podporované službouStandard |
| SkuTier |
Úroveň této skladové položky. Známé hodnoty podporované službouStandard |
| UnavailableReason |
Určuje důvod nedostupnosti služby. Známé hodnoty podporované službou
None |
Výčty
| AzureClouds |
Enum pro popis prostředí Azure Cloud. |
| KnownAccessRights |
Známé hodnoty AccessRights, které služba přijímá. |
| KnownActionType |
Rozšiřitelný výčt. Označuje typ akce. Interní označuje akce, které jsou určené pouze pro interní rozhraní API. |
| KnownCreatedByType |
Druh entity, která prostředek vytvořila. |
| KnownDefaultAction |
Výchozí akce pro sadu pravidel sítě |
| KnownEndPointProvisioningState |
Stav zřizování připojení privátního koncového bodu |
| KnownKeyType |
Přístupový klíč, který se má znovu vygenerovat. |
| KnownNetworkRuleIPAction |
Akce filtru IP adres |
| KnownOrigin |
Zamýšlený vykonavatel operace; například v řízení přístupu založeném na prostředcích (RBAC) a v uživatelském rozhraní auditních protokolů. Výchozí hodnota je user, system. |
| KnownPrivateLinkConnectionStatus |
Stav připojení. |
| KnownPublicNetworkAccess |
To určuje, jestli je provoz povolený přes veřejnou síť. Ve výchozím nastavení je povolená. |
| KnownSkuName |
Název této skladové položky. |
| KnownSkuTier |
Úroveň této skladové položky. |
| KnownUnavailableReason |
Určuje důvod nedostupnosti služby. |
| KnownVersions |
Dostupné verze rozhraní API. |
Funkce
| is |
Typeguard pro RestError |
| restore |
Vytvoří poller ze serializovaného stavu jiného polleru. To může být užitečné v případě, že chcete vytvořit pollery na jiném hostiteli nebo je třeba vytvořit poller po původním dotazu, který není v rozsahu. |
Proměnné
| Rest |
Vlastní typ chyby pro neúspěšné požadavky kanálu. |
Podrobnosti funkce
isRestError(unknown)
Typeguard pro RestError
function isRestError(e: unknown): e
Parametry
- e
-
unknown
Něco zachyceného klauzulí catch.
Návraty
e
restorePoller<TResponse, TResult>(RelayAPI, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Vytvoří poller ze serializovaného stavu jiného polleru. To může být užitečné v případě, že chcete vytvořit pollery na jiném hostiteli nebo je třeba vytvořit poller po původním dotazu, který není v rozsahu.
function restorePoller<TResponse, TResult>(client: RelayAPI, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parametry
- client
- RelayAPI
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Návraty
PollerLike<OperationState<TResult>, TResult>
Podrobnosti proměnné
RestError
Vlastní typ chyby pro neúspěšné požadavky kanálu.
RestError: RestErrorConstructor