ApiDiagnostic interface
Interface que representa um ApiDiagnostic.
Métodos
| create |
Cria um novo Diagnóstico para uma API ou atualiza uma existente. |
| delete(string, string, string, string, string, Api |
Exclui o diagnóstico especificado de uma API. |
| get(string, string, string, string, Api |
Obtém os detalhes do Diagnóstico para uma API especificada por seu identificador. |
| get |
Obtém a versão de estado da entidade (Etag) do Diagnóstico para uma API especificada por seu identificador. |
| list |
Lista todos os diagnósticos de uma API. |
| update(string, string, string, string, string, Diagnostic |
Atualiza os detalhes do Diagnóstico para uma API especificada por seu identificador. |
Detalhes do método
createOrUpdate(string, string, string, string, DiagnosticContract, ApiDiagnosticCreateOrUpdateOptionalParams)
Cria um novo Diagnóstico para uma API ou atualiza uma existente.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, parameters: DiagnosticContract, options?: ApiDiagnosticCreateOrUpdateOptionalParams): Promise<ApiDiagnosticCreateOrUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- apiId
-
string
Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
- diagnosticId
-
string
Identificador de diagnóstico. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
- parameters
- DiagnosticContract
Criar parâmetros.
Os parâmetros de opções.
Retornos
Promise<ApiDiagnosticCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiDiagnosticDeleteOptionalParams)
Exclui o diagnóstico especificado de uma API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, ifMatch: string, options?: ApiDiagnosticDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- apiId
-
string
Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
- diagnosticId
-
string
Identificador de diagnóstico. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
- 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.
Os parâmetros de opções.
Retornos
Promise<void>
get(string, string, string, string, ApiDiagnosticGetOptionalParams)
Obtém os detalhes do Diagnóstico para uma API especificada por seu identificador.
function get(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, options?: ApiDiagnosticGetOptionalParams): Promise<ApiDiagnosticGetResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- apiId
-
string
Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
- diagnosticId
-
string
Identificador de diagnóstico. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
- options
- ApiDiagnosticGetOptionalParams
Os parâmetros de opções.
Retornos
Promise<ApiDiagnosticGetResponse>
getEntityTag(string, string, string, string, ApiDiagnosticGetEntityTagOptionalParams)
Obtém a versão de estado da entidade (Etag) do Diagnóstico para uma API especificada por seu identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, options?: ApiDiagnosticGetEntityTagOptionalParams): Promise<ApiDiagnosticGetEntityTagHeaders>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- apiId
-
string
Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
- diagnosticId
-
string
Identificador de diagnóstico. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
Os parâmetros de opções.
Retornos
Promise<ApiDiagnosticGetEntityTagHeaders>
listByService(string, string, string, ApiDiagnosticListByServiceOptionalParams)
Lista todos os diagnósticos de uma API.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiDiagnosticListByServiceOptionalParams): PagedAsyncIterableIterator<DiagnosticContract, DiagnosticContract[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- apiId
-
string
Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
Os parâmetros de opções.
Retornos
update(string, string, string, string, string, DiagnosticContract, ApiDiagnosticUpdateOptionalParams)
Atualiza os detalhes do Diagnóstico para uma API especificada por seu identificador.
function update(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, ifMatch: string, parameters: DiagnosticContract, options?: ApiDiagnosticUpdateOptionalParams): Promise<ApiDiagnosticUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- apiId
-
string
Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
- diagnosticId
-
string
Identificador de diagnóstico. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
- 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
- DiagnosticContract
Parâmetros de Atualização de Diagnóstico.
Os parâmetros de opções.
Retornos
Promise<ApiDiagnosticUpdateResponse>