ApiDiagnostic interface
Interface que representa um ApiDiagnostic.
Métodos
create |
Cria um novo Diagnóstico para uma API ou atualiza um existente. |
delete(string, string, string, string, string, Api |
Elimina o Diagnóstico especificado de uma API. |
get(string, string, string, string, Api |
Obtém os detalhes do Diagnóstico de uma API especificada pelo identificador. |
get |
Obtém a versão de estado da entidade (Etag) do Diagnóstico de uma API especificada pelo identificador. |
list |
Lista todos os diagnósticos de uma API. |
update(string, string, string, string, string, Diagnostic |
Atualizações os detalhes do Diagnóstico de uma API especificada pelo identificador. |
Detalhes de Método
createOrUpdate(string, string, string, string, DiagnosticContract, ApiDiagnosticCreateOrUpdateOptionalParams)
Cria um novo Diagnóstico para uma API ou atualiza um 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 é 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.
- diagnosticId
-
string
Identificador de diagnóstico. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- parameters
- DiagnosticContract
Criar parâmetros.
Os parâmetros de opções.
Devoluções
Promise<ApiDiagnosticCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiDiagnosticDeleteOptionalParams)
Elimina 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 é 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.
- diagnosticId
-
string
Identificador de diagnóstico. 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.
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, string, ApiDiagnosticGetOptionalParams)
Obtém os detalhes do Diagnóstico de uma API especificada pelo 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 é 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.
- diagnosticId
-
string
Identificador de diagnóstico. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- options
- ApiDiagnosticGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<ApiDiagnosticGetResponse>
getEntityTag(string, string, string, string, ApiDiagnosticGetEntityTagOptionalParams)
Obtém a versão de estado da entidade (Etag) do Diagnóstico de uma API especificada pelo 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 é 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.
- diagnosticId
-
string
Identificador de diagnóstico. 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<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 é 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, DiagnosticContract, ApiDiagnosticUpdateOptionalParams)
Atualizações os detalhes do Diagnóstico de uma API especificada pelo 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 é 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.
- diagnosticId
-
string
Identificador de diagnóstico. 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
- DiagnosticContract
Parâmetros de Atualização de Diagnóstico.
Os parâmetros de opções.
Devoluções
Promise<ApiDiagnosticUpdateResponse>