Condividi tramite

ApiRelease interface

  • Riferimento
Pacchetto:
@azure/arm-apimanagement

Interfaccia che rappresenta un'apiRelease.

Metodi

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

Crea una nuova versione per l'API.
delete(string, string, string, string, string, ApiReleaseDeleteOptionalParams)

Elimina la versione specificata nell'API.
get(string, string, string, string, ApiReleaseGetOptionalParams)

Restituisce i dettagli di una versione dell'API.
getEntityTag(string, string, string, string, ApiReleaseGetEntityTagOptionalParams)

Restituisce l'etag di una versione dell'API.
listByService(string, string, string, ApiReleaseListByServiceOptionalParams)

Elenca tutte le versioni di un'API. Quando si effettua una revisione API corrente, viene creata una versione API. Le versioni vengono usate anche per eseguire il rollback delle revisioni precedenti. I risultati verranno paginati e possono essere vincolati dai parametri $top e $skip.
update(string, string, string, string, string, ApiReleaseContract, ApiReleaseUpdateOptionalParams)

Aggiornamenti i dettagli della versione dell'API specificata dall'identificatore.

Dettagli metodo

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

Crea una nuova versione per l'API.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

apiId

string

Identificatore API. Deve essere univoco nell'istanza corrente del servizio Gestione API.

releaseId

string

Identificatore di versione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio Gestione API.

parameters
ApiReleaseContract

Creare parametri.

options
ApiReleaseCreateOrUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiReleaseCreateOrUpdateResponse>

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

Elimina la versione specificata nell'API.

function delete(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, options?: ApiReleaseDeleteOptionalParams): Promise<void>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

apiId

string

Identificatore API. Deve essere univoco nell'istanza corrente del servizio Gestione API.

releaseId

string

Identificatore di versione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio Gestione API.

ifMatch

string

ETag dell'entità. ETag deve corrispondere allo stato dell'entità corrente dalla risposta di intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.

options
ApiReleaseDeleteOptionalParams

Parametri delle opzioni.

Restituisce

Promise<void>

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

Restituisce i dettagli di una versione dell'API.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

apiId

string

Identificatore API. Deve essere univoco nell'istanza corrente del servizio Gestione API.

releaseId

string

Identificatore di versione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio Gestione API.

options
ApiReleaseGetOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiReleaseGetResponse>

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

Restituisce l'etag di una versione dell'API.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

apiId

string

Identificatore API. Deve essere univoco nell'istanza corrente del servizio Gestione API.

releaseId

string

Identificatore di versione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio Gestione API.

options
ApiReleaseGetEntityTagOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiReleaseGetEntityTagHeaders>

listByService(string, string, string, ApiReleaseListByServiceOptionalParams)

Elenca tutte le versioni di un'API. Quando si effettua una revisione API corrente, viene creata una versione API. Le versioni vengono usate anche per eseguire il rollback delle revisioni precedenti. I risultati verranno paginati e possono essere vincolati dai parametri $top e $skip.

function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiReleaseListByServiceOptionalParams): PagedAsyncIterableIterator<ApiReleaseContract, ApiReleaseContract[], PageSettings>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

apiId

string

Identificatore API. Deve essere univoco nell'istanza corrente del servizio Gestione API.

options
ApiReleaseListByServiceOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<ApiReleaseContract, ApiReleaseContract[], PageSettings>

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

Aggiornamenti i dettagli della versione dell'API specificata dall'identificatore.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

apiId

string

Identificatore API. Deve essere univoco nell'istanza corrente del servizio Gestione API.

releaseId

string

Identificatore di versione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio Gestione API.

ifMatch

string

ETag dell'entità. ETag deve corrispondere allo stato dell'entità corrente dalla risposta di intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.

parameters
ApiReleaseContract

Parametri di aggiornamento versione API.

options
ApiReleaseUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiReleaseUpdateResponse>