Package com.azure.resourcemanager.apimanagement.models

Interface ApiDiagnostics

public interface ApiDiagnostics

Resource collection API of ApiDiagnostics.

Method Summary

Modifier and Type	Method	Description
DiagnosticContract.DefinitionStages.Blank	define(String name)	Begins definition for a new DiagnosticContract resource.
void	delete(String resourceGroupName, String serviceName, String apiId, String diagnosticId, String ifMatch)	Deletes the specified Diagnostic from an API.
void	deleteById(String id)	Deletes the specified Diagnostic from an API.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, String ifMatch, com.azure.core.util.Context context)	Deletes the specified Diagnostic from an API.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String apiId, String diagnosticId, String ifMatch, com.azure.core.util.Context context)	Deletes the specified Diagnostic from an API.
DiagnosticContract	get(String resourceGroupName, String serviceName, String apiId, String diagnosticId)	Gets the details of the Diagnostic for an API specified by its identifier.
DiagnosticContract	getById(String id)	Gets the details of the Diagnostic for an API specified by its identifier.
com.azure.core.http.rest.Response<DiagnosticContract>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets the details of the Diagnostic for an API specified by its identifier.
void	getEntityTag(String resourceGroupName, String serviceName, String apiId, String diagnosticId)	Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.
ApiDiagnosticsGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String diagnosticId, com.azure.core.util.Context context)	Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.
com.azure.core.http.rest.Response<DiagnosticContract>	getWithResponse(String resourceGroupName, String serviceName, String apiId, String diagnosticId, com.azure.core.util.Context context)	Gets the details of the Diagnostic for an API specified by its identifier.
com.azure.core.http.rest.PagedIterable<DiagnosticContract>	listByService(String resourceGroupName, String serviceName, String apiId)	Lists all diagnostics of an API.
com.azure.core.http.rest.PagedIterable<DiagnosticContract>	listByService(String resourceGroupName, String serviceName, String apiId, String filter, Integer top, Integer skip, com.azure.core.util.Context context)	Lists all diagnostics of an API.

Method Detail

listByService

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

Lists all diagnostics of an API.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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

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<DiagnosticContract> listByService(String resourceGroupName,
                                                                         String serviceName,
                                                                         String apiId,
                                                                         String filter,
                                                                         Integer top,
                                                                         Integer skip,
                                                                         com.azure.core.util.Context context)

Lists all diagnostics of an API.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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

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 apiId,
                  String diagnosticId)

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

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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

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

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

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

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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

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 for an API 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

DiagnosticContract get(String resourceGroupName,
                       String serviceName,
                       String apiId,
                       String diagnosticId)

Gets the details of the Diagnostic for an API specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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

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

Returns:

the details of the Diagnostic for an API 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

com.azure.core.http.rest.Response<DiagnosticContract> getWithResponse(String resourceGroupName,
                                                                      String serviceName,
                                                                      String apiId,
                                                                      String diagnosticId,
                                                                      com.azure.core.util.Context context)

Gets the details of the Diagnostic for an API specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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

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 for an API 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.

delete

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

Deletes the specified Diagnostic from an API.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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

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 apiId,
                                                           String diagnosticId,
                                                           String ifMatch,
                                                           com.azure.core.util.Context context)

Deletes the specified Diagnostic from an API.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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

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.

getById

DiagnosticContract getById(String id)

Gets the details of the Diagnostic for an API specified by its identifier.

Parameters:

id - the resource ID.

Returns:

the details of the Diagnostic for an API 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.

getByIdWithResponse

com.azure.core.http.rest.Response<DiagnosticContract> getByIdWithResponse(String id,
                                                                          com.azure.core.util.Context context)

Gets the details of the Diagnostic for an API specified by its identifier.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the details of the Diagnostic for an API 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.

deleteById

void deleteById(String id)

Deletes the specified Diagnostic from an API.

Parameters:

id - the resource ID.

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.

deleteByIdWithResponse

com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id,
                                                               String ifMatch,
                                                               com.azure.core.util.Context context)

Deletes the specified Diagnostic from an API.

Parameters:

id - the resource ID.

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.

define

DiagnosticContract.DefinitionStages.Blank define(String name)

Begins definition for a new DiagnosticContract resource.

Parameters:

name - resource name.

Returns:

the first stage of the new DiagnosticContract definition.