Diagnostics Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

public interface Diagnostics

Resource collection API of Diagnostics.

Method Summary

Modifier and Type	Method and Description
abstract DiagnosticContract	createOrUpdate(String resourceGroupName, String serviceName, String diagnosticId, DiagnosticContractInner parameters) Creates a new Diagnostic or updates an existing one.
abstract Response<DiagnosticContract>	createOrUpdateWithResponse(String resourceGroupName, String serviceName, String diagnosticId, DiagnosticContractInner parameters, String ifMatch, Context context) Creates a new Diagnostic or updates an existing one.
abstract void	delete(String resourceGroupName, String serviceName, String diagnosticId, String ifMatch) Deletes the specified Diagnostic.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String diagnosticId, String ifMatch, Context context) Deletes the specified Diagnostic.
abstract DiagnosticContract	get(String resourceGroupName, String serviceName, String diagnosticId) Gets the details of the Diagnostic specified by its identifier.
abstract void	getEntityTag(String resourceGroupName, String serviceName, String diagnosticId) Gets the entity state (Etag) version of the Diagnostic specified by its identifier.
abstract DiagnosticsGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String diagnosticId, Context context) Gets the entity state (Etag) version of the Diagnostic specified by its identifier.
abstract Response<DiagnosticContract>	getWithResponse(String resourceGroupName, String serviceName, String diagnosticId, Context context) Gets the details of the Diagnostic specified by its identifier.
abstract PagedIterable<DiagnosticContract>	listByService(String resourceGroupName, String serviceName) Lists all diagnostics of the API Management service instance.
abstract PagedIterable<DiagnosticContract>	listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Context context) Lists all diagnostics of the API Management service instance.
abstract DiagnosticContract	update(String resourceGroupName, String serviceName, String diagnosticId, String ifMatch, DiagnosticContractInner parameters) Updates the details of the Diagnostic specified by its identifier.
abstract Response<DiagnosticContract>	updateWithResponse(String resourceGroupName, String serviceName, String diagnosticId, String ifMatch, DiagnosticContractInner parameters, Context context) Updates the details of the Diagnostic specified by its identifier.

Method Details

createOrUpdate

public abstract DiagnosticContract createOrUpdate(String resourceGroupName, String serviceName, String diagnosticId, DiagnosticContractInner parameters)

Creates a new Diagnostic or updates an existing one.

Parameters:

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

serviceName - The name of the API Management service.

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

parameters - Create parameters.

Returns:

diagnostic details.

createOrUpdateWithResponse

public abstract Response createOrUpdateWithResponse(String resourceGroupName, String serviceName, String diagnosticId, DiagnosticContractInner parameters, String ifMatch, Context context)

Creates a new Diagnostic or updates an existing one.

Parameters:

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

serviceName - The name of the API Management service.

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

parameters - Create parameters.

ifMatch - ETag of the Entity. Not required when creating an entity, but required when updating an entity.

context - The context to associate with this operation.

Returns:

diagnostic details.

delete

public abstract void delete(String resourceGroupName, String serviceName, String diagnosticId, String ifMatch)

Deletes the specified Diagnostic.

Parameters:

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

serviceName - The name of the API Management service.

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

ifMatch - 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.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String serviceName, String diagnosticId, String ifMatch, Context context)

Deletes the specified Diagnostic.

Parameters:

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

serviceName - The name of the API Management service.

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

ifMatch - 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.

context - The context to associate with this operation.

Returns:

the Response<T>.

get

public abstract DiagnosticContract get(String resourceGroupName, String serviceName, String diagnosticId)

Gets the details of the Diagnostic specified by its identifier.

Parameters:

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

serviceName - The name of the API Management service.

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

Returns:

the details of the Diagnostic specified by its identifier.

getEntityTag

public abstract void getEntityTag(String resourceGroupName, String serviceName, String diagnosticId)

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

Parameters:

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

serviceName - The name of the API Management service.

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

getEntityTagWithResponse

public abstract DiagnosticsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String diagnosticId, Context context)

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

Parameters:

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

serviceName - The name of the API Management service.

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

context - The context to associate with this operation.

Returns:

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

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String serviceName, String diagnosticId, Context context)

Gets the details of the Diagnostic specified by its identifier.

Parameters:

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

serviceName - The name of the API Management service.

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

context - The context to associate with this operation.

Returns:

the details of the Diagnostic specified by its identifier.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName)

Lists all diagnostics of the API Management service instance.

Parameters:

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

serviceName - The name of the API Management service.

Returns:

paged Diagnostic list representation as paginated response with PagedIterable<T>.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Context context)

Lists all diagnostics of the API Management service instance.

Parameters:

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

serviceName - The name of the API Management service.

filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>.

top - Number of records to return.

skip - Number of records to skip.

context - The context to associate with this operation.

Returns:

paged Diagnostic list representation as paginated response with PagedIterable<T>.

update

public abstract DiagnosticContract update(String resourceGroupName, String serviceName, String diagnosticId, String ifMatch, DiagnosticContractInner parameters)

Updates the details of the Diagnostic specified by its identifier.

Parameters:

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

serviceName - The name of the API Management service.

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

ifMatch - 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 - Diagnostic Update parameters.

Returns:

diagnostic details.

updateWithResponse

public abstract Response updateWithResponse(String resourceGroupName, String serviceName, String diagnosticId, String ifMatch, DiagnosticContractInner parameters, Context context)

Updates the details of the Diagnostic specified by its identifier.

Parameters:

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

serviceName - The name of the API Management service.

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

ifMatch - 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 - Diagnostic Update parameters.

context - The context to associate with this operation.

Returns:

diagnostic details.