PolicySetDefinitionsOperations interface

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

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

Property Value

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

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

Property Value

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

Property Value

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

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

Property Value

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

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

Property Value

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

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

Property Value

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

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

Property Value

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

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

Property Value

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

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

Property Value

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

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

Property Value