GatewayApi interface

Paquet:

@azure/arm-apimanagement

Interface représentant une gatewayApi.

Méthodes

createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)	Ajoute une API à la passerelle spécifiée.
delete(string, string, string, string, GatewayApiDeleteOptionalParams)	Supprime l’API spécifiée de la passerelle spécifiée.
getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)	Vérifie que l’entité d’API spécifiée par l’identificateur est associée à l’entité de passerelle.
listByService(string, string, string, GatewayApiListByServiceOptionalParams)	Répertorie une collection des API associées à une passerelle.

Détails de la méthode

createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)

Ajoute une API à la passerelle spécifiée.

function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiCreateOrUpdateOptionalParams): Promise<ApiContract>

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 l’instance actuelle du service Gestion des API. Ne doit pas avoir la valeur 'managed'

apiId

string

Identificateur d’API. Doit être unique dans l’instance actuelle du service Gestion des API.

options

GatewayApiCreateOrUpdateOptionalParams

Paramètres d’options.

Retours

Promise<ApiContract>

delete(string, string, string, string, GatewayApiDeleteOptionalParams)

Supprime l’API spécifiée de la passerelle spécifiée.

function delete(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiDeleteOptionalParams): 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 l’instance actuelle du service Gestion des API. Ne doit pas avoir la valeur 'managed'

apiId

string

Identificateur d’API. Doit être unique dans l’instance actuelle du service Gestion des API.

options

GatewayApiDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)

Vérifie que l’entité d’API spécifiée par l’identificateur est associée à l’entité de passerelle.

function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiGetEntityTagOptionalParams): Promise<GatewayApiGetEntityTagHeaders>

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 l’instance actuelle du service Gestion des API. Ne doit pas avoir la valeur 'managed'

apiId

string

Identificateur d’API. Doit être unique dans l’instance actuelle du service Gestion des API.

options

GatewayApiGetEntityTagOptionalParams

Paramètres d’options.

Retours

Promise<GatewayApiGetEntityTagHeaders>

listByService(string, string, string, GatewayApiListByServiceOptionalParams)

Répertorie une collection des API associées à une passerelle.

function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], 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.

gatewayId

string

Identificateur d’entité de passerelle. Doit être unique dans l’instance actuelle du service Gestion des API. Ne doit pas avoir la valeur 'managed'

options

GatewayApiListByServiceOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>