ApiOperation interface
Interface que representa uma ApiOperation.
Métodos
| create |
Cria uma nova operação na API ou atualiza uma existente. |
| delete(string, string, string, string, string, Api |
Elimina a operação especificada na API. |
| get(string, string, string, string, Api |
Obtém os detalhes da Operação de API especificada pelo respetivo identificador. |
| get |
Obtém a versão do estado da entidade (Etag) da operação de API especificada pelo respetivo 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 pelo respetivo identificador. |
Detalhes de Método
createOrUpdate(string, string, string, string, OperationContract, ApiOperationCreateOrUpdateOptionalParams)
Cria uma nova operação na API ou atualiza uma existente.
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 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 revisão da API. Tem de ser exclusivo na instância de serviço do Gestão 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 numa API. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- parameters
- OperationContract
Criar parâmetros.
Os parâmetros de opções.
Devoluções
Promise<ApiOperationCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)
Elimina 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 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 revisão da API. Tem de ser exclusivo na instância de serviço do Gestão 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 numa API. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- ifMatch
-
string
ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.
- options
- ApiOperationDeleteOptionalParams
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, string, ApiOperationGetOptionalParams)
Obtém os detalhes da Operação de API especificada pelo respetivo 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 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 revisão da API. Tem de ser exclusivo na instância de serviço do Gestão 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 numa API. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- options
- ApiOperationGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<ApiOperationGetResponse>
getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)
Obtém a versão do estado da entidade (Etag) da operação de API especificada pelo respetivo 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 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 revisão da API. Tem de ser exclusivo na instância de serviço do Gestão 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 numa API. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
Os parâmetros de opções.
Devoluções
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 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 revisão da API. Tem de ser exclusivo na instância de serviço do Gestão 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.
Devoluções
update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)
Atualizações os detalhes da operação na API especificada pelo respetivo 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 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 revisão da API. Tem de ser exclusivo na instância de serviço do Gestão 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 numa API. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- ifMatch
-
string
ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.
- parameters
- OperationUpdateContract
Parâmetros da Atualização da Operação de API.
- options
- ApiOperationUpdateOptionalParams
Os parâmetros de opções.
Devoluções
Promise<ApiOperationUpdateResponse>