ApiRelease interface

Paquete:

@azure/arm-apimanagement

Interfaz que representa una ApiRelease.

Métodos

createOrUpdate(string, string, string, string, ApiReleaseContract, ApiReleaseCreateOrUpdateOptionalParams)	Crea una nueva versión para la API.
delete(string, string, string, string, string, ApiReleaseDeleteOptionalParams)	Elimina la versión especificada en la API.
get(string, string, string, string, ApiReleaseGetOptionalParams)	Devuelve los detalles de una versión de API.
getEntityTag(string, string, string, string, ApiReleaseGetEntityTagOptionalParams)	Devuelve la etiqueta etag de una versión de API.
listByService(string, string, string, ApiReleaseListByServiceOptionalParams)	Enumera todas las versiones de una API. Se crea una versión de API al crear una revisión de API actual. Las versiones también se usan para revertir a las revisiones anteriores. Los resultados se paginarán y los parámetros $top y $skip pueden restringirlos.
update(string, string, string, string, string, ApiReleaseContract, ApiReleaseUpdateOptionalParams)	Actualiza los detalles de la versión de la API especificada por su identificador.

Detalles del método

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

Crea una nueva versión para la API.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de API. Debe ser único en la instancia actual del servicio API Management.

releaseId

string

Identificador de versión dentro de una API. Debe ser único en la instancia actual del servicio API Management.

parameters

ApiReleaseContract

Cree parámetros.

options

ApiReleaseCreateOrUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiReleaseCreateOrUpdateResponse>

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

Elimina la versión especificada en la API.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de API. Debe ser único en la instancia actual del servicio API Management.

releaseId

string

Identificador de versión dentro de una API. Debe ser único en la instancia actual del servicio API Management.

ifMatch

string

ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta del encabezado de la solicitud GET o debe ser * para la actualización incondicional.

options

ApiReleaseDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

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

Devuelve los detalles de una versión de API.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de API. Debe ser único en la instancia actual del servicio API Management.

releaseId

string

Identificador de versión dentro de una API. Debe ser único en la instancia actual del servicio API Management.

options

ApiReleaseGetOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiReleaseGetResponse>

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

Devuelve la etiqueta etag de una versión de API.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de API. Debe ser único en la instancia actual del servicio API Management.

releaseId

string

Identificador de versión dentro de una API. Debe ser único en la instancia actual del servicio API Management.

options

ApiReleaseGetEntityTagOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiReleaseGetEntityTagHeaders>

listByService(string, string, string, ApiReleaseListByServiceOptionalParams)

Enumera todas las versiones de una API. Se crea una versión de API al crear una revisión de API actual. Las versiones también se usan para revertir a las revisiones anteriores. Los resultados se paginarán y los parámetros $top y $skip pueden restringirlos.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de API. Debe ser único en la instancia actual del servicio API Management.

options

ApiReleaseListByServiceOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<ApiReleaseContract, ApiReleaseContract[], PageSettings>

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

Actualiza los detalles de la versión de la API especificada por su identificador.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de API. Debe ser único en la instancia actual del servicio API Management.

releaseId

string

Identificador de versión dentro de una API. Debe ser único en la instancia actual del servicio API Management.

ifMatch

string

ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta del encabezado de la solicitud GET o debe ser * para la actualización incondicional.

parameters

ApiReleaseContract

Parámetros de actualización de la versión de API.

options

ApiReleaseUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiReleaseUpdateResponse>