PolicyDefinitionsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:policy_definitions> attribute.
Constructor
PolicyDefinitionsOperations(*args, **kwargs)Methods
| create_or_update |
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. |
| create_or_update_at_management_group |
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. |
| delete |
Deletes a policy definition in a subscription. This operation deletes the policy definition in the given subscription with the given name. |
| delete_at_management_group |
Deletes a policy definition in a management group. This operation deletes the policy definition in the given management group with the given name. |
| get |
Retrieves a policy definition in a subscription. This operation retrieves the policy definition in the given subscription with the given name. |
| get_at_management_group |
Retrieve a policy definition in a management group. This operation retrieves the policy definition in the given management group with the given name. |
| get_built_in |
Retrieves a built-in policy definition. This operation retrieves the built-in policy definition with the given name. |
| list |
Retrieves policy definitions in a subscription. This operation retrieves a list of all the policy definitions in a given subscription. |
| list_built_in |
Retrieve built-in policy definitions. This operation retrieves a list of all the built-in policy definitions. |
| list_by_management_group |
Retrieve policy definitions in a management group. This operation retrieves a list of all the policy definitions in a given management group. |
create_or_update
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.
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[bytes] type. Required. |
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 in a management group.
This operation creates or updates a policy definition in the given management group with the given name.
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[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
PolicyDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete
Deletes a policy definition in a subscription.
This operation deletes the policy definition in the given subscription with the given name.
delete(policy_definition_name: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
policy_definition_name
Required
|
The name of the policy definition to delete. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete_at_management_group
Deletes a policy definition in a management group.
This operation deletes the policy definition in the given management group with the given name.
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. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Retrieves a policy definition in a subscription.
This operation retrieves the policy definition in the given subscription with the given name.
get(policy_definition_name: str, **kwargs: Any) -> PolicyDefinitionParameters
| Name | Description |
|---|---|
|
policy_definition_name
Required
|
The name of the policy definition to get. Required. |
Returns
| Type | Description |
|---|---|
|
PolicyDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_at_management_group
Retrieve a policy definition in a management group.
This operation retrieves the policy definition in the given management group with the given name.
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. |
Returns
| Type | Description |
|---|---|
|
PolicyDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_built_in
Retrieves a built-in policy definition.
This operation retrieves the built-in policy definition with the given name.
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. |
Returns
| Type | Description |
|---|---|
|
PolicyDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list
Retrieves policy definitions in a subscription.
This operation retrieves a list of all the policy definitions in a given subscription.
list(**kwargs: Any) -> ItemPaged[PolicyDefinition]Returns
| Type | Description |
|---|---|
|
An iterator like instance of either PolicyDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_built_in
Retrieve built-in policy definitions.
This operation retrieves a list of all the built-in policy definitions.
list_built_in(**kwargs: Any) -> ItemPaged[PolicyDefinition]Returns
| Type | Description |
|---|---|
|
An iterator like instance of either PolicyDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_management_group
Retrieve policy definitions in a management group.
This operation retrieves a list of all the policy definitions in a given management group.
list_by_management_group(management_group_id: str, **kwargs: Any) -> ItemPaged[PolicyDefinition]Parameters
| Name | Description |
|---|---|
|
management_group_id
Required
|
The ID of the management group. Required. |
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.v2019_09_01.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv206\\Lib\\site-packages\\azure\\mgmt\\resource\\policy\\v2019_09_01\\models\\__init__.py'>