Gateway interface
Interface représentant une passerelle.
Méthodes
Détails de la méthode
createOrUpdate(string, string, string, GatewayContract, GatewayCreateOrUpdateOptionalParams)
Crée ou met à jour une passerelle à utiliser dans gestion des API instance.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayContract, options?: GatewayCreateOrUpdateOptionalParams): Promise<GatewayCreateOrUpdateResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- gatewayId
-
string
Identificateur d’entité de passerelle. Doit être unique dans le instance de service Gestion des API actuel. Ne doit pas avoir la valeur 'managed'
- parameters
- GatewayContract
Détails de la passerelle.
Paramètres d’options.
Retours
Promise<GatewayCreateOrUpdateResponse>
delete(string, string, string, string, GatewayDeleteOptionalParams)
Supprime une passerelle spécifique.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, options?: GatewayDeleteOptionalParams): Promise<void>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- gatewayId
-
string
Identificateur d’entité de passerelle. Doit être unique dans le instance de service Gestion des API actuel. Ne doit pas avoir la valeur 'managed'
- ifMatch
-
string
ETag de l’entité. ETag doit correspondre à l’état actuel de l’entité à partir de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.
- options
- GatewayDeleteOptionalParams
Paramètres d’options.
Retours
Promise<void>
generateToken(string, string, string, GatewayTokenRequestContract, GatewayGenerateTokenOptionalParams)
Obtient le jeton d’autorisation d’accès partagé pour la passerelle.
function generateToken(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayTokenRequestContract, options?: GatewayGenerateTokenOptionalParams): Promise<GatewayTokenContract>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- gatewayId
-
string
Identificateur d’entité de passerelle. Doit être unique dans le instance de service Gestion des API actuel. Ne doit pas avoir la valeur 'managed'
- parameters
- GatewayTokenRequestContract
Propriétés du contrat de demande de jeton de passerelle.
Paramètres d’options.
Retours
Promise<GatewayTokenContract>
get(string, string, string, GatewayGetOptionalParams)
Obtient les détails de la passerelle spécifiée par son identificateur.
function get(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetOptionalParams): Promise<GatewayGetResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- gatewayId
-
string
Identificateur d’entité de passerelle. Doit être unique dans le instance de service Gestion des API actuel. Ne doit pas avoir la valeur 'managed'
- options
- GatewayGetOptionalParams
Paramètres d’options.
Retours
Promise<GatewayGetResponse>
getEntityTag(string, string, string, GatewayGetEntityTagOptionalParams)
Obtient la version d’état d’entité (Etag) de la passerelle spécifiée par son identificateur.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetEntityTagOptionalParams): Promise<GatewayGetEntityTagHeaders>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- gatewayId
-
string
Identificateur d’entité de passerelle. Doit être unique dans le instance de service Gestion des API actuel. Ne doit pas avoir la valeur 'managed'
Paramètres d’options.
Retours
Promise<GatewayGetEntityTagHeaders>
listByService(string, string, GatewayListByServiceOptionalParams)
Répertorie une collection de passerelles inscrites auprès de l’instance de service.
function listByService(resourceGroupName: string, serviceName: string, options?: GatewayListByServiceOptionalParams): PagedAsyncIterableIterator<GatewayContract, GatewayContract[], PageSettings>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
Paramètres d’options.
Retours
listKeys(string, string, string, GatewayListKeysOptionalParams)
Récupère les clés de passerelle.
function listKeys(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayListKeysOptionalParams): Promise<GatewayListKeysResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- gatewayId
-
string
Identificateur d’entité de passerelle. Doit être unique dans le instance de service Gestion des API actuel. Ne doit pas avoir la valeur 'managed'
- options
- GatewayListKeysOptionalParams
Paramètres d’options.
Retours
Promise<GatewayListKeysResponse>
regenerateKey(string, string, string, GatewayKeyRegenerationRequestContract, GatewayRegenerateKeyOptionalParams)
Régénère la clé de passerelle spécifiée, invalidant tous les jetons créés avec elle.
function regenerateKey(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayKeyRegenerationRequestContract, options?: GatewayRegenerateKeyOptionalParams): Promise<void>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- gatewayId
-
string
Identificateur d’entité de passerelle. Doit être unique dans le instance de service Gestion des API actuel. Ne doit pas avoir la valeur 'managed'
- parameters
- GatewayKeyRegenerationRequestContract
Propriétés du contrat de demande de régénération de clé de passerelle.
Paramètres d’options.
Retours
Promise<void>
update(string, string, string, string, GatewayContract, GatewayUpdateOptionalParams)
Mises à jour les détails de la passerelle spécifiée par son identificateur.
function update(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, parameters: GatewayContract, options?: GatewayUpdateOptionalParams): Promise<GatewayUpdateResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- gatewayId
-
string
Identificateur d’entité de passerelle. Doit être unique dans le instance de service Gestion des API actuel. Ne doit pas avoir la valeur 'managed'
- ifMatch
-
string
ETag de l’entité. ETag doit correspondre à l’état actuel de l’entité à partir de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.
- parameters
- GatewayContract
Détails de la passerelle.
- options
- GatewayUpdateOptionalParams
Paramètres d’options.
Retours
Promise<GatewayUpdateResponse>