Diagnostic | @azure/arm-apimanagement

Interface representing a Diagnostic.

Hierarchy

Diagnostic

Implemented by

DiagnosticImpl

Index

Methods

createOrUpdate

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

- Defined in operationsInterfaces/diagnostic.ts:75
Creates a new Diagnostic or updates an existing one.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: DiagnosticCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<DiagnosticCreateOrUpdateResponse>

delete

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

- Defined in operationsInterfaces/diagnostic.ts:111
Deletes the specified Diagnostic.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: DiagnosticDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

- Defined in operationsInterfaces/diagnostic.ts:60
Gets the details of the Diagnostic specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- diagnosticId: string
  
  Diagnostic identifier. Must be unique in the current API Management service instance.
- Optional options: DiagnosticGetOptionalParams
  
  The options parameters.
Returns Promise<DiagnosticGetResponse>

getEntityTag

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

- Defined in operationsInterfaces/diagnostic.ts:46
Gets the entity state (Etag) version of the Diagnostic specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- diagnosticId: string
  
  Diagnostic identifier. Must be unique in the current API Management service instance.
- Optional options: DiagnosticGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<DiagnosticGetEntityTagResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, options?: DiagnosticListByServiceOptionalParams): PagedAsyncIterableIterator<DiagnosticContract>

- Defined in operationsInterfaces/diagnostic.ts:33
Lists all diagnostics of the API Management service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: DiagnosticListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<DiagnosticContract>

update

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

- Defined in operationsInterfaces/diagnostic.ts:93
Updates the details of the Diagnostic specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: DiagnosticUpdateOptionalParams
  
  The options parameters.
Returns Promise<DiagnosticUpdateResponse>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

diagnosticId: string

parameters: DiagnosticContract

Optional options: DiagnosticCreateOrUpdateOptionalParams

Returns Promise<DiagnosticCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

diagnosticId: string

ifMatch: string

Optional options: DiagnosticDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

diagnosticId: string

Optional options: DiagnosticGetOptionalParams

Returns Promise<DiagnosticGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

diagnosticId: string

Optional options: DiagnosticGetEntityTagOptionalParams

Returns Promise<DiagnosticGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

Optional options: DiagnosticListByServiceOptionalParams

Returns PagedAsyncIterableIterator<DiagnosticContract>

update

Parameters

resourceGroupName: string

serviceName: string

diagnosticId: string

ifMatch: string

parameters: DiagnosticContract

Optional options: DiagnosticUpdateOptionalParams

Returns Promise<DiagnosticUpdateResponse>