Interface PolicyDefinitionsClient
public interface PolicyDefinitionsClient
An instance of this class provides access to all the operations defined in PolicyDefinitionsClient.
-
Method Summary
Modifier and TypeMethodDescriptioncreateOrUpdate(String policyDefinitionName, PolicyDefinitionInner parameters) Creates or updates a policy definition in a subscription.createOrUpdateAsync(String policyDefinitionName, PolicyDefinitionInner parameters) Creates or updates a policy definition in a subscription.createOrUpdateAtManagementGroup(String policyDefinitionName, String managementGroupId, PolicyDefinitionInner parameters) Creates or updates a policy definition in a management group.createOrUpdateAtManagementGroupAsync(String policyDefinitionName, String managementGroupId, PolicyDefinitionInner parameters) Creates or updates a policy definition in a management group.com.azure.core.http.rest.Response<PolicyDefinitionInner> createOrUpdateAtManagementGroupWithResponse(String policyDefinitionName, String managementGroupId, PolicyDefinitionInner parameters, com.azure.core.util.Context context) Creates or updates a policy definition in a management group.Mono<com.azure.core.http.rest.Response<PolicyDefinitionInner>> createOrUpdateAtManagementGroupWithResponseAsync(String policyDefinitionName, String managementGroupId, PolicyDefinitionInner parameters) Creates or updates a policy definition in a management group.com.azure.core.http.rest.Response<PolicyDefinitionInner> createOrUpdateWithResponse(String policyDefinitionName, PolicyDefinitionInner parameters, com.azure.core.util.Context context) Creates or updates a policy definition in a subscription.Mono<com.azure.core.http.rest.Response<PolicyDefinitionInner>> createOrUpdateWithResponseAsync(String policyDefinitionName, PolicyDefinitionInner parameters) Creates or updates a policy definition in a subscription.voidDeletes a policy definition in a subscription.deleteAsync(String policyDefinitionName) Deletes a policy definition in a subscription.voiddeleteAtManagementGroup(String policyDefinitionName, String managementGroupId) Deletes a policy definition in a management group.deleteAtManagementGroupAsync(String policyDefinitionName, String managementGroupId) Deletes a policy definition in a management group.com.azure.core.http.rest.Response<Void> deleteAtManagementGroupWithResponse(String policyDefinitionName, String managementGroupId, com.azure.core.util.Context context) Deletes a policy definition in a management group.deleteAtManagementGroupWithResponseAsync(String policyDefinitionName, String managementGroupId) Deletes a policy definition in a management group.com.azure.core.http.rest.Response<Void> deleteWithResponse(String policyDefinitionName, com.azure.core.util.Context context) Deletes a policy definition in a subscription.deleteWithResponseAsync(String policyDefinitionName) Deletes a policy definition in a subscription.Retrieves a policy definition in a subscription.Retrieves a policy definition in a subscription.getAtManagementGroup(String policyDefinitionName, String managementGroupId) Retrieve a policy definition in a management group.getAtManagementGroupAsync(String policyDefinitionName, String managementGroupId) Retrieve a policy definition in a management group.com.azure.core.http.rest.Response<PolicyDefinitionInner> getAtManagementGroupWithResponse(String policyDefinitionName, String managementGroupId, com.azure.core.util.Context context) Retrieve a policy definition in a management group.Mono<com.azure.core.http.rest.Response<PolicyDefinitionInner>> getAtManagementGroupWithResponseAsync(String policyDefinitionName, String managementGroupId) Retrieve a policy definition in a management group.getBuiltIn(String policyDefinitionName) Retrieves a built-in policy definition.getBuiltInAsync(String policyDefinitionName) Retrieves a built-in policy definition.com.azure.core.http.rest.Response<PolicyDefinitionInner> getBuiltInWithResponse(String policyDefinitionName, com.azure.core.util.Context context) Retrieves a built-in policy definition.Mono<com.azure.core.http.rest.Response<PolicyDefinitionInner>> getBuiltInWithResponseAsync(String policyDefinitionName) Retrieves a built-in policy definition.com.azure.core.http.rest.Response<PolicyDefinitionInner> getWithResponse(String policyDefinitionName, com.azure.core.util.Context context) Retrieves a policy definition in a subscription.Mono<com.azure.core.http.rest.Response<PolicyDefinitionInner>> getWithResponseAsync(String policyDefinitionName) Retrieves a policy definition in a subscription.com.azure.core.http.rest.PagedIterable<PolicyDefinitionInner> list()Retrieves policy definitions in a subscription This operation retrieves a list of all the policy definitions in a given subscription that match the optional given $filter.com.azure.core.http.rest.PagedIterable<PolicyDefinitionInner> Retrieves policy definitions in a subscription This operation retrieves a list of all the policy definitions in a given subscription that match the optional given $filter.com.azure.core.http.rest.PagedFlux<PolicyDefinitionInner> Retrieves policy definitions in a subscription This operation retrieves a list of all the policy definitions in a given subscription that match the optional given $filter.com.azure.core.http.rest.PagedFlux<PolicyDefinitionInner> Retrieves policy definitions in a subscription This operation retrieves a list of all the policy definitions in a given subscription that match the optional given $filter.com.azure.core.http.rest.PagedIterable<PolicyDefinitionInner> Retrieve built-in policy definitions This operation retrieves a list of all the built-in policy definitions that match the optional given $filter.com.azure.core.http.rest.PagedIterable<PolicyDefinitionInner> listBuiltIn(String filter, Integer top, com.azure.core.util.Context context) Retrieve built-in policy definitions This operation retrieves a list of all the built-in policy definitions that match the optional given $filter.com.azure.core.http.rest.PagedFlux<PolicyDefinitionInner> Retrieve built-in policy definitions This operation retrieves a list of all the built-in policy definitions that match the optional given $filter.com.azure.core.http.rest.PagedFlux<PolicyDefinitionInner> listBuiltInAsync(String filter, Integer top) Retrieve built-in policy definitions This operation retrieves a list of all the built-in policy definitions that match the optional given $filter.com.azure.core.http.rest.PagedIterable<PolicyDefinitionInner> listByManagementGroup(String managementGroupId) Retrieve policy definitions in a management group This operation retrieves a list of all the policy definitions in a given management group that match the optional given $filter.com.azure.core.http.rest.PagedIterable<PolicyDefinitionInner> listByManagementGroup(String managementGroupId, String filter, Integer top, com.azure.core.util.Context context) Retrieve policy definitions in a management group This operation retrieves a list of all the policy definitions in a given management group that match the optional given $filter.com.azure.core.http.rest.PagedFlux<PolicyDefinitionInner> listByManagementGroupAsync(String managementGroupId) Retrieve policy definitions in a management group This operation retrieves a list of all the policy definitions in a given management group that match the optional given $filter.com.azure.core.http.rest.PagedFlux<PolicyDefinitionInner> listByManagementGroupAsync(String managementGroupId, String filter, Integer top) Retrieve policy definitions in a management group This operation retrieves a list of all the policy definitions in a given management group that match the optional given $filter.
-
Method Details
-
createOrUpdateWithResponseAsync
Mono<com.azure.core.http.rest.Response<PolicyDefinitionInner>> createOrUpdateWithResponseAsync(String policyDefinitionName, PolicyDefinitionInner parameters) Creates or updates a policy definition in a subscription. This operation creates or updates a policy definition in the given subscription with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to create.parameters- The policy definition properties.- Returns:
- the policy definition along with
Responseon successful completion ofMono. - 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.
-
createOrUpdateAsync
Mono<PolicyDefinitionInner> createOrUpdateAsync(String policyDefinitionName, PolicyDefinitionInner parameters) Creates or updates a policy definition in a subscription. This operation creates or updates a policy definition in the given subscription with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to create.parameters- The policy definition properties.- Returns:
- the policy definition on successful completion of
Mono. - 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<PolicyDefinitionInner> createOrUpdateWithResponse(String policyDefinitionName, PolicyDefinitionInner parameters, com.azure.core.util.Context context) Creates or updates a policy definition in a subscription. This operation creates or updates a policy definition in the given subscription with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to create.parameters- The policy definition properties.context- The context to associate with this operation.- Returns:
- the policy definition 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.
-
createOrUpdate
Creates or updates a policy definition in a subscription. This operation creates or updates a policy definition in the given subscription with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to create.parameters- The policy definition properties.- Returns:
- the policy definition.
- 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.
-
deleteWithResponseAsync
Deletes a policy definition in a subscription. This operation deletes the policy definition in the given subscription with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to delete.- Returns:
- the
Responseon successful completion ofMono. - 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.
-
deleteAsync
Deletes a policy definition in a subscription. This operation deletes the policy definition in the given subscription with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to delete.- Returns:
- A
Monothat completes when a successful response is received. - 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 policyDefinitionName, com.azure.core.util.Context context) Deletes a policy definition in a subscription. This operation deletes the policy definition in the given subscription with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to delete.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.
-
delete
Deletes a policy definition in a subscription. This operation deletes the policy definition in the given subscription with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to delete.- 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.
-
getWithResponseAsync
Mono<com.azure.core.http.rest.Response<PolicyDefinitionInner>> getWithResponseAsync(String policyDefinitionName) Retrieves a policy definition in a subscription. This operation retrieves the policy definition in the given subscription with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to get.- Returns:
- the policy definition along with
Responseon successful completion ofMono. - 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.
-
getAsync
Retrieves a policy definition in a subscription. This operation retrieves the policy definition in the given subscription with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to get.- Returns:
- the policy definition on successful completion of
Mono. - 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<PolicyDefinitionInner> getWithResponse(String policyDefinitionName, com.azure.core.util.Context context) Retrieves a policy definition in a subscription. This operation retrieves the policy definition in the given subscription with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to get.context- The context to associate with this operation.- Returns:
- the policy definition 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.
-
get
Retrieves a policy definition in a subscription. This operation retrieves the policy definition in the given subscription with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to get.- Returns:
- the policy definition.
- 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.
-
getBuiltInWithResponseAsync
Mono<com.azure.core.http.rest.Response<PolicyDefinitionInner>> getBuiltInWithResponseAsync(String policyDefinitionName) Retrieves a built-in policy definition. This operation retrieves the built-in policy definition with the given name.- Parameters:
policyDefinitionName- The name of the built-in policy definition to get.- Returns:
- the policy definition along with
Responseon successful completion ofMono. - 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.
-
getBuiltInAsync
Retrieves a built-in policy definition. This operation retrieves the built-in policy definition with the given name.- Parameters:
policyDefinitionName- The name of the built-in policy definition to get.- Returns:
- the policy definition on successful completion of
Mono. - 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.
-
getBuiltInWithResponse
com.azure.core.http.rest.Response<PolicyDefinitionInner> getBuiltInWithResponse(String policyDefinitionName, com.azure.core.util.Context context) Retrieves a built-in policy definition. This operation retrieves the built-in policy definition with the given name.- Parameters:
policyDefinitionName- The name of the built-in policy definition to get.context- The context to associate with this operation.- Returns:
- the policy definition 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.
-
getBuiltIn
Retrieves a built-in policy definition. This operation retrieves the built-in policy definition with the given name.- Parameters:
policyDefinitionName- The name of the built-in policy definition to get.- Returns:
- the policy definition.
- 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.
-
createOrUpdateAtManagementGroupWithResponseAsync
Mono<com.azure.core.http.rest.Response<PolicyDefinitionInner>> createOrUpdateAtManagementGroupWithResponseAsync(String policyDefinitionName, String managementGroupId, PolicyDefinitionInner parameters) Creates or updates a policy definition in a management group. This operation creates or updates a policy definition in the given management group with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to create.managementGroupId- The ID of the management group.parameters- The policy definition properties.- Returns:
- the policy definition along with
Responseon successful completion ofMono. - 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.
-
createOrUpdateAtManagementGroupAsync
Mono<PolicyDefinitionInner> createOrUpdateAtManagementGroupAsync(String policyDefinitionName, String managementGroupId, PolicyDefinitionInner parameters) Creates or updates a policy definition in a management group. This operation creates or updates a policy definition in the given management group with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to create.managementGroupId- The ID of the management group.parameters- The policy definition properties.- Returns:
- the policy definition on successful completion of
Mono. - 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.
-
createOrUpdateAtManagementGroupWithResponse
com.azure.core.http.rest.Response<PolicyDefinitionInner> createOrUpdateAtManagementGroupWithResponse(String policyDefinitionName, String managementGroupId, PolicyDefinitionInner parameters, com.azure.core.util.Context context) Creates or updates a policy definition in a management group. This operation creates or updates a policy definition in the given management group with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to create.managementGroupId- The ID of the management group.parameters- The policy definition properties.context- The context to associate with this operation.- Returns:
- the policy definition 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.
-
createOrUpdateAtManagementGroup
PolicyDefinitionInner createOrUpdateAtManagementGroup(String policyDefinitionName, String managementGroupId, PolicyDefinitionInner parameters) Creates or updates a policy definition in a management group. This operation creates or updates a policy definition in the given management group with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to create.managementGroupId- The ID of the management group.parameters- The policy definition properties.- Returns:
- the policy definition.
- 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.
-
deleteAtManagementGroupWithResponseAsync
Mono<com.azure.core.http.rest.Response<Void>> deleteAtManagementGroupWithResponseAsync(String policyDefinitionName, String managementGroupId) Deletes a policy definition in a management group. This operation deletes the policy definition in the given management group with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to delete.managementGroupId- The ID of the management group.- Returns:
- the
Responseon successful completion ofMono. - 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.
-
deleteAtManagementGroupAsync
Deletes a policy definition in a management group. This operation deletes the policy definition in the given management group with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to delete.managementGroupId- The ID of the management group.- Returns:
- A
Monothat completes when a successful response is received. - 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.
-
deleteAtManagementGroupWithResponse
com.azure.core.http.rest.Response<Void> deleteAtManagementGroupWithResponse(String policyDefinitionName, String managementGroupId, com.azure.core.util.Context context) Deletes a policy definition in a management group. This operation deletes the policy definition in the given management group with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to delete.managementGroupId- The ID of the management group.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.
-
deleteAtManagementGroup
Deletes a policy definition in a management group. This operation deletes the policy definition in the given management group with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to delete.managementGroupId- The ID of the management group.- 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.
-
getAtManagementGroupWithResponseAsync
Mono<com.azure.core.http.rest.Response<PolicyDefinitionInner>> getAtManagementGroupWithResponseAsync(String policyDefinitionName, String managementGroupId) Retrieve a policy definition in a management group. This operation retrieves the policy definition in the given management group with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to get.managementGroupId- The ID of the management group.- Returns:
- the policy definition along with
Responseon successful completion ofMono. - 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.
-
getAtManagementGroupAsync
Mono<PolicyDefinitionInner> getAtManagementGroupAsync(String policyDefinitionName, String managementGroupId) Retrieve a policy definition in a management group. This operation retrieves the policy definition in the given management group with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to get.managementGroupId- The ID of the management group.- Returns:
- the policy definition on successful completion of
Mono. - 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.
-
getAtManagementGroupWithResponse
com.azure.core.http.rest.Response<PolicyDefinitionInner> getAtManagementGroupWithResponse(String policyDefinitionName, String managementGroupId, com.azure.core.util.Context context) Retrieve a policy definition in a management group. This operation retrieves the policy definition in the given management group with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to get.managementGroupId- The ID of the management group.context- The context to associate with this operation.- Returns:
- the policy definition 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.
-
getAtManagementGroup
Retrieve a policy definition in a management group. This operation retrieves the policy definition in the given management group with the given name.- Parameters:
policyDefinitionName- The name of the policy definition to get.managementGroupId- The ID of the management group.- Returns:
- the policy definition.
- 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.
-
listAsync
Retrieves policy definitions in a subscription This operation retrieves a list of all the policy definitions in a given subscription that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy definitions associated with the subscription, including those that apply directly or from management groups that contain the given subscription. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given subscription. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.- Parameters:
filter- The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.top- Maximum number of records to return. When the $top filter is not provided, it will return 500 records.- Returns:
- list of policy definitions as paginated response with
PagedFlux. - 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.
-
listAsync
com.azure.core.http.rest.PagedFlux<PolicyDefinitionInner> listAsync()Retrieves policy definitions in a subscription This operation retrieves a list of all the policy definitions in a given subscription that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy definitions associated with the subscription, including those that apply directly or from management groups that contain the given subscription. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given subscription. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.- Returns:
- list of policy definitions as paginated response with
PagedFlux. - Throws:
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.
-
list
com.azure.core.http.rest.PagedIterable<PolicyDefinitionInner> list()Retrieves policy definitions in a subscription This operation retrieves a list of all the policy definitions in a given subscription that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy definitions associated with the subscription, including those that apply directly or from management groups that contain the given subscription. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given subscription. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.- Returns:
- list of policy definitions as paginated response with
PagedIterable. - Throws:
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.
-
list
com.azure.core.http.rest.PagedIterable<PolicyDefinitionInner> list(String filter, Integer top, com.azure.core.util.Context context) Retrieves policy definitions in a subscription This operation retrieves a list of all the policy definitions in a given subscription that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy definitions associated with the subscription, including those that apply directly or from management groups that contain the given subscription. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given subscription. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.- Parameters:
filter- The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.top- Maximum number of records to return. When the $top filter is not provided, it will return 500 records.context- The context to associate with this operation.- Returns:
- list of policy definitions 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.
-
listBuiltInAsync
com.azure.core.http.rest.PagedFlux<PolicyDefinitionInner> listBuiltInAsync(String filter, Integer top) Retrieve built-in policy definitions This operation retrieves a list of all the built-in policy definitions that match the optional given $filter. If $filter='policyType -eq {value}' is provided, the returned list only includes all built-in policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all built-in policy definitions whose category match the {value}.- Parameters:
filter- The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.top- Maximum number of records to return. When the $top filter is not provided, it will return 500 records.- Returns:
- list of policy definitions as paginated response with
PagedFlux. - 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.
-
listBuiltInAsync
com.azure.core.http.rest.PagedFlux<PolicyDefinitionInner> listBuiltInAsync()Retrieve built-in policy definitions This operation retrieves a list of all the built-in policy definitions that match the optional given $filter. If $filter='policyType -eq {value}' is provided, the returned list only includes all built-in policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all built-in policy definitions whose category match the {value}.- Returns:
- list of policy definitions as paginated response with
PagedFlux. - Throws:
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.
-
listBuiltIn
com.azure.core.http.rest.PagedIterable<PolicyDefinitionInner> listBuiltIn()Retrieve built-in policy definitions This operation retrieves a list of all the built-in policy definitions that match the optional given $filter. If $filter='policyType -eq {value}' is provided, the returned list only includes all built-in policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all built-in policy definitions whose category match the {value}.- Returns:
- list of policy definitions as paginated response with
PagedIterable. - Throws:
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.
-
listBuiltIn
com.azure.core.http.rest.PagedIterable<PolicyDefinitionInner> listBuiltIn(String filter, Integer top, com.azure.core.util.Context context) Retrieve built-in policy definitions This operation retrieves a list of all the built-in policy definitions that match the optional given $filter. If $filter='policyType -eq {value}' is provided, the returned list only includes all built-in policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all built-in policy definitions whose category match the {value}.- Parameters:
filter- The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.top- Maximum number of records to return. When the $top filter is not provided, it will return 500 records.context- The context to associate with this operation.- Returns:
- list of policy definitions 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.
-
listByManagementGroupAsync
com.azure.core.http.rest.PagedFlux<PolicyDefinitionInner> listByManagementGroupAsync(String managementGroupId, String filter, Integer top) Retrieve policy definitions in a management group This operation retrieves a list of all the policy definitions in a given management group that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy definitions associated with the management group, including those that apply directly or from management groups that contain the given management group. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given management group. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.- Parameters:
managementGroupId- The ID of the management group.filter- The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.top- Maximum number of records to return. When the $top filter is not provided, it will return 500 records.- Returns:
- list of policy definitions as paginated response with
PagedFlux. - 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.
-
listByManagementGroupAsync
com.azure.core.http.rest.PagedFlux<PolicyDefinitionInner> listByManagementGroupAsync(String managementGroupId) Retrieve policy definitions in a management group This operation retrieves a list of all the policy definitions in a given management group that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy definitions associated with the management group, including those that apply directly or from management groups that contain the given management group. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given management group. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.- Parameters:
managementGroupId- The ID of the management group.- Returns:
- list of policy definitions as paginated response with
PagedFlux. - 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.
-
listByManagementGroup
com.azure.core.http.rest.PagedIterable<PolicyDefinitionInner> listByManagementGroup(String managementGroupId) Retrieve policy definitions in a management group This operation retrieves a list of all the policy definitions in a given management group that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy definitions associated with the management group, including those that apply directly or from management groups that contain the given management group. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given management group. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.- Parameters:
managementGroupId- The ID of the management group.- Returns:
- list of policy definitions 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.
-
listByManagementGroup
com.azure.core.http.rest.PagedIterable<PolicyDefinitionInner> listByManagementGroup(String managementGroupId, String filter, Integer top, com.azure.core.util.Context context) Retrieve policy definitions in a management group This operation retrieves a list of all the policy definitions in a given management group that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy definitions associated with the management group, including those that apply directly or from management groups that contain the given management group. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given management group. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.- Parameters:
managementGroupId- The ID of the management group.filter- The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.top- Maximum number of records to return. When the $top filter is not provided, it will return 500 records.context- The context to associate with this operation.- Returns:
- list of policy definitions 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.
-