ApiDefinitions interface
Interface représentant une ApiDefinitions.
Méthodes
Détails de la méthode
beginExportSpecification(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)
Exporte la spécification de l’API.
function beginExportSpecification(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsExportSpecificationOptionalParams): Promise<SimplePollerLike<OperationState<ApiSpecExportResult>, ApiSpecExportResult>>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Du Centre des API Azure.
- workspaceName
-
string
Nom de l’espace de travail.
- apiName
-
string
Nom de l’API.
- versionName
-
string
Nom de la version de l’API.
- definitionName
-
string
Nom de la définition de l’API.
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiSpecExportResult>, ApiSpecExportResult>>
beginExportSpecificationAndWait(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)
Exporte la spécification de l’API.
function beginExportSpecificationAndWait(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsExportSpecificationOptionalParams): Promise<ApiSpecExportResult>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Du Centre des API Azure.
- workspaceName
-
string
Nom de l’espace de travail.
- apiName
-
string
Nom de l’API.
- versionName
-
string
Nom de la version de l’API.
- definitionName
-
string
Nom de la définition de l’API.
Paramètres d’options.
Retours
Promise<ApiSpecExportResult>
beginImportSpecification(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)
Importe la spécification de l’API.
function beginImportSpecification(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, body: ApiSpecImportRequest, options?: ApiDefinitionsImportSpecificationOptionalParams): 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 Du Centre des API Azure.
- workspaceName
-
string
Nom de l’espace de travail.
- apiName
-
string
Nom de l’API.
- versionName
-
string
Nom de la version de l’API.
- definitionName
-
string
Nom de la définition de l’API.
- body
- ApiSpecImportRequest
Contenu de la demande d’action
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginImportSpecificationAndWait(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)
Importe la spécification de l’API.
function beginImportSpecificationAndWait(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, body: ApiSpecImportRequest, options?: ApiDefinitionsImportSpecificationOptionalParams): Promise<void>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Du Centre des API Azure.
- workspaceName
-
string
Nom de l’espace de travail.
- apiName
-
string
Nom de l’API.
- versionName
-
string
Nom de la version de l’API.
- definitionName
-
string
Nom de la définition de l’API.
- body
- ApiSpecImportRequest
Contenu de la demande d’action
Paramètres d’options.
Retours
Promise<void>
createOrUpdate(string, string, string, string, string, string, ApiDefinition, ApiDefinitionsCreateOrUpdateOptionalParams)
Crée ou met à jour une définition d’API existante.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, resource: ApiDefinition, options?: ApiDefinitionsCreateOrUpdateOptionalParams): Promise<ApiDefinitionsCreateOrUpdateResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Du Centre des API Azure.
- workspaceName
-
string
Nom de l’espace de travail.
- apiName
-
string
Nom de l’API.
- versionName
-
string
Nom de la version de l’API.
- definitionName
-
string
Nom de la définition de l’API.
- resource
- ApiDefinition
Paramètres de création de ressources.
Paramètres d’options.
Retours
Promise<ApiDefinitionsCreateOrUpdateResponse>
delete(string, string, string, string, string, string, ApiDefinitionsDeleteOptionalParams)
Supprime la définition d’API spécifiée.
function delete(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsDeleteOptionalParams): Promise<void>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Du Centre des API Azure.
- workspaceName
-
string
Nom de l’espace de travail.
- apiName
-
string
Nom de l’API.
- versionName
-
string
Nom de la version de l’API.
- definitionName
-
string
Nom de la définition de l’API.
Paramètres d’options.
Retours
Promise<void>
get(string, string, string, string, string, string, ApiDefinitionsGetOptionalParams)
Retourne les détails de la définition de l’API.
function get(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsGetOptionalParams): Promise<ApiDefinitionsGetResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Du Centre des API Azure.
- workspaceName
-
string
Nom de l’espace de travail.
- apiName
-
string
Nom de l’API.
- versionName
-
string
Nom de la version de l’API.
- definitionName
-
string
Nom de la définition de l’API.
- options
- ApiDefinitionsGetOptionalParams
Paramètres d’options.
Retours
Promise<ApiDefinitionsGetResponse>
head(string, string, string, string, string, string, ApiDefinitionsHeadOptionalParams)
Vérifie si la définition d’API spécifiée existe.
function head(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsHeadOptionalParams): Promise<ApiDefinitionsHeadResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Du Centre des API Azure.
- workspaceName
-
string
Nom de l’espace de travail.
- apiName
-
string
Nom de l’API.
- versionName
-
string
Nom de la version de l’API.
- definitionName
-
string
Nom de la définition de l’API.
- options
- ApiDefinitionsHeadOptionalParams
Paramètres d’options.
Retours
Promise<ApiDefinitionsHeadResponse>
list(string, string, string, string, string, ApiDefinitionsListOptionalParams)
Retourne une collection de définitions d’API.
function list(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, options?: ApiDefinitionsListOptionalParams): PagedAsyncIterableIterator<ApiDefinition, ApiDefinition[], PageSettings>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Du Centre des API Azure.
- workspaceName
-
string
Nom de l’espace de travail.
- apiName
-
string
Nom de l’API.
- versionName
-
string
Nom de la version de l’API.
- options
- ApiDefinitionsListOptionalParams
Paramètres d’options.