ApiRelease interface
Interface que representa uma ApiRelease.
Métodos
| create |
Cria uma nova Versão para a API. |
| delete(string, string, string, string, string, Api |
Elimina a versão especificada na API. |
| get(string, string, string, string, Api |
Devolve os detalhes de uma versão da API. |
| get |
Devolve o etag de uma versão da API. |
| list |
Lista todas as versões de uma API. É criada uma versão da API ao tornar uma Revisão da API atual. As versões também são utilizadas para reverter para revisões anteriores. Os resultados serão paginados e podem ser restringidos pelos parâmetros $top e $skip. |
| update(string, string, string, string, string, Api |
Atualizações os detalhes da versão da API especificada pelo identificador. |
Detalhes de Método
createOrUpdate(string, string, string, string, ApiReleaseContract, ApiReleaseCreateOrUpdateOptionalParams)
Cria uma nova 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 não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- apiId
-
string
Identificador de API. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- releaseId
-
string
Identificador de versão numa API. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- parameters
- ApiReleaseContract
Criar parâmetros.
Os parâmetros de opções.
Devoluções
Promise<ApiReleaseCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiReleaseDeleteOptionalParams)
Elimina 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 não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- apiId
-
string
Identificador de API. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- releaseId
-
string
Identificador de versão numa API. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.
- options
- ApiReleaseDeleteOptionalParams
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, string, ApiReleaseGetOptionalParams)
Devolve 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 não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- apiId
-
string
Identificador de API. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- releaseId
-
string
Identificador de versão numa API. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- options
- ApiReleaseGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<ApiReleaseGetResponse>
getEntityTag(string, string, string, string, ApiReleaseGetEntityTagOptionalParams)
Devolve o 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 não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- apiId
-
string
Identificador de API. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- releaseId
-
string
Identificador de versão numa API. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
Os parâmetros de opções.
Devoluções
Promise<ApiReleaseGetEntityTagHeaders>
listByService(string, string, string, ApiReleaseListByServiceOptionalParams)
Lista todas as versões de uma API. É criada uma versão da API ao tornar uma Revisão da API atual. As versões também são utilizadas para reverter para revisões anteriores. Os resultados serão paginados e podem ser restringidos 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 não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- apiId
-
string
Identificador de API. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
Os parâmetros de opções.
Devoluções
update(string, string, string, string, string, ApiReleaseContract, ApiReleaseUpdateOptionalParams)
Atualizações os detalhes da versão da API especificada pelo 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 não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- apiId
-
string
Identificador de API. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- releaseId
-
string
Identificador de versão numa API. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.
- parameters
- ApiReleaseContract
Parâmetros da Atualização de Versão da API.
- options
- ApiReleaseUpdateOptionalParams
Os parâmetros de opções.
Devoluções
Promise<ApiReleaseUpdateResponse>