@azure/arm-relay package

Classi

RelayAPI

Interfacce

AccessKeys

Stringa di connessione dello spazio dei nomi/inoltro

AuthorizationRule

Elemento singolo in un'operazione List o Get AuthorizationRule

AuthorizationRuleProperties

Proprietà fornite per creare o aggiornare AuthorizationRule

CheckNameAvailability

Descrizione delle proprietà della richiesta di disponibilità del nome di controllo.

CheckNameAvailabilityResult

Descrizione delle proprietà della richiesta di disponibilità del nome di controllo.

ConnectionState

Informazioni di ConnectionState.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

ErrorDetail

Dettagli dell'errore.

ErrorResponse

Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite.

HybridConnection

Descrizione della risorsa di connessione ibrida.

HybridConnectionProperties

Proprietà di HybridConnection.

HybridConnectionsCreateOrUpdateAuthorizationRuleOptionalParams

Parametri facoltativi.

HybridConnectionsCreateOrUpdateOptionalParams

Parametri facoltativi.

HybridConnectionsDeleteAuthorizationRuleOptionalParams

Parametri facoltativi.

HybridConnectionsDeleteOptionalParams

Parametri facoltativi.

HybridConnectionsGetAuthorizationRuleOptionalParams

Parametri facoltativi.

HybridConnectionsGetOptionalParams

Parametri facoltativi.

HybridConnectionsListAuthorizationRulesOptionalParams

Parametri facoltativi.

HybridConnectionsListByNamespaceOptionalParams

Parametri facoltativi.

HybridConnectionsListKeysOptionalParams

Parametri facoltativi.

HybridConnectionsOperations

Interfaccia che rappresenta un'operazione HybridConnections.

HybridConnectionsRegenerateKeysOptionalParams

Parametri facoltativi.

NWRuleSetIpRules

Risposta dell'operazione dello spazio dei nomi List.

NamespacesCheckNameAvailabilityOptionalParams

Parametri facoltativi.

NamespacesCreateOrUpdateAuthorizationRuleOptionalParams

Parametri facoltativi.

NamespacesCreateOrUpdateNetworkRuleSetOptionalParams

Parametri facoltativi.

NamespacesCreateOrUpdateOptionalParams

Parametri facoltativi.

NamespacesDeleteAuthorizationRuleOptionalParams

Parametri facoltativi.

NamespacesDeleteOptionalParams

Parametri facoltativi.

NamespacesGetAuthorizationRuleOptionalParams

Parametri facoltativi.

NamespacesGetNetworkRuleSetOptionalParams

Parametri facoltativi.

NamespacesGetOptionalParams

Parametri facoltativi.

NamespacesListAuthorizationRulesOptionalParams

Parametri facoltativi.

NamespacesListByResourceGroupOptionalParams

Parametri facoltativi.

NamespacesListKeysOptionalParams

Parametri facoltativi.

NamespacesListOptionalParams

Parametri facoltativi.

NamespacesOperations

Interfaccia che rappresenta un'operazione di Namespaces.

NamespacesRegenerateKeysOptionalParams

Parametri facoltativi.

NamespacesUpdateOptionalParams

Parametri facoltativi.

NetworkRuleSet

Descrizione della risorsa argomento.

NetworkRuleSetProperties

Proprietà NetworkRuleSet

Operation

Dettagli di un'operazione API REST, restituita dall'API operazioni del provider di risorse

OperationDisplay

Informazioni di visualizzazione localizzate per un'operazione.

OperationsListOptionalParams

Parametri facoltativi.

OperationsOperations

Interfaccia che rappresenta un'operazione operations.

PageSettings

Opzioni per il metodo byPage

PagedAsyncIterableIterator

Interfaccia che consente l'iterazione iterabile asincrona sia al completamento che alla pagina.

PrivateEndpoint

Informazioni privateEndpoint.

PrivateEndpointConnection

Proprietà di PrivateEndpointConnection.

PrivateEndpointConnectionProperties

Proprietà della risorsa di connessione dell'endpoint privato.

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Parametri facoltativi.

PrivateEndpointConnectionsDeleteOptionalParams

Parametri facoltativi.

PrivateEndpointConnectionsGetOptionalParams

Parametri facoltativi.

PrivateEndpointConnectionsListOptionalParams

Parametri facoltativi.

PrivateEndpointConnectionsOperations

Interfaccia che rappresenta un'operazione PrivateEndpointConnections.

PrivateLinkResource

Risorsa che supporta le funzionalità di collegamento privato.

PrivateLinkResourceProperties

Proprietà di PrivateLinkResource

PrivateLinkResourcesGetOptionalParams

Parametri facoltativi.

PrivateLinkResourcesListOptionalParams

Parametri facoltativi.

PrivateLinkResourcesListResult

Risultato dell'operazione Elenca risorse collegamento privato.

PrivateLinkResourcesOperations

Interfaccia che rappresenta un'operazione PrivateLinkResources.

ProxyResource

Definizione del modello di risorse per una risorsa proxy di Azure Resource Manager. Non avrà tag e una posizione

RegenerateAccessKeyParameters

Parametri forniti all'operazione di rigenerazione della regola di autorizzazione, specifica quale chiave deve essere reimpostata.

RelayAPIOptionalParams

Parametri facoltativi per il client.

RelayNamespace

Descrizione di una risorsa dello spazio dei nomi.

RelayNamespaceProperties

Proprietà dello spazio dei nomi.

RelayUpdateParameters

Descrizione di una risorsa dello spazio dei nomi.

Resource

Campi comuni restituiti nella risposta per tutte le risorse di Azure Resource Manager

ResourceNamespacePatch

Definizione di risorsa.

RestorePollerOptions
SimplePollerLike

Un semplice poller che può essere usato per eseguire il polling di un'operazione a esecuzione prolungata.

Sku

SKU dello spazio dei nomi.

SystemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

TrackedResource

La definizione del modello di risorsa per una risorsa di livello superiore di Azure Resource Manager con "tag" e "location"

WcfRelay

Descrizione della risorsa di inoltro WCF.

WcfRelayProperties

Proprietà dell'inoltro WCF.

wCFRelaysCreateOrUpdateAuthorizationRuleOptionalParams

Parametri facoltativi.

wCFRelaysCreateOrUpdateOptionalParams

Parametri facoltativi.

wCFRelaysDeleteAuthorizationRuleOptionalParams

Parametri facoltativi.

wCFRelaysDeleteOptionalParams

Parametri facoltativi.

wCFRelaysGetAuthorizationRuleOptionalParams

Parametri facoltativi.

wCFRelaysGetOptionalParams

Parametri facoltativi.

wCFRelaysListAuthorizationRulesOptionalParams

Parametri facoltativi.

wCFRelaysListByNamespaceOptionalParams

Parametri facoltativi.

wCFRelaysListKeysOptionalParams

Parametri facoltativi.

wCFRelaysOperations

Interfaccia che rappresenta un'operazione wCFRelays.

wCFRelaysRegenerateKeysOptionalParams

Parametri facoltativi.

Alias tipo

AccessRights

Tipo di diritti di accesso

ActionType

Enumerazione estendibile. Indica il tipo di azione. "Interno" si riferisce alle azioni destinate solo alle API interne.
KnownActionType può essere usato in modo intercambiabile con ActionType, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

interno: le azioni sono destinate alle API solo interne.

AzureSupportedClouds

I valori supportati per l'impostazione cloud come tipo letterale stringa

ContinuablePage

Interfaccia che descrive una pagina di risultati.

CreatedByType

Tipo di entità che ha creato la risorsa.
KnownCreatedByType può essere usato in modo intercambiabile con CreatedByType, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

User: l'entità è stata creata da un utente.
'applicazione: l'entità è stata creata da un'applicazione.
ManagedIdentity: l'entità è stata creata da un'identità gestita.
Key: l'entità è stata creata da una chiave.

DefaultAction

Azione predefinita per il set di regole di rete
KnownDefaultAction può essere usato in modo intercambiabile con DefaultAction, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Consenti
Nega

EndPointProvisioningState

Stato di provisioning della connessione endpoint privato.
KnownEndPointProvisioningState può essere utilizzato in modo intercambiabile con EndPointProvisioningState, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Creazione
Aggiornamento
Eliminazione...
Riuscito
Annullato
Non riuscito

KeyType

Chiave di accesso da rigenerare.
KnownKeyType può essere usato in modo intercambiabile con KeyType, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

PrimaryKey
SecondaryKey

NetworkRuleIPAction

L'azione del filtro IP
KnownNetworkRuleIPAction può essere usato in modo intercambiabile con NetworkRuleIPAction, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Consenti

Origin

Esecutore previsto dell'operazione; come nel Controllo degli accessi basato sulle risorse (RBAC) e nell'interfaccia utente dei log di audit. Il valore predefinito è "user, system"
KnownOrigin può essere usato in modo intercambiabile con Origin, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

'utente: indica che l'operazione viene avviata da un utente.
di sistema: indica che l'operazione viene avviata da un sistema.
utente,di sistema: indica che l'operazione viene avviata da un utente o da un sistema.

PrivateLinkConnectionStatus

Stato della connessione.
KnownPrivateLinkConnectionStatus può essere usato in modo intercambiabile con PrivateLinkConnectionStatus, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

In sospeso
Approvata
Rifiutato
Disconnesso

PublicNetworkAccess

Determina se il traffico è consentito in rete pubblica. Per impostazione predefinita, è abilitata.
KnownPublicNetworkAccess può essere usato in modo intercambiabile con PublicNetworkAccess, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

abilitato
Disattivato
SecuredByPerimeter

Relaytype

Tipo di inoltro WCF.

SkuName

Nome di questo SKU.
KnownSkuName può essere usato in modo intercambiabile con SkuName, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Standard

SkuTier

Livello di questo SKU.
KnownSkuTier può essere usato in modo intercambiabile con SkuTier, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Standard

UnavailableReason

Specifica il motivo dell'indisponibilità del servizio.
KnownUnavailableReason può essere usato in modo intercambiabile con UnavailableReason, questo enum contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

None
InvalidName
AbbonamentoDisabilitato
NameInUse
NameInLockdown
TroppoMoltiSpazioNomiInCurrentSubscription

Enumerazioni

AzureClouds

Un enum per descrivere gli ambienti Azure Cloud.

KnownAccessRights

Valori noti di AccessRights accettati dal servizio.

KnownActionType

Enumerazione estendibile. Indica il tipo di azione. "Interno" si riferisce alle azioni destinate solo alle API interne.

KnownCreatedByType

Tipo di entità che ha creato la risorsa.

KnownDefaultAction

Azione predefinita per il set di regole di rete

KnownEndPointProvisioningState

Stato di provisioning della connessione endpoint privato.

KnownKeyType

Chiave di accesso da rigenerare.

KnownNetworkRuleIPAction

Azione filtro IP

KnownOrigin

Esecutore previsto dell'operazione; come nel Controllo degli accessi basato sulle risorse (RBAC) e nell'interfaccia utente dei log di audit. Il valore predefinito è "user, system"

KnownPrivateLinkConnectionStatus

Stato della connessione.

KnownPublicNetworkAccess

Determina se il traffico è consentito in rete pubblica. Per impostazione predefinita, è abilitata.

KnownSkuName

Nome di questo SKU.

KnownSkuTier

Livello di questo SKU.

KnownUnavailableReason

Specifica il motivo dell'indisponibilità del servizio.

KnownVersions

Versioni dell'API disponibili.

Funzioni

isRestError(unknown)

Typeguard per RestError

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

Crea un poller dallo stato serializzato di un altro poller. Questo può essere utile quando si desidera creare poller in un host diverso o un poller deve essere costruito dopo che quello originale non è nell'ambito.

Variabili

RestError

Tipo di errore personalizzato per le richieste di pipeline non riuscite.

Dettagli funzione

isRestError(unknown)

Typeguard per RestError

function isRestError(e: unknown): e

Parametri

e

unknown

Un elemento rilevato da una clausola catch.

Valori restituiti

e

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

Crea un poller dallo stato serializzato di un altro poller. Questo può essere utile quando si desidera creare poller in un host diverso o un poller deve essere costruito dopo che quello originale non è nell'ambito.

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

Parametri

client
RelayAPI
serializedState

string

sourceOperation

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

Valori restituiti

PollerLike<OperationState<TResult>, TResult>

Dettagli delle variabili

RestError

Tipo di errore personalizzato per le richieste di pipeline non riuscite.

RestError: RestErrorConstructor

Tipo