ApiManagementService interface
Interface représentant un ApiManagementService.
Méthodes
| begin |
Mises à jour la ressource Microsoft.ApiManagement en cours d’exécution dans le réseau virtuel pour sélectionner les modifications DNS mises à jour. |
| begin |
Mises à jour la ressource Microsoft.ApiManagement en cours d’exécution dans le réseau virtuel pour sélectionner les modifications DNS mises à jour. |
| begin |
Crée une sauvegarde du service Gestion des API dans le compte de stockage Azure donné. Il s’agit d’une opération de longue durée qui peut prendre plusieurs minutes. |
| begin |
Crée une sauvegarde du service Gestion des API dans le compte de stockage Azure donné. Il s’agit d’une opération de longue durée qui peut prendre plusieurs minutes. |
| begin |
Crée ou met à jour un service Gestion des API. Il s’agit d’une opération de longue durée qui peut prendre plusieurs minutes. |
| begin |
Crée ou met à jour un service Gestion des API. Il s’agit d’une opération de longue durée qui peut prendre plusieurs minutes. |
| begin |
Supprime un service Gestion des API existant. |
| begin |
Supprime un service Gestion des API existant. |
| begin |
Met à niveau un service Gestion des API vers la plateforme Stv2. Pour plus d’informations, reportez-vous à https://aka.ms/apim-migrate-stv2. Cette modification n’est pas réversible. Il s’agit d’une opération de longue durée qui peut prendre plusieurs minutes. |
| begin |
Met à niveau un service Gestion des API vers la plateforme Stv2. Pour plus d’informations, reportez-vous à https://aka.ms/apim-migrate-stv2. Cette modification n’est pas réversible. Il s’agit d’une opération de longue durée qui peut prendre plusieurs minutes. |
| begin |
Restaure une sauvegarde d’un service Gestion des API créé à l’aide de l’opération de ApiManagementService_Backup sur le service actuel. Il s’agit d’une opération de longue durée qui peut prendre plusieurs minutes. |
| begin |
Restaure une sauvegarde d’un service Gestion des API créé à l’aide de l’opération de ApiManagementService_Backup sur le service actuel. Il s’agit d’une opération de longue durée qui peut prendre plusieurs minutes. |
| begin |
Mises à jour un service de Gestion des API existant. |
| begin |
Mises à jour un service de Gestion des API existant. |
| check |
Vérifie la disponibilité et l’exactitude d’un nom pour un service Gestion des API. |
| get(string, string, Api |
Obtient une description de ressource de service Gestion des API. |
| get |
Obtenez l’identificateur de propriété de domaine personnalisé pour un service Gestion des API. |
| get |
Obtient le jeton d’authentification unique pour le service Gestion des API qui est valide pendant 5 minutes. |
| list(Api |
Répertorie tous les services Gestion des API au sein d’un abonnement Azure. |
| list |
Répertorier tous les services Gestion des API au sein d’un groupe de ressources. |
Détails de la méthode
beginApplyNetworkConfigurationUpdates(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)
Mises à jour la ressource Microsoft.ApiManagement en cours d’exécution dans le réseau virtuel pour sélectionner les modifications DNS mises à jour.
function beginApplyNetworkConfigurationUpdates(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>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
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginApplyNetworkConfigurationUpdatesAndWait(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)
Mises à jour la ressource Microsoft.ApiManagement en cours d’exécution dans le réseau virtuel pour sélectionner les modifications DNS mises à jour.
function beginApplyNetworkConfigurationUpdatesAndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams): Promise<ApiManagementServiceResource>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
Promise<ApiManagementServiceResource>
beginBackup(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)
Crée une sauvegarde du service Gestion des API dans le compte de stockage Azure donné. Il s’agit d’une opération de longue durée qui peut prendre plusieurs minutes.
function beginBackup(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceBackupOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- parameters
- ApiManagementServiceBackupRestoreParameters
Paramètres fournis à l’opération ApiManagementService_Backup.
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)
Crée une sauvegarde du service Gestion des API dans le compte de stockage Azure donné. Il s’agit d’une opération de longue durée qui peut prendre plusieurs minutes.
function beginBackupAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceBackupOptionalParams): Promise<ApiManagementServiceResource>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- parameters
- ApiManagementServiceBackupRestoreParameters
Paramètres fournis à l’opération ApiManagementService_Backup.
Paramètres d’options.
Retours
Promise<ApiManagementServiceResource>
beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)
Crée ou met à jour un service Gestion des API. Il s’agit d’une opération de longue durée qui peut prendre plusieurs minutes.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceResource, options?: ApiManagementServiceCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- parameters
- ApiManagementServiceResource
Paramètres fournis à l’opération de service CreateOrUpdate Gestion des API.
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)
Crée ou met à jour un service Gestion des API. Il s’agit d’une opération de longue durée qui peut prendre plusieurs minutes.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceResource, options?: ApiManagementServiceCreateOrUpdateOptionalParams): Promise<ApiManagementServiceResource>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- parameters
- ApiManagementServiceResource
Paramètres fournis à l’opération de service CreateOrUpdate Gestion des API.
Paramètres d’options.
Retours
Promise<ApiManagementServiceResource>
beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)
Supprime un service Gestion des API existant.
function beginDelete(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, 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.
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)
Supprime un service Gestion des API existant.
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceDeleteOptionalParams): 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.
Paramètres d’options.
Retours
Promise<void>
beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)
Met à niveau un service Gestion des API vers la plateforme Stv2. Pour plus d’informations, reportez-vous à https://aka.ms/apim-migrate-stv2. Cette modification n’est pas réversible. Il s’agit d’une opération de longue durée qui peut prendre plusieurs minutes.
function beginMigrateToStv2(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceMigrateToStv2OptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>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
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)
Met à niveau un service Gestion des API vers la plateforme Stv2. Pour plus d’informations, reportez-vous à https://aka.ms/apim-migrate-stv2. Cette modification n’est pas réversible. Il s’agit d’une opération de longue durée qui peut prendre plusieurs minutes.
function beginMigrateToStv2AndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceMigrateToStv2OptionalParams): Promise<ApiManagementServiceResource>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
Promise<ApiManagementServiceResource>
beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)
Restaure une sauvegarde d’un service Gestion des API créé à l’aide de l’opération de ApiManagementService_Backup sur le service actuel. Il s’agit d’une opération de longue durée qui peut prendre plusieurs minutes.
function beginRestore(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceRestoreOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- parameters
- ApiManagementServiceBackupRestoreParameters
Paramètres fournis au service Restore Gestion des API à partir de l’opération de sauvegarde.
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)
Restaure une sauvegarde d’un service Gestion des API créé à l’aide de l’opération de ApiManagementService_Backup sur le service actuel. Il s’agit d’une opération de longue durée qui peut prendre plusieurs minutes.
function beginRestoreAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceRestoreOptionalParams): Promise<ApiManagementServiceResource>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- parameters
- ApiManagementServiceBackupRestoreParameters
Paramètres fournis au service Restore Gestion des API à partir de l’opération de sauvegarde.
Paramètres d’options.
Retours
Promise<ApiManagementServiceResource>
beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)
Mises à jour un service de Gestion des API existant.
function beginUpdate(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceUpdateParameters, options?: ApiManagementServiceUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- parameters
- ApiManagementServiceUpdateParameters
Paramètres fournis à l’opération de service CreateOrUpdate Gestion des API.
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)
Mises à jour un service de Gestion des API existant.
function beginUpdateAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceUpdateParameters, options?: ApiManagementServiceUpdateOptionalParams): Promise<ApiManagementServiceResource>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- parameters
- ApiManagementServiceUpdateParameters
Paramètres fournis à l’opération de service CreateOrUpdate Gestion des API.
Paramètres d’options.
Retours
Promise<ApiManagementServiceResource>
checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)
Vérifie la disponibilité et l’exactitude d’un nom pour un service Gestion des API.
function checkNameAvailability(parameters: ApiManagementServiceCheckNameAvailabilityParameters, options?: ApiManagementServiceCheckNameAvailabilityOptionalParams): Promise<ApiManagementServiceNameAvailabilityResult>Paramètres
Paramètres fournis à l’opération CheckNameAvailability.
Paramètres d’options.
Retours
get(string, string, ApiManagementServiceGetOptionalParams)
Obtient une description de ressource de service Gestion des API.
function get(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceGetOptionalParams): Promise<ApiManagementServiceResource>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
Promise<ApiManagementServiceResource>
getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)
Obtenez l’identificateur de propriété de domaine personnalisé pour un service Gestion des API.
function getDomainOwnershipIdentifier(options?: ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams): Promise<ApiManagementServiceGetDomainOwnershipIdentifierResult>Paramètres
Paramètres d’options.
Retours
getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)
Obtient le jeton d’authentification unique pour le service Gestion des API qui est valide pendant 5 minutes.
function getSsoToken(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceGetSsoTokenOptionalParams): Promise<ApiManagementServiceGetSsoTokenResult>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
list(ApiManagementServiceListOptionalParams)
Répertorie tous les services Gestion des API au sein d’un abonnement Azure.
function list(options?: ApiManagementServiceListOptionalParams): PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>Paramètres
Paramètres d’options.
Retours
listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)
Répertorier tous les services Gestion des API au sein d’un groupe de ressources.
function listByResourceGroup(resourceGroupName: string, options?: ApiManagementServiceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
Paramètres d’options.