ApiRelease interface
Interface que representa uma ApiRelease.
Métodos
| create |
Cria uma versão para a API. |
| delete(string, string, string, string, string, Api |
Exclui a versão especificada na API. |
| get(string, string, string, string, Api |
Retorna os detalhes de uma versão da API. |
| get |
Retorna a etag de uma versão da API. |
| list |
Lista todas as versões de uma API. Uma versão de API é criada ao tornar uma Revisão da API atual. As versões também são usadas para reverter para revisões anteriores. Os resultados serão paginados e poderão ser restritos pelos parâmetros $top e $skip. |
| update(string, string, string, string, string, Api |
Atualizações os detalhes da versão da API especificada por seu identificador. |
Detalhes do método
createOrUpdate(string, string, string, string, ApiReleaseContract, ApiReleaseCreateOrUpdateOptionalParams)
Cria uma versão para a API.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, parameters: ApiReleaseContract, options?: ApiReleaseCreateOrUpdateOptionalParams): Promise<ApiReleaseCreateOrUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- apiId
-
string
Identificador da API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- releaseId
-
string
Identificador de versão em uma API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- parameters
- ApiReleaseContract
Criar parâmetros.
Os parâmetros de opções.
Retornos
Promise<ApiReleaseCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiReleaseDeleteOptionalParams)
Exclui a versão especificada na API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, options?: ApiReleaseDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- apiId
-
string
Identificador da API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- releaseId
-
string
Identificador de versão em uma API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- ifMatch
-
string
ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
- options
- ApiReleaseDeleteOptionalParams
Os parâmetros de opções.
Retornos
Promise<void>
get(string, string, string, string, ApiReleaseGetOptionalParams)
Retorna os detalhes de uma versão da API.
function get(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetOptionalParams): Promise<ApiReleaseGetResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- apiId
-
string
Identificador da API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- releaseId
-
string
Identificador de versão em uma API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- options
- ApiReleaseGetOptionalParams
Os parâmetros de opções.
Retornos
Promise<ApiReleaseGetResponse>
getEntityTag(string, string, string, string, ApiReleaseGetEntityTagOptionalParams)
Retorna a etag de uma versão da API.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetEntityTagOptionalParams): Promise<ApiReleaseGetEntityTagHeaders>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- apiId
-
string
Identificador da API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- releaseId
-
string
Identificador de versão em uma API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
Os parâmetros de opções.
Retornos
Promise<ApiReleaseGetEntityTagHeaders>
listByService(string, string, string, ApiReleaseListByServiceOptionalParams)
Lista todas as versões de uma API. Uma versão de API é criada ao tornar uma Revisão da API atual. As versões também são usadas para reverter para revisões anteriores. Os resultados serão paginados e poderão ser restritos pelos parâmetros $top e $skip.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiReleaseListByServiceOptionalParams): PagedAsyncIterableIterator<ApiReleaseContract, ApiReleaseContract[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- apiId
-
string
Identificador da API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
Os parâmetros de opções.
Retornos
update(string, string, string, string, string, ApiReleaseContract, ApiReleaseUpdateOptionalParams)
Atualizações os detalhes da versão da API especificada por seu identificador.
function update(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, parameters: ApiReleaseContract, options?: ApiReleaseUpdateOptionalParams): Promise<ApiReleaseUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- apiId
-
string
Identificador da API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- releaseId
-
string
Identificador de versão em uma API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- ifMatch
-
string
ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
- parameters
- ApiReleaseContract
Parâmetros de Atualização de Versão da API.
- options
- ApiReleaseUpdateOptionalParams
Os parâmetros de opções.
Retornos
Promise<ApiReleaseUpdateResponse>