PolicySetDefinitions interface

Package:

@azure/arm-policy

Interface representing a PolicySetDefinitions.

Methods

createOrUpdate(string, PolicySetDefinition, PolicySetDefinitionsCreateOrUpdateOptionalParams)	This operation creates or updates a policy set definition in the given subscription with the given name.
createOrUpdateAtManagementGroup(string, string, PolicySetDefinition, PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams)	This operation creates or updates a policy set definition in the given management group with the given name.
delete(string, PolicySetDefinitionsDeleteOptionalParams)	This operation deletes the policy set definition in the given subscription with the given name.
deleteAtManagementGroup(string, string, PolicySetDefinitionsDeleteAtManagementGroupOptionalParams)	This operation deletes the policy set definition in the given management group with the given name.
get(string, PolicySetDefinitionsGetOptionalParams)	This operation retrieves the policy set definition in the given subscription with the given name.
getAtManagementGroup(string, string, PolicySetDefinitionsGetAtManagementGroupOptionalParams)	This operation retrieves the policy set definition in the given management group with the given name.
getBuiltIn(string, PolicySetDefinitionsGetBuiltInOptionalParams)	This operation retrieves the built-in policy set definition with the given name.
list(PolicySetDefinitionsListOptionalParams)	This operation retrieves a list of all the policy set 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 set 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 set definitions that at the given subscription. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn and Custom. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}.
listBuiltIn(PolicySetDefinitionsListBuiltInOptionalParams)	This operation retrieves a list of all the built-in policy set definitions that match the optional given $filter. If $filter='category -eq {value}' is provided, the returned list only includes all built-in policy set definitions whose category match the {value}.
listByManagementGroup(string, PolicySetDefinitionsListByManagementGroupOptionalParams)	This operation retrieves a list of all the policy set 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 set 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 set definitions that at the given management group. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn and Custom. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}.

Method Details

createOrUpdate(string, PolicySetDefinition, PolicySetDefinitionsCreateOrUpdateOptionalParams)

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

function createOrUpdate(policySetDefinitionName: string, parameters: PolicySetDefinition, options?: PolicySetDefinitionsCreateOrUpdateOptionalParams): Promise<PolicySetDefinition>

Parameters

policySetDefinitionName

string

The name of the policy set definition to create.

parameters

PolicySetDefinition

The policy set definition properties.

options

PolicySetDefinitionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PolicySetDefinition>

createOrUpdateAtManagementGroup(string, string, PolicySetDefinition, PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams)

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

function createOrUpdateAtManagementGroup(policySetDefinitionName: string, managementGroupId: string, parameters: PolicySetDefinition, options?: PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams): Promise<PolicySetDefinition>

Parameters

policySetDefinitionName

string

The name of the policy set definition to create.

managementGroupId

string

The ID of the management group.

parameters

PolicySetDefinition

The policy set definition properties.

options

PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams

The options parameters.

Returns

Promise<PolicySetDefinition>

delete(string, PolicySetDefinitionsDeleteOptionalParams)

This operation deletes the policy set definition in the given subscription with the given name.

function delete(policySetDefinitionName: string, options?: PolicySetDefinitionsDeleteOptionalParams): Promise<void>

Parameters

policySetDefinitionName

string

The name of the policy set definition to delete.

options

PolicySetDefinitionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

deleteAtManagementGroup(string, string, PolicySetDefinitionsDeleteAtManagementGroupOptionalParams)

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

function deleteAtManagementGroup(policySetDefinitionName: string, managementGroupId: string, options?: PolicySetDefinitionsDeleteAtManagementGroupOptionalParams): Promise<void>

Parameters

policySetDefinitionName

string

The name of the policy set definition to delete.

managementGroupId

string

The ID of the management group.

options

PolicySetDefinitionsDeleteAtManagementGroupOptionalParams

The options parameters.

Returns

Promise<void>

get(string, PolicySetDefinitionsGetOptionalParams)

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

function get(policySetDefinitionName: string, options?: PolicySetDefinitionsGetOptionalParams): Promise<PolicySetDefinition>

Parameters

policySetDefinitionName

string

The name of the policy set definition to get.

options

PolicySetDefinitionsGetOptionalParams

The options parameters.

Returns

Promise<PolicySetDefinition>

getAtManagementGroup(string, string, PolicySetDefinitionsGetAtManagementGroupOptionalParams)

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

function getAtManagementGroup(policySetDefinitionName: string, managementGroupId: string, options?: PolicySetDefinitionsGetAtManagementGroupOptionalParams): Promise<PolicySetDefinition>

Parameters

policySetDefinitionName

string

The name of the policy set definition to get.

managementGroupId

string

The ID of the management group.

options

PolicySetDefinitionsGetAtManagementGroupOptionalParams

The options parameters.

Returns

Promise<PolicySetDefinition>

getBuiltIn(string, PolicySetDefinitionsGetBuiltInOptionalParams)

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

function getBuiltIn(policySetDefinitionName: string, options?: PolicySetDefinitionsGetBuiltInOptionalParams): Promise<PolicySetDefinition>

Parameters

policySetDefinitionName

string

The name of the policy set definition to get.

options

PolicySetDefinitionsGetBuiltInOptionalParams

The options parameters.

Returns

Promise<PolicySetDefinition>

list(PolicySetDefinitionsListOptionalParams)

This operation retrieves a list of all the policy set 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 set 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 set definitions that at the given subscription. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn and Custom. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}.

function list(options?: PolicySetDefinitionsListOptionalParams): PagedAsyncIterableIterator<PolicySetDefinition, PolicySetDefinition[], PageSettings>

Parameters

options

PolicySetDefinitionsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PolicySetDefinition, PolicySetDefinition[], PageSettings>

listBuiltIn(PolicySetDefinitionsListBuiltInOptionalParams)

This operation retrieves a list of all the built-in policy set definitions that match the optional given $filter. If $filter='category -eq {value}' is provided, the returned list only includes all built-in policy set definitions whose category match the {value}.

function listBuiltIn(options?: PolicySetDefinitionsListBuiltInOptionalParams): PagedAsyncIterableIterator<PolicySetDefinition, PolicySetDefinition[], PageSettings>

Parameters

options

PolicySetDefinitionsListBuiltInOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PolicySetDefinition, PolicySetDefinition[], PageSettings>

listByManagementGroup(string, PolicySetDefinitionsListByManagementGroupOptionalParams)

This operation retrieves a list of all the policy set 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 set 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 set definitions that at the given management group. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn and Custom. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}.

function listByManagementGroup(managementGroupId: string, options?: PolicySetDefinitionsListByManagementGroupOptionalParams): PagedAsyncIterableIterator<PolicySetDefinition, PolicySetDefinition[], PageSettings>

Parameters

managementGroupId

string

The ID of the management group.

options

PolicySetDefinitionsListByManagementGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PolicySetDefinition, PolicySetDefinition[], PageSettings>