ApiGateway interface
Interface représentant un ApiGateway.
Méthodes
Détails de la méthode
beginCreateOrUpdate(string, string, ApiManagementGatewayResource, ApiGatewayCreateOrUpdateOptionalParams)
Crée ou met à jour une passerelle Gestion des API. Il s’agit d’une opération longue et peut prendre plusieurs minutes.
function beginCreateOrUpdate(resourceGroupName: string, gatewayName: string, parameters: ApiManagementGatewayResource, options?: ApiGatewayCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementGatewayResource>, ApiManagementGatewayResource>>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- gatewayName
-
string
Nom de la passerelle Gestion des API.
- parameters
- ApiManagementGatewayResource
Paramètres fournis à l’opération de passerelle de gestion de l’API CreateOrUpdate.
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementGatewayResource>, ApiManagementGatewayResource>>
beginCreateOrUpdateAndWait(string, string, ApiManagementGatewayResource, ApiGatewayCreateOrUpdateOptionalParams)
Crée ou met à jour une passerelle Gestion des API. Il s’agit d’une opération longue et peut prendre plusieurs minutes.
function beginCreateOrUpdateAndWait(resourceGroupName: string, gatewayName: string, parameters: ApiManagementGatewayResource, options?: ApiGatewayCreateOrUpdateOptionalParams): Promise<ApiManagementGatewayResource>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- gatewayName
-
string
Nom de la passerelle Gestion des API.
- parameters
- ApiManagementGatewayResource
Paramètres fournis à l’opération de passerelle de gestion de l’API CreateOrUpdate.
Paramètres d’options.
Retours
Promise<ApiManagementGatewayResource>
beginDelete(string, string, ApiGatewayDeleteOptionalParams)
Supprime une passerelle gestion des API existante.
function beginDelete(resourceGroupName: string, gatewayName: string, options?: ApiGatewayDeleteOptionalParams): Promise<SimplePollerLike<OperationState<ApiGatewayDeleteResponse>, ApiGatewayDeleteResponse>>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- gatewayName
-
string
Nom de la passerelle Gestion des API.
- options
- ApiGatewayDeleteOptionalParams
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiGatewayDeleteResponse>, ApiGatewayDeleteResponse>>
beginDeleteAndWait(string, string, ApiGatewayDeleteOptionalParams)
Supprime une passerelle gestion des API existante.
function beginDeleteAndWait(resourceGroupName: string, gatewayName: string, options?: ApiGatewayDeleteOptionalParams): Promise<ApiGatewayDeleteResponse>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- gatewayName
-
string
Nom de la passerelle Gestion des API.
- options
- ApiGatewayDeleteOptionalParams
Paramètres d’options.
Retours
Promise<ApiGatewayDeleteResponse>
beginUpdate(string, string, ApiManagementGatewayUpdateParameters, ApiGatewayUpdateOptionalParams)
Met à jour une passerelle gestion des API existante.
function beginUpdate(resourceGroupName: string, gatewayName: string, parameters: ApiManagementGatewayUpdateParameters, options?: ApiGatewayUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementGatewayResource>, ApiManagementGatewayResource>>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- gatewayName
-
string
Nom de la passerelle Gestion des API.
- parameters
- ApiManagementGatewayUpdateParameters
Paramètres fournis à l’opération de passerelle de gestion de l’API CreateOrUpdate.
- options
- ApiGatewayUpdateOptionalParams
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementGatewayResource>, ApiManagementGatewayResource>>
beginUpdateAndWait(string, string, ApiManagementGatewayUpdateParameters, ApiGatewayUpdateOptionalParams)
Met à jour une passerelle gestion des API existante.
function beginUpdateAndWait(resourceGroupName: string, gatewayName: string, parameters: ApiManagementGatewayUpdateParameters, options?: ApiGatewayUpdateOptionalParams): Promise<ApiManagementGatewayResource>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- gatewayName
-
string
Nom de la passerelle Gestion des API.
- parameters
- ApiManagementGatewayUpdateParameters
Paramètres fournis à l’opération de passerelle de gestion de l’API CreateOrUpdate.
- options
- ApiGatewayUpdateOptionalParams
Paramètres d’options.
Retours
Promise<ApiManagementGatewayResource>
get(string, string, ApiGatewayGetOptionalParams)
Obtient une description de ressource de passerelle Gestion des API.
function get(resourceGroupName: string, gatewayName: string, options?: ApiGatewayGetOptionalParams): Promise<ApiManagementGatewayResource>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- gatewayName
-
string
Nom de la passerelle Gestion des API.
- options
- ApiGatewayGetOptionalParams
Paramètres d’options.
Retours
Promise<ApiManagementGatewayResource>
list(ApiGatewayListOptionalParams)
Répertoriez toutes les passerelles gestion des API dans un abonnement.
function list(options?: ApiGatewayListOptionalParams): PagedAsyncIterableIterator<ApiManagementGatewayResource, ApiManagementGatewayResource[], PageSettings>
Paramètres
- options
- ApiGatewayListOptionalParams
Paramètres d’options.
Retours
listByResourceGroup(string, ApiGatewayListByResourceGroupOptionalParams)
Répertorier toutes les passerelles Gestion des API au sein d’un groupe de ressources.
function listByResourceGroup(resourceGroupName: string, options?: ApiGatewayListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ApiManagementGatewayResource, ApiManagementGatewayResource[], PageSettings>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
Paramètres d’options.