PolicyDefinitionsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:policy_definitions> attribute.
- Inheritance
-
builtins.objectPolicyDefinitionsOperations
Constructor
PolicyDefinitionsOperations(*args, **kwargs)Methods
| create_or_update |
Creates or updates a policy definition. |
| create_or_update_at_management_group |
Creates or updates a policy definition at management group level. |
| delete |
Deletes a policy definition. |
| delete_at_management_group |
Deletes a policy definition at management group level. |
| get |
Gets the policy definition. |
| get_at_management_group |
Gets the policy definition at management group level. |
| get_built_in |
Gets the built in policy definition. |
| list |
Gets all the policy definitions for a subscription. |
| list_built_in |
Gets all the built in policy definitions. |
| list_by_management_group |
Gets all the policy definitions for a subscription at management group level. |
create_or_update
Creates or updates a policy definition.
create_or_update(policy_definition_name: str, parameters: _models.PolicyDefinition, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PolicyDefinitionParameters
| Name | Description |
|---|---|
|
policy_definition_name
Required
|
The name of the policy definition to create. Required. |
|
parameters
Required
|
The policy definition properties. Is either a PolicyDefinition type or a IO type. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
content_type
|
Body Parameter content-type. Known values are: 'application/json', 'text/json'. Default value is None. |
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
PolicyDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
create_or_update_at_management_group
Creates or updates a policy definition at management group level.
create_or_update_at_management_group(policy_definition_name: str, management_group_id: str, parameters: _models.PolicyDefinition, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PolicyDefinitionParameters
| Name | Description |
|---|---|
|
policy_definition_name
Required
|
The name of the policy definition to create. Required. |
|
management_group_id
Required
|
The ID of the management group. Required. |
|
parameters
Required
|
The policy definition properties. Is either a PolicyDefinition type or a IO type. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
content_type
|
Body Parameter content-type. Known values are: 'application/json', 'text/json'. Default value is None. |
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
PolicyDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete
Deletes a policy definition.
delete(policy_definition_name: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
policy_definition_name
Required
|
The name of the policy definition to delete. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete_at_management_group
Deletes a policy definition at management group level.
delete_at_management_group(policy_definition_name: str, management_group_id: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
policy_definition_name
Required
|
The name of the policy definition to delete. Required. |
|
management_group_id
Required
|
The ID of the management group. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Gets the policy definition.
get(policy_definition_name: str, **kwargs: Any) -> PolicyDefinitionParameters
| Name | Description |
|---|---|
|
policy_definition_name
Required
|
The name of the policy definition to get. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
PolicyDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_at_management_group
Gets the policy definition at management group level.
get_at_management_group(policy_definition_name: str, management_group_id: str, **kwargs: Any) -> PolicyDefinitionParameters
| Name | Description |
|---|---|
|
policy_definition_name
Required
|
The name of the policy definition to get. Required. |
|
management_group_id
Required
|
The ID of the management group. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
PolicyDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_built_in
Gets the built in policy definition.
get_built_in(policy_definition_name: str, **kwargs: Any) -> PolicyDefinitionParameters
| Name | Description |
|---|---|
|
policy_definition_name
Required
|
The name of the built in policy definition to get. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
PolicyDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list
Gets all the policy definitions for a subscription.
list(**kwargs: Any) -> Iterable[PolicyDefinition]Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either PolicyDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_built_in
Gets all the built in policy definitions.
list_built_in(**kwargs: Any) -> Iterable[PolicyDefinition]Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either PolicyDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_management_group
Gets all the policy definitions for a subscription at management group level.
list_by_management_group(management_group_id: str, **kwargs: Any) -> Iterable[PolicyDefinition]Parameters
| Name | Description |
|---|---|
|
management_group_id
Required
|
The ID of the management group. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either PolicyDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.resource.policy.v2016_12_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\policy\\v2016_12_01\\models\\__init__.py'>
Azure SDK for Python
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for