Share via

PolicyDefinitionsOperations interface

Package:
@azure/arm-policy

Interface representing a PolicyDefinitions operations.

Properties

createOrUpdate

This operation creates or updates a policy definition in the given subscription with the given name.
createOrUpdateAtManagementGroup

This operation creates or updates a policy definition in the given management group with the given name.
delete
deleteAtManagementGroup

This operation deletes the policy definition in the given management group with the given name.
get

This operation retrieves the policy definition in the given subscription with the given name.
getAtManagementGroup

This operation retrieves the policy definition in the given management group with the given name.
getBuiltIn

This operation retrieves the built-in policy definition with the given name.
list

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}.
listBuiltIn

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}.
listByManagementGroup

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}.

Property Details

createOrUpdate

This operation creates or updates a policy definition in the given subscription with the given name.

createOrUpdate: (policyDefinitionName: string, parameters: PolicyDefinition, options?: PolicyDefinitionsCreateOrUpdateOptionalParams) => Promise<PolicyDefinition>

Property Value

(policyDefinitionName: string, parameters: PolicyDefinition, options?: PolicyDefinitionsCreateOrUpdateOptionalParams) => Promise<PolicyDefinition>

createOrUpdateAtManagementGroup

This operation creates or updates a policy definition in the given management group with the given name.

createOrUpdateAtManagementGroup: (managementGroupId: string, policyDefinitionName: string, parameters: PolicyDefinition, options?: PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams) => Promise<PolicyDefinition>

Property Value

(managementGroupId: string, policyDefinitionName: string, parameters: PolicyDefinition, options?: PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams) => Promise<PolicyDefinition>

delete 

delete: (policyDefinitionName: string, options?: PolicyDefinitionsDeleteOptionalParams) => Promise<void>

Property Value

(policyDefinitionName: string, options?: PolicyDefinitionsDeleteOptionalParams) => Promise<void>

deleteAtManagementGroup

This operation deletes the policy definition in the given management group with the given name.

deleteAtManagementGroup: (managementGroupId: string, policyDefinitionName: string, options?: PolicyDefinitionsDeleteAtManagementGroupOptionalParams) => Promise<void>

Property Value

(managementGroupId: string, policyDefinitionName: string, options?: PolicyDefinitionsDeleteAtManagementGroupOptionalParams) => Promise<void>

get

This operation retrieves the policy definition in the given subscription with the given name.

get: (policyDefinitionName: string, options?: PolicyDefinitionsGetOptionalParams) => Promise<PolicyDefinition>

Property Value

(policyDefinitionName: string, options?: PolicyDefinitionsGetOptionalParams) => Promise<PolicyDefinition>

getAtManagementGroup

This operation retrieves the policy definition in the given management group with the given name.

getAtManagementGroup: (managementGroupId: string, policyDefinitionName: string, options?: PolicyDefinitionsGetAtManagementGroupOptionalParams) => Promise<PolicyDefinition>

Property Value

(managementGroupId: string, policyDefinitionName: string, options?: PolicyDefinitionsGetAtManagementGroupOptionalParams) => Promise<PolicyDefinition>

getBuiltIn

This operation retrieves the built-in policy definition with the given name.

getBuiltIn: (policyDefinitionName: string, options?: PolicyDefinitionsGetBuiltInOptionalParams) => Promise<PolicyDefinition>

Property Value

(policyDefinitionName: string, options?: PolicyDefinitionsGetBuiltInOptionalParams) => Promise<PolicyDefinition>

list

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}.

list: (options?: PolicyDefinitionsListOptionalParams) => PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>

Property Value

(options?: PolicyDefinitionsListOptionalParams) => PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>

listBuiltIn

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}.

listBuiltIn: (options?: PolicyDefinitionsListBuiltInOptionalParams) => PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>

Property Value

(options?: PolicyDefinitionsListBuiltInOptionalParams) => PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>

listByManagementGroup

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}.

listByManagementGroup: (managementGroupId: string, options?: PolicyDefinitionsListByManagementGroupOptionalParams) => PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>

Property Value

(managementGroupId: string, options?: PolicyDefinitionsListByManagementGroupOptionalParams) => PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>