Share via

Diagnostic interface

  • Reference
Package:
@azure/arm-apimanagement

Interface representing a Diagnostic.

Methods

createOrUpdate(string, string, string, DiagnosticContract, DiagnosticCreateOrUpdateOptionalParams)

Creates a new Diagnostic or updates an existing one.
delete(string, string, string, string, DiagnosticDeleteOptionalParams)

Deletes the specified Diagnostic.
get(string, string, string, DiagnosticGetOptionalParams)

Gets the details of the Diagnostic specified by its identifier.
getEntityTag(string, string, string, DiagnosticGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the Diagnostic specified by its identifier.
listByService(string, string, DiagnosticListByServiceOptionalParams)

Lists all diagnostics of the API Management service instance.
update(string, string, string, string, DiagnosticContract, DiagnosticUpdateOptionalParams)

Updates the details of the Diagnostic specified by its identifier.

Method Details

createOrUpdate(string, string, string, DiagnosticContract, DiagnosticCreateOrUpdateOptionalParams)

Creates a new Diagnostic or updates an existing one.

function createOrUpdate(resourceGroupName: string, serviceName: string, diagnosticId: string, parameters: DiagnosticContract, options?: DiagnosticCreateOrUpdateOptionalParams): Promise<DiagnosticCreateOrUpdateResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

diagnosticId

string

Diagnostic identifier. Must be unique in the current API Management service instance.

parameters
DiagnosticContract

Create parameters.

options
DiagnosticCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<DiagnosticCreateOrUpdateResponse>

delete(string, string, string, string, DiagnosticDeleteOptionalParams)

Deletes the specified Diagnostic.

function delete(resourceGroupName: string, serviceName: string, diagnosticId: string, ifMatch: string, options?: DiagnosticDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

diagnosticId

string

Diagnostic identifier. Must be unique in the current API Management service instance.

ifMatch

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

options
DiagnosticDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, DiagnosticGetOptionalParams)

Gets the details of the Diagnostic specified by its identifier.

function get(resourceGroupName: string, serviceName: string, diagnosticId: string, options?: DiagnosticGetOptionalParams): Promise<DiagnosticGetResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

diagnosticId

string

Diagnostic identifier. Must be unique in the current API Management service instance.

options
DiagnosticGetOptionalParams

The options parameters.

Returns

Promise<DiagnosticGetResponse>

getEntityTag(string, string, string, DiagnosticGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the Diagnostic specified by its identifier.

function getEntityTag(resourceGroupName: string, serviceName: string, diagnosticId: string, options?: DiagnosticGetEntityTagOptionalParams): Promise<DiagnosticGetEntityTagHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

diagnosticId

string

Diagnostic identifier. Must be unique in the current API Management service instance.

options
DiagnosticGetEntityTagOptionalParams

The options parameters.

Returns

Promise<DiagnosticGetEntityTagHeaders>

listByService(string, string, DiagnosticListByServiceOptionalParams)

Lists all diagnostics of the API Management service instance.

function listByService(resourceGroupName: string, serviceName: string, options?: DiagnosticListByServiceOptionalParams): PagedAsyncIterableIterator<DiagnosticContract, DiagnosticContract[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

options
DiagnosticListByServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DiagnosticContract, DiagnosticContract[], PageSettings>

update(string, string, string, string, DiagnosticContract, DiagnosticUpdateOptionalParams)

Updates the details of the Diagnostic specified by its identifier.

function update(resourceGroupName: string, serviceName: string, diagnosticId: string, ifMatch: string, parameters: DiagnosticContract, options?: DiagnosticUpdateOptionalParams): Promise<DiagnosticUpdateResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

diagnosticId

string

Diagnostic identifier. Must be unique in the current API Management service instance.

ifMatch

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

parameters
DiagnosticContract

Diagnostic Update parameters.

options
DiagnosticUpdateOptionalParams

The options parameters.

Returns

Promise<DiagnosticUpdateResponse>