Package com.azure.resourcemanager.apimanagement.models

Interface Policies

public interface Policies

Resource collection API of Policies.

Method Summary

Modifier and Type	Method	Description
PolicyContract	createOrUpdate(String resourceGroupName, String serviceName, PolicyIdName policyId, PolicyContractInner parameters)	Creates or updates the global policy configuration of the Api Management service.
com.azure.core.http.rest.Response<PolicyContract>	createOrUpdateWithResponse(String resourceGroupName, String serviceName, PolicyIdName policyId, PolicyContractInner parameters, String ifMatch, com.azure.core.util.Context context)	Creates or updates the global policy configuration of the Api Management service.
void	delete(String resourceGroupName, String serviceName, PolicyIdName policyId, String ifMatch)	Deletes the global policy configuration of the Api Management Service.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, PolicyIdName policyId, String ifMatch, com.azure.core.util.Context context)	Deletes the global policy configuration of the Api Management Service.
PolicyContract	get(String resourceGroupName, String serviceName, PolicyIdName policyId)	Get the Global policy definition of the Api Management service.
void	getEntityTag(String resourceGroupName, String serviceName, PolicyIdName policyId)	Gets the entity state (Etag) version of the Global policy definition in the Api Management service.
PoliciesGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, PolicyIdName policyId, com.azure.core.util.Context context)	Gets the entity state (Etag) version of the Global policy definition in the Api Management service.
com.azure.core.http.rest.Response<PolicyContract>	getWithResponse(String resourceGroupName, String serviceName, PolicyIdName policyId, PolicyExportFormat format, com.azure.core.util.Context context)	Get the Global policy definition of the Api Management service.
PolicyCollection	listByService(String resourceGroupName, String serviceName)	Lists all the Global Policy definitions of the Api Management service.
com.azure.core.http.rest.Response<PolicyCollection>	listByServiceWithResponse(String resourceGroupName, String serviceName, com.azure.core.util.Context context)	Lists all the Global Policy definitions of the Api Management service.

Method Detail

listByService

PolicyCollection listByService(String resourceGroupName,
                               String serviceName)

Lists all the Global Policy definitions of the Api Management service.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

Returns:

the response of the list policy operation.

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.

listByServiceWithResponse

com.azure.core.http.rest.Response<PolicyCollection> listByServiceWithResponse(String resourceGroupName,
                                                                              String serviceName,
                                                                              com.azure.core.util.Context context)

Lists all the Global Policy definitions of the Api Management service.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

context - The context to associate with this operation.

Returns:

the response of the list policy operation along with 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.

getEntityTag

void getEntityTag(String resourceGroupName,
                  String serviceName,
                  PolicyIdName policyId)

Gets the entity state (Etag) version of the Global policy definition in the Api Management service.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

policyId - The identifier of the Policy.

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

PoliciesGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName,
                                                      String serviceName,
                                                      PolicyIdName policyId,
                                                      com.azure.core.util.Context context)

Gets the entity state (Etag) version of the Global policy definition in the Api Management service.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

policyId - The identifier of the Policy.

context - The context to associate with this operation.

Returns:

the entity state (Etag) version of the Global policy definition in the Api Management service.

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

PolicyContract get(String resourceGroupName,
                   String serviceName,
                   PolicyIdName policyId)

Get the Global policy definition of the Api Management service.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

policyId - The identifier of the Policy.

Returns:

the Global policy definition of the Api Management service.

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<PolicyContract> getWithResponse(String resourceGroupName,
                                                                  String serviceName,
                                                                  PolicyIdName policyId,
                                                                  PolicyExportFormat format,
                                                                  com.azure.core.util.Context context)

Get the Global policy definition of the Api Management service.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

policyId - The identifier of the Policy.

format - Policy Export Format.

context - The context to associate with this operation.

Returns:

the Global policy definition of the Api Management service.

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

PolicyContract createOrUpdate(String resourceGroupName,
                              String serviceName,
                              PolicyIdName policyId,
                              PolicyContractInner parameters)

Creates or updates the global policy configuration of the Api Management service.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

policyId - The identifier of the Policy.

parameters - The policy contents to apply.

Returns:

policy Contract 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

com.azure.core.http.rest.Response<PolicyContract> createOrUpdateWithResponse(String resourceGroupName,
                                                                             String serviceName,
                                                                             PolicyIdName policyId,
                                                                             PolicyContractInner parameters,
                                                                             String ifMatch,
                                                                             com.azure.core.util.Context context)

Creates or updates the global policy configuration of the Api Management service.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

policyId - The identifier of the Policy.

parameters - The policy contents to apply.

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:

policy Contract 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,
            PolicyIdName policyId,
            String ifMatch)

Deletes the global policy configuration of the Api Management Service.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

policyId - The identifier of the Policy.

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

Deletes the global policy configuration of the Api Management Service.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

policyId - The identifier of the Policy.

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.