Gateway interface
Interfaccia che rappresenta un gateway.
Metodi
Dettagli metodo
createOrUpdate(string, string, string, GatewayContract, GatewayCreateOrUpdateOptionalParams)
Crea o aggiorna un gateway da usare nell'istanza di Gestione API.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayContract, options?: GatewayCreateOrUpdateOptionalParams): Promise<GatewayCreateOrUpdateResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- gatewayId
-
string
Identificatore di entità del gateway. Deve essere univoco nell'istanza corrente del servizio Gestione API. Non deve avere il valore 'managed'
- parameters
- GatewayContract
Dettagli del gateway.
Parametri delle opzioni.
Restituisce
Promise<GatewayCreateOrUpdateResponse>
delete(string, string, string, string, GatewayDeleteOptionalParams)
Elimina un gateway specifico.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, options?: GatewayDeleteOptionalParams): Promise<void>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- gatewayId
-
string
Identificatore di entità del gateway. Deve essere univoco nell'istanza corrente del servizio Gestione API. Non deve avere il valore 'managed'
- ifMatch
-
string
ETag dell'entità. ETag deve corrispondere allo stato corrente dell'entità dalla risposta dell'intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.
- options
- GatewayDeleteOptionalParams
Parametri delle opzioni.
Restituisce
Promise<void>
generateToken(string, string, string, GatewayTokenRequestContract, GatewayGenerateTokenOptionalParams)
Ottiene il token di autorizzazione di accesso condiviso per il gateway.
function generateToken(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayTokenRequestContract, options?: GatewayGenerateTokenOptionalParams): Promise<GatewayTokenContract>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- gatewayId
-
string
Identificatore di entità del gateway. Deve essere univoco nell'istanza corrente del servizio Gestione API. Non deve avere il valore 'managed'
- parameters
- GatewayTokenRequestContract
Proprietà del contratto di richiesta del token del gateway.
Parametri delle opzioni.
Restituisce
Promise<GatewayTokenContract>
get(string, string, string, GatewayGetOptionalParams)
Ottiene i dettagli del gateway specificato dal relativo identificatore.
function get(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetOptionalParams): Promise<GatewayGetResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- gatewayId
-
string
Identificatore di entità del gateway. Deve essere univoco nell'istanza corrente del servizio Gestione API. Non deve avere il valore 'managed'
- options
- GatewayGetOptionalParams
Parametri delle opzioni.
Restituisce
Promise<GatewayGetResponse>
getEntityTag(string, string, string, GatewayGetEntityTagOptionalParams)
Ottiene la versione dello stato dell'entità (Etag) del gateway specificato dal relativo identificatore.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetEntityTagOptionalParams): Promise<GatewayGetEntityTagHeaders>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- gatewayId
-
string
Identificatore di entità del gateway. Deve essere univoco nell'istanza corrente del servizio Gestione API. Non deve avere il valore 'managed'
Parametri delle opzioni.
Restituisce
Promise<GatewayGetEntityTagHeaders>
invalidateDebugCredentials(string, string, string, GatewayInvalidateDebugCredentialsOptionalParams)
L'azione invalida tutte le credenziali di debug rilasciate per il gateway.
function invalidateDebugCredentials(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayInvalidateDebugCredentialsOptionalParams): Promise<void>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- gatewayId
-
string
Identificatore di entità del gateway. Deve essere univoco nell'istanza corrente del servizio Gestione API. Non deve avere il valore 'managed'
Parametri delle opzioni.
Restituisce
Promise<void>
listByService(string, string, GatewayListByServiceOptionalParams)
Elenca una raccolta di gateway registrati con l'istanza del servizio.
function listByService(resourceGroupName: string, serviceName: string, options?: GatewayListByServiceOptionalParams): PagedAsyncIterableIterator<GatewayContract, GatewayContract[], PageSettings>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
Parametri delle opzioni.
Restituisce
listDebugCredentials(string, string, string, GatewayListDebugCredentialsContract, GatewayListDebugCredentialsOptionalParams)
Creare nuove credenziali di debug per il gateway.
function listDebugCredentials(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayListDebugCredentialsContract, options?: GatewayListDebugCredentialsOptionalParams): Promise<GatewayDebugCredentialsContract>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- gatewayId
-
string
Identificatore di entità del gateway. Deve essere univoco nell'istanza corrente del servizio Gestione API. Non deve avere il valore 'managed'
- parameters
- GatewayListDebugCredentialsContract
Elencare le proprietà delle credenziali di debug.
Parametri delle opzioni.
Restituisce
Promise<GatewayDebugCredentialsContract>
listKeys(string, string, string, GatewayListKeysOptionalParams)
Recupera le chiavi del gateway.
function listKeys(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayListKeysOptionalParams): Promise<GatewayListKeysResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- gatewayId
-
string
Identificatore di entità del gateway. Deve essere univoco nell'istanza corrente del servizio Gestione API. Non deve avere il valore 'managed'
- options
- GatewayListKeysOptionalParams
Parametri delle opzioni.
Restituisce
Promise<GatewayListKeysResponse>
listTrace(string, string, string, GatewayListTraceContract, GatewayListTraceOptionalParams)
Recupera la traccia raccolta dal gateway.
function listTrace(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayListTraceContract, options?: GatewayListTraceOptionalParams): Promise<GatewayListTraceResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- gatewayId
-
string
Identificatore di entità del gateway. Deve essere univoco nell'istanza corrente del servizio Gestione API. Non deve avere il valore 'managed'
- parameters
- GatewayListTraceContract
Elencare le proprietà di traccia.
- options
- GatewayListTraceOptionalParams
Parametri delle opzioni.
Restituisce
Promise<GatewayListTraceResponse>
regenerateKey(string, string, string, GatewayKeyRegenerationRequestContract, GatewayRegenerateKeyOptionalParams)
Rigenera la chiave del gateway specificata invalidando tutti i token creati con esso.
function regenerateKey(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayKeyRegenerationRequestContract, options?: GatewayRegenerateKeyOptionalParams): Promise<void>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- gatewayId
-
string
Identificatore di entità del gateway. Deve essere univoco nell'istanza corrente del servizio Gestione API. Non deve avere il valore 'managed'
- parameters
- GatewayKeyRegenerationRequestContract
Proprietà del contratto di richiesta di rigenerazione della chiave del gateway.
Parametri delle opzioni.
Restituisce
Promise<void>
update(string, string, string, string, GatewayContract, GatewayUpdateOptionalParams)
Aggiorna i dettagli del gateway specificato dal relativo identificatore.
function update(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, parameters: GatewayContract, options?: GatewayUpdateOptionalParams): Promise<GatewayUpdateResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- gatewayId
-
string
Identificatore di entità del gateway. Deve essere univoco nell'istanza corrente del servizio Gestione API. Non deve avere il valore 'managed'
- ifMatch
-
string
ETag dell'entità. ETag deve corrispondere allo stato corrente dell'entità dalla risposta dell'intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.
- parameters
- GatewayContract
Dettagli del gateway.
- options
- GatewayUpdateOptionalParams
Parametri delle opzioni.
Restituisce
Promise<GatewayUpdateResponse>