DiagnosticImpl | @azure/arm-apimanagement

Class containing Diagnostic operations.

Hierarchy

DiagnosticImpl

Implements

Diagnostic

Index

Constructors

constructor

Methods

Constructors

constructor

new DiagnosticImpl(client: ApiManagementClientContext): DiagnosticImpl

- Defined in operations/diagnostic.ts:35
Initialize a new instance of the class Diagnostic class.

Parameters
- client: ApiManagementClientContext
  
  Reference to the service client
Returns DiagnosticImpl

Methods

createOrUpdate

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

Implementation of Diagnostic.createOrUpdate
- Defined in operations/diagnostic.ts:182
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>

Implementation of Diagnostic.delete
- Defined in operations/diagnostic.ts:237
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>

Implementation of Diagnostic.get
- Defined in operations/diagnostic.ts:161
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>

Implementation of Diagnostic.getEntityTag
- Defined in operations/diagnostic.ts:141
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>

Implementation of Diagnostic.listByService
- Defined in operations/diagnostic.ts:51
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>

Implementation of Diagnostic.update
- Defined in operations/diagnostic.ts:206
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

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns DiagnosticImpl

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>