ApiOperation interface
Interface que representa uma ApiOperation.
Métodos
| create |
Cria ou atualiza uma operação na API. |
| delete(string, string, string, string, string, Api |
Exclui a operação especificada na API. |
| get(string, string, string, string, Api |
Obtém os detalhes da Operação de API especificada por seu identificador. |
| get |
Obtém a versão Etag (estado de entidade) da operação de API especificada por seu identificador. |
| list |
Lista uma coleção das operações para a API especificada. |
| update(string, string, string, string, string, Operation |
Atualizações os detalhes da operação na API especificada por seu identificador. |
Detalhes do método
createOrUpdate(string, string, string, string, OperationContract, ApiOperationCreateOrUpdateOptionalParams)
Cria ou atualiza uma operação na API.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, parameters: OperationContract, options?: ApiOperationCreateOrUpdateOptionalParams): Promise<ApiOperationCreateOrUpdateResponse>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 de revisão de API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- operationId
-
string
Identificador de operação em uma API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- parameters
- OperationContract
Criar parâmetros.
Os parâmetros de opções.
Retornos
Promise<ApiOperationCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)
Exclui a operação especificada na API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, ifMatch: string, options?: ApiOperationDeleteOptionalParams): 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 de revisão de API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- operationId
-
string
Identificador de operaçã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
- ApiOperationDeleteOptionalParams
Os parâmetros de opções.
Retornos
Promise<void>
get(string, string, string, string, ApiOperationGetOptionalParams)
Obtém os detalhes da Operação de API especificada por seu identificador.
function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetOptionalParams): Promise<ApiOperationGetResponse>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 de revisão de API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- operationId
-
string
Identificador de operação em uma API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- options
- ApiOperationGetOptionalParams
Os parâmetros de opções.
Retornos
Promise<ApiOperationGetResponse>
getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)
Obtém a versão Etag (estado de entidade) da operação de API especificada por seu identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetEntityTagOptionalParams): Promise<ApiOperationGetEntityTagHeaders>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 de revisão de API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- operationId
-
string
Identificador de operaçã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<ApiOperationGetEntityTagHeaders>
listByApi(string, string, string, ApiOperationListByApiOptionalParams)
Lista uma coleção das operações para a API especificada.
function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiOperationListByApiOptionalParams): PagedAsyncIterableIterator<OperationContract, OperationContract[], 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 de revisão de API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
Os parâmetros de opções.
Retornos
update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)
Atualizações os detalhes da operação na API especificada por seu identificador.
function update(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, ifMatch: string, parameters: OperationUpdateContract, options?: ApiOperationUpdateOptionalParams): Promise<ApiOperationUpdateResponse>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 de revisão de API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- operationId
-
string
Identificador de operaçã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
- OperationUpdateContract
Parâmetros de Atualização de Operação da API.
- options
- ApiOperationUpdateOptionalParams
Os parâmetros de opções.
Retornos
Promise<ApiOperationUpdateResponse>