Partager via

ApiRelease interface

  • Référence
Paquet:
@azure/arm-apimanagement

Interface représentant une ApiRelease.

Méthodes

createOrUpdate(string, string, string, string, ApiReleaseContract, ApiReleaseCreateOrUpdateOptionalParams)

Crée une nouvelle version de l’API.
delete(string, string, string, string, string, ApiReleaseDeleteOptionalParams)

Supprime la version spécifiée dans l’API.
get(string, string, string, string, ApiReleaseGetOptionalParams)

Retourne les détails d’une version d’API.
getEntityTag(string, string, string, string, ApiReleaseGetEntityTagOptionalParams)

Retourne l’etag d’une version d’API.
listByService(string, string, string, ApiReleaseListByServiceOptionalParams)

Répertorie toutes les versions d’une API. Une version d’API est créée lorsqu’une révision d’API est rendue actuelle. Les versions sont également utilisées pour restaurer une révision précédente. Les résultats sont paginés et peuvent être contraints par les paramètres $top et $skip.
update(string, string, string, string, string, ApiReleaseContract, ApiReleaseUpdateOptionalParams)

Mises à jour les détails de la version de l’API spécifiée par son identificateur.

Détails de la méthode

createOrUpdate(string, string, string, string, ApiReleaseContract, ApiReleaseCreateOrUpdateOptionalParams)

Crée une nouvelle version de l’API.

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, parameters: ApiReleaseContract, options?: ApiReleaseCreateOrUpdateOptionalParams): Promise<ApiReleaseCreateOrUpdateResponse>

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

apiId

string

Identificateur d'API. Doit être unique dans le instance de service Gestion des API actuel.

releaseId

string

Identificateur de mise en production au sein d’une API. Doit être unique dans le instance de service Gestion des API actuel.

parameters
ApiReleaseContract

Créez des paramètres.

options
ApiReleaseCreateOrUpdateOptionalParams

Paramètres d’options.

Retours

Promise<ApiReleaseCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiReleaseDeleteOptionalParams)

Supprime la version spécifiée dans l’API.

function delete(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, options?: ApiReleaseDeleteOptionalParams): 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.

apiId

string

Identificateur d'API. Doit être unique dans le instance de service Gestion des API actuel.

releaseId

string

Identificateur de mise en production au sein d’une API. Doit être unique dans le instance de service Gestion des API actuel.

ifMatch

string

ETag de l’entité. ETag doit correspondre à l’état d’entité actuel de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.

options
ApiReleaseDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

get(string, string, string, string, ApiReleaseGetOptionalParams)

Retourne les détails d’une version d’API.

function get(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetOptionalParams): Promise<ApiReleaseGetResponse>

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

apiId

string

Identificateur d'API. Doit être unique dans le instance de service Gestion des API actuel.

releaseId

string

Identificateur de mise en production au sein d’une API. Doit être unique dans le instance de service Gestion des API actuel.

options
ApiReleaseGetOptionalParams

Paramètres d’options.

Retours

Promise<ApiReleaseGetResponse>

getEntityTag(string, string, string, string, ApiReleaseGetEntityTagOptionalParams)

Retourne l’etag d’une version d’API.

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetEntityTagOptionalParams): Promise<ApiReleaseGetEntityTagHeaders>

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

apiId

string

Identificateur d'API. Doit être unique dans le instance de service Gestion des API actuel.

releaseId

string

Identificateur de mise en production au sein d’une API. Doit être unique dans le instance de service Gestion des API actuel.

options
ApiReleaseGetEntityTagOptionalParams

Paramètres d’options.

Retours

Promise<ApiReleaseGetEntityTagHeaders>

listByService(string, string, string, ApiReleaseListByServiceOptionalParams)

Répertorie toutes les versions d’une API. Une version d’API est créée lorsqu’une révision d’API est rendue actuelle. Les versions sont également utilisées pour restaurer une révision précédente. Les résultats sont paginés et peuvent être contraints par les paramètres $top et $skip.

function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiReleaseListByServiceOptionalParams): PagedAsyncIterableIterator<ApiReleaseContract, ApiReleaseContract[], 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.

apiId

string

Identificateur d'API. Doit être unique dans le instance de service Gestion des API actuel.

options
ApiReleaseListByServiceOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<ApiReleaseContract, ApiReleaseContract[], PageSettings>

update(string, string, string, string, string, ApiReleaseContract, ApiReleaseUpdateOptionalParams)

Mises à jour les détails de la version de l’API spécifiée par son identificateur.

function update(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, parameters: ApiReleaseContract, options?: ApiReleaseUpdateOptionalParams): Promise<ApiReleaseUpdateResponse>

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

apiId

string

Identificateur d'API. Doit être unique dans le instance de service Gestion des API actuel.

releaseId

string

Identificateur de mise en production au sein d’une API. Doit être unique dans le instance de service Gestion des API actuel.

ifMatch

string

ETag de l’entité. ETag doit correspondre à l’état d’entité actuel de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.

parameters
ApiReleaseContract

Paramètres de mise à jour de mise en production de l’API.

options
ApiReleaseUpdateOptionalParams

Paramètres d’options.

Retours

Promise<ApiReleaseUpdateResponse>