ApiDiagnostic | @azure/arm-apimanagement

Interface representing a ApiDiagnostic.

Hierarchy

ApiDiagnostic

Implemented by

ApiDiagnosticImpl

Index

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, parameters: DiagnosticContract, options?: ApiDiagnosticCreateOrUpdateOptionalParams): Promise<ApiDiagnosticCreateOrUpdateResponse>

- Defined in operationsInterfaces/apiDiagnostic.ts:82
Creates a new Diagnostic for an API or updates an existing one.

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

delete

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

- Defined in operationsInterfaces/apiDiagnostic.ts:122
Deletes the specified Diagnostic from an API.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- apiId: string
  
  API identifier. Must be unique in the current API Management service instance.
- 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: ApiDiagnosticDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, options?: ApiDiagnosticGetOptionalParams): Promise<ApiDiagnosticGetResponse>

- Defined in operationsInterfaces/apiDiagnostic.ts:65
Gets the details of the Diagnostic for an API specified by its identifier.

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

getEntityTag

getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, options?: ApiDiagnosticGetEntityTagOptionalParams): Promise<ApiDiagnosticGetEntityTagResponse>

- Defined in operationsInterfaces/apiDiagnostic.ts:49
Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.

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

listByService

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

- Defined in operationsInterfaces/apiDiagnostic.ts:34
Lists all diagnostics of an API.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- apiId: string
  
  API identifier. Must be unique in the current API Management service instance.
- Optional options: ApiDiagnosticListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<DiagnosticContract>

update

update(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, ifMatch: string, parameters: DiagnosticContract, options?: ApiDiagnosticUpdateOptionalParams): Promise<ApiDiagnosticUpdateResponse>

- Defined in operationsInterfaces/apiDiagnostic.ts:102
Updates the details of the Diagnostic for an API specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- apiId: string
  
  API identifier. Must be unique in the current API Management service instance.
- 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: ApiDiagnosticUpdateOptionalParams
  
  The options parameters.
Returns Promise<ApiDiagnosticUpdateResponse>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

apiId: string

diagnosticId: string

parameters: DiagnosticContract

Optional options: ApiDiagnosticCreateOrUpdateOptionalParams

Returns Promise<ApiDiagnosticCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

apiId: string

diagnosticId: string

ifMatch: string

Optional options: ApiDiagnosticDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

apiId: string

diagnosticId: string

Optional options: ApiDiagnosticGetOptionalParams

Returns Promise<ApiDiagnosticGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

apiId: string

diagnosticId: string

Optional options: ApiDiagnosticGetEntityTagOptionalParams

Returns Promise<ApiDiagnosticGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

apiId: string

Optional options: ApiDiagnosticListByServiceOptionalParams

Returns PagedAsyncIterableIterator<DiagnosticContract>

update

Parameters

resourceGroupName: string

serviceName: string

apiId: string

diagnosticId: string

ifMatch: string

parameters: DiagnosticContract

Optional options: ApiDiagnosticUpdateOptionalParams

Returns Promise<ApiDiagnosticUpdateResponse>