ApiDiagnostic interface
Interface representing a ApiDiagnostic.
Methods
| create |
Creates a new Diagnostic for an API or updates an existing one. |
| delete(string, string, string, string, string, Api |
Deletes the specified Diagnostic from an API. |
| get(string, string, string, string, Api |
Gets the details of the Diagnostic for an API specified by its identifier. |
| get |
Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier. |
| list |
Lists all diagnostics of an API. |
| update(string, string, string, string, string, Diagnostic |
Updates the details of the Diagnostic for an API specified by its identifier. |
Method Details
createOrUpdate(string, string, string, string, DiagnosticContract, ApiDiagnosticCreateOrUpdateOptionalParams)
Creates a new Diagnostic for an API or updates an existing one.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, parameters: DiagnosticContract, options?: ApiDiagnosticCreateOrUpdateOptionalParams): Promise<ApiDiagnosticCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
The options parameters.
Returns
Promise<ApiDiagnosticCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiDiagnosticDeleteOptionalParams)
Deletes the specified Diagnostic from an API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, ifMatch: string, options?: ApiDiagnosticDeleteOptionalParams): 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.
- 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.
The options parameters.
Returns
Promise<void>
get(string, string, string, string, ApiDiagnosticGetOptionalParams)
Gets the details of the Diagnostic for an API specified by its identifier.
function get(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, options?: ApiDiagnosticGetOptionalParams): Promise<ApiDiagnosticGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
- options
- ApiDiagnosticGetOptionalParams
The options parameters.
Returns
Promise<ApiDiagnosticGetResponse>
getEntityTag(string, string, string, string, ApiDiagnosticGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, options?: ApiDiagnosticGetEntityTagOptionalParams): Promise<ApiDiagnosticGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
The options parameters.
Returns
Promise<ApiDiagnosticGetEntityTagHeaders>
listByService(string, string, string, ApiDiagnosticListByServiceOptionalParams)
Lists all diagnostics of an API.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiDiagnosticListByServiceOptionalParams): 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.
- apiId
-
string
API identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
update(string, string, string, string, string, DiagnosticContract, ApiDiagnosticUpdateOptionalParams)
Updates the details of the Diagnostic for an API specified by its identifier.
function update(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, ifMatch: string, parameters: DiagnosticContract, options?: ApiDiagnosticUpdateOptionalParams): Promise<ApiDiagnosticUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
The options parameters.
Returns
Promise<ApiDiagnosticUpdateResponse>