Package com.azure.resourcemanager.apimanagement.fluent

Interface DiagnosticsClient

public interface DiagnosticsClient

An instance of this class provides access to all the operations defined in DiagnosticsClient.

Method Summary

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

Method Detail

listByService

com.azure.core.http.rest.PagedIterable<DiagnosticContractInner> listByService(String resourceGroupName,
                                                                              String serviceName)

Lists all diagnostics of the API Management service instance.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

Returns:

paged Diagnostic list representation as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByService

com.azure.core.http.rest.PagedIterable<DiagnosticContractInner> listByService(String resourceGroupName,
                                                                              String serviceName,
                                                                              String filter,
                                                                              Integer top,
                                                                              Integer skip,
                                                                              com.azure.core.util.Context context)

Lists all diagnostics of the API Management service instance.

Parameters:

resourceGroupName - The name of the resource group.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getEntityTag

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.

serviceName - The name of the API Management service.

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getEntityTagWithResponse

DiagnosticsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName,
                                                         String serviceName,
                                                         String diagnosticId,
                                                         com.azure.core.util.Context context)

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

Parameters:

resourceGroupName - The name of the resource group.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

get

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

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getWithResponse

DiagnosticsGetResponse getWithResponse(String resourceGroupName,
                                       String serviceName,
                                       String diagnosticId,
                                       com.azure.core.util.Context context)

Gets the details of the Diagnostic specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

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

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdateWithResponse

DiagnosticsCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName,
                                                             String serviceName,
                                                             String diagnosticId,
                                                             DiagnosticContractInner parameters,
                                                             String ifMatch,
                                                             com.azure.core.util.Context context)

Creates a new Diagnostic or updates an existing one.

Parameters:

resourceGroupName - The name of the resource group.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

update

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

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateWithResponse

DiagnosticsUpdateResponse updateWithResponse(String resourceGroupName,
                                             String serviceName,
                                             String diagnosticId,
                                             String ifMatch,
                                             DiagnosticContractInner parameters,
                                             com.azure.core.util.Context context)

Updates the details of the Diagnostic specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

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

Deletes the specified Diagnostic.

Parameters:

resourceGroupName - The name of the resource group.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteWithResponse

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String serviceName,
                                                           String diagnosticId,
                                                           String ifMatch,
                                                           com.azure.core.util.Context context)

Deletes the specified Diagnostic.

Parameters:

resourceGroupName - The name of the resource group.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.