Interface ProductPolicies
-
public interface ProductPolicies
Resource collection API of ProductPolicies.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description PolicyContract
createOrUpdate(String resourceGroupName, String serviceName, String productId, PolicyIdName policyId, PolicyContractInner parameters)
Creates or updates policy configuration for the Product.com.azure.core.http.rest.Response<PolicyContract>
createOrUpdateWithResponse(String resourceGroupName, String serviceName, String productId, PolicyIdName policyId, PolicyContractInner parameters, String ifMatch, com.azure.core.util.Context context)
Creates or updates policy configuration for the Product.void
delete(String resourceGroupName, String serviceName, String productId, PolicyIdName policyId, String ifMatch)
Deletes the policy configuration at the Product.com.azure.core.http.rest.Response<Void>
deleteWithResponse(String resourceGroupName, String serviceName, String productId, PolicyIdName policyId, String ifMatch, com.azure.core.util.Context context)
Deletes the policy configuration at the Product.PolicyContract
get(String resourceGroupName, String serviceName, String productId, PolicyIdName policyId)
Get the policy configuration at the Product level.void
getEntityTag(String resourceGroupName, String serviceName, String productId, PolicyIdName policyId)
Get the ETag of the policy configuration at the Product level.ProductPoliciesGetEntityTagResponse
getEntityTagWithResponse(String resourceGroupName, String serviceName, String productId, PolicyIdName policyId, com.azure.core.util.Context context)
Get the ETag of the policy configuration at the Product level.com.azure.core.http.rest.Response<PolicyContract>
getWithResponse(String resourceGroupName, String serviceName, String productId, PolicyIdName policyId, PolicyExportFormat format, com.azure.core.util.Context context)
Get the policy configuration at the Product level.PolicyCollection
listByProduct(String resourceGroupName, String serviceName, String productId)
Get the policy configuration at the Product level.com.azure.core.http.rest.Response<PolicyCollection>
listByProductWithResponse(String resourceGroupName, String serviceName, String productId, com.azure.core.util.Context context)
Get the policy configuration at the Product level.
-
-
-
Method Detail
-
listByProduct
PolicyCollection listByProduct(String resourceGroupName, String serviceName, String productId)
Get the policy configuration at the Product level.- Parameters:
resourceGroupName
- The name of the resource group.serviceName
- The name of the API Management service.productId
- Product identifier. Must be unique in the current API Management service instance.- Returns:
- the policy configuration at the Product level.
- 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.
-
listByProductWithResponse
com.azure.core.http.rest.Response<PolicyCollection> listByProductWithResponse(String resourceGroupName, String serviceName, String productId, com.azure.core.util.Context context)
Get the policy configuration at the Product level.- Parameters:
resourceGroupName
- The name of the resource group.serviceName
- The name of the API Management service.productId
- Product identifier. Must be unique in the current API Management service instance.context
- The context to associate with this operation.- Returns:
- the policy configuration at the Product level 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, String productId, PolicyIdName policyId)
Get the ETag of the policy configuration at the Product level.- Parameters:
resourceGroupName
- The name of the resource group.serviceName
- The name of the API Management service.productId
- Product identifier. Must be unique in the current API Management service instance.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
ProductPoliciesGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String productId, PolicyIdName policyId, com.azure.core.util.Context context)
Get the ETag of the policy configuration at the Product level.- Parameters:
resourceGroupName
- The name of the resource group.serviceName
- The name of the API Management service.productId
- Product identifier. Must be unique in the current API Management service instance.policyId
- The identifier of the Policy.context
- The context to associate with this operation.- Returns:
- the ETag of the policy configuration at the Product level.
- 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, String productId, PolicyIdName policyId)
Get the policy configuration at the Product level.- Parameters:
resourceGroupName
- The name of the resource group.serviceName
- The name of the API Management service.productId
- Product identifier. Must be unique in the current API Management service instance.policyId
- The identifier of the Policy.- Returns:
- the policy configuration at the Product level.
- 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, String productId, PolicyIdName policyId, PolicyExportFormat format, com.azure.core.util.Context context)
Get the policy configuration at the Product level.- Parameters:
resourceGroupName
- The name of the resource group.serviceName
- The name of the API Management service.productId
- Product identifier. Must be unique in the current API Management service instance.policyId
- The identifier of the Policy.format
- Policy Export Format.context
- The context to associate with this operation.- Returns:
- the policy configuration at the Product level.
- 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, String productId, PolicyIdName policyId, PolicyContractInner parameters)
Creates or updates policy configuration for the Product.- Parameters:
resourceGroupName
- The name of the resource group.serviceName
- The name of the API Management service.productId
- Product identifier. Must be unique in the current API Management service instance.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, String productId, PolicyIdName policyId, PolicyContractInner parameters, String ifMatch, com.azure.core.util.Context context)
Creates or updates policy configuration for the Product.- Parameters:
resourceGroupName
- The name of the resource group.serviceName
- The name of the API Management service.productId
- Product identifier. Must be unique in the current API Management service instance.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, String productId, PolicyIdName policyId, String ifMatch)
Deletes the policy configuration at the Product.- Parameters:
resourceGroupName
- The name of the resource group.serviceName
- The name of the API Management service.productId
- Product identifier. Must be unique in the current API Management service instance.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, String productId, PolicyIdName policyId, String ifMatch, com.azure.core.util.Context context)
Deletes the policy configuration at the Product.- Parameters:
resourceGroupName
- The name of the resource group.serviceName
- The name of the API Management service.productId
- Product identifier. Must be unique in the current API Management service instance.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.
-
-