Package com.azure.resourcemanager.apimanagement.fluent

Interface LoggersClient

public interface LoggersClient

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

Method Summary

Modifier and Type	Method	Description
LoggerContractInner	createOrUpdate(String resourceGroupName, String serviceName, String loggerId, LoggerContractInner parameters)	Creates or Updates a logger.
LoggersCreateOrUpdateResponse	createOrUpdateWithResponse(String resourceGroupName, String serviceName, String loggerId, LoggerContractInner parameters, String ifMatch, com.azure.core.util.Context context)	Creates or Updates a logger.
void	delete(String resourceGroupName, String serviceName, String loggerId, String ifMatch)	Deletes the specified logger.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String loggerId, String ifMatch, com.azure.core.util.Context context)	Deletes the specified logger.
LoggerContractInner	get(String resourceGroupName, String serviceName, String loggerId)	Gets the details of the logger specified by its identifier.
void	getEntityTag(String resourceGroupName, String serviceName, String loggerId)	Gets the entity state (Etag) version of the logger specified by its identifier.
LoggersGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String loggerId, com.azure.core.util.Context context)	Gets the entity state (Etag) version of the logger specified by its identifier.
LoggersGetResponse	getWithResponse(String resourceGroupName, String serviceName, String loggerId, com.azure.core.util.Context context)	Gets the details of the logger specified by its identifier.
com.azure.core.http.rest.PagedIterable<LoggerContractInner>	listByService(String resourceGroupName, String serviceName)	Lists a collection of loggers in the specified service instance.
com.azure.core.http.rest.PagedIterable<LoggerContractInner>	listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, com.azure.core.util.Context context)	Lists a collection of loggers in the specified service instance.
LoggerContractInner	update(String resourceGroupName, String serviceName, String loggerId, String ifMatch, LoggerUpdateContract parameters)	Updates an existing logger.
LoggersUpdateResponse	updateWithResponse(String resourceGroupName, String serviceName, String loggerId, String ifMatch, LoggerUpdateContract parameters, com.azure.core.util.Context context)	Updates an existing logger.

Method Detail

listByService

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

Lists a collection of loggers in the specified service instance.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

Returns:

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

Lists a collection of loggers in the specified 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>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| loggerType | filter | eq | |</br>| resourceId | 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 Logger 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 loggerId)

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

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

loggerId - Logger identifier. Must be unique in the 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

LoggersGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName,
                                                     String serviceName,
                                                     String loggerId,
                                                     com.azure.core.util.Context context)

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

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

loggerId - Logger identifier. Must be unique in the API Management service instance.

context - The context to associate with this operation.

Returns:

the entity state (Etag) version of the logger 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

LoggerContractInner get(String resourceGroupName,
                        String serviceName,
                        String loggerId)

Gets the details of the logger specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

loggerId - Logger identifier. Must be unique in the API Management service instance.

Returns:

the details of the logger 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

LoggersGetResponse getWithResponse(String resourceGroupName,
                                   String serviceName,
                                   String loggerId,
                                   com.azure.core.util.Context context)

Gets the details of the logger specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

loggerId - Logger identifier. Must be unique in the API Management service instance.

context - The context to associate with this operation.

Returns:

the details of the logger 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

LoggerContractInner createOrUpdate(String resourceGroupName,
                                   String serviceName,
                                   String loggerId,
                                   LoggerContractInner parameters)

Creates or Updates a logger.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

loggerId - Logger identifier. Must be unique in the API Management service instance.

parameters - Create parameters.

Returns:

logger 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

LoggersCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName,
                                                         String serviceName,
                                                         String loggerId,
                                                         LoggerContractInner parameters,
                                                         String ifMatch,
                                                         com.azure.core.util.Context context)

Creates or Updates a logger.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

loggerId - Logger identifier. Must be unique in the 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:

logger 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

LoggerContractInner update(String resourceGroupName,
                           String serviceName,
                           String loggerId,
                           String ifMatch,
                           LoggerUpdateContract parameters)

Updates an existing logger.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

loggerId - Logger identifier. Must be unique in the 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 - Update parameters.

Returns:

logger 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

LoggersUpdateResponse updateWithResponse(String resourceGroupName,
                                         String serviceName,
                                         String loggerId,
                                         String ifMatch,
                                         LoggerUpdateContract parameters,
                                         com.azure.core.util.Context context)

Updates an existing logger.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

loggerId - Logger identifier. Must be unique in the 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 - Update parameters.

context - The context to associate with this operation.

Returns:

logger 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 loggerId,
            String ifMatch)

Deletes the specified logger.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

loggerId - Logger identifier. Must be unique in the 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 loggerId,
                                                           String ifMatch,
                                                           com.azure.core.util.Context context)

Deletes the specified logger.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

loggerId - Logger identifier. Must be unique in the 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.