Share via

PolicyRestrictions interface

  • Reference
Package:
@azure/arm-policyinsights

Interface representing a PolicyRestrictions.

Methods

checkAtManagementGroupScope(string, CheckManagementGroupRestrictionsRequest, PolicyRestrictionsCheckAtManagementGroupScopeOptionalParams)

Checks what restrictions Azure Policy will place on resources within a management group.
checkAtResourceGroupScope(string, CheckRestrictionsRequest, PolicyRestrictionsCheckAtResourceGroupScopeOptionalParams)

Checks what restrictions Azure Policy will place on a resource within a resource group. Use this when the resource group the resource will be created in is already known.
checkAtSubscriptionScope(CheckRestrictionsRequest, PolicyRestrictionsCheckAtSubscriptionScopeOptionalParams)

Checks what restrictions Azure Policy will place on a resource within a subscription.

Method Details

checkAtManagementGroupScope(string, CheckManagementGroupRestrictionsRequest, PolicyRestrictionsCheckAtManagementGroupScopeOptionalParams)

Checks what restrictions Azure Policy will place on resources within a management group.

function checkAtManagementGroupScope(managementGroupId: string, parameters: CheckManagementGroupRestrictionsRequest, options?: PolicyRestrictionsCheckAtManagementGroupScopeOptionalParams): Promise<CheckRestrictionsResult>

Parameters

managementGroupId

string

Management group ID.

parameters
CheckManagementGroupRestrictionsRequest

The check policy restrictions parameters.

options
PolicyRestrictionsCheckAtManagementGroupScopeOptionalParams

The options parameters.

Returns

Promise<CheckRestrictionsResult>

checkAtResourceGroupScope(string, CheckRestrictionsRequest, PolicyRestrictionsCheckAtResourceGroupScopeOptionalParams)

Checks what restrictions Azure Policy will place on a resource within a resource group. Use this when the resource group the resource will be created in is already known.

function checkAtResourceGroupScope(resourceGroupName: string, parameters: CheckRestrictionsRequest, options?: PolicyRestrictionsCheckAtResourceGroupScopeOptionalParams): Promise<CheckRestrictionsResult>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

parameters
CheckRestrictionsRequest

The check policy restrictions parameters.

options
PolicyRestrictionsCheckAtResourceGroupScopeOptionalParams

The options parameters.

Returns

Promise<CheckRestrictionsResult>

checkAtSubscriptionScope(CheckRestrictionsRequest, PolicyRestrictionsCheckAtSubscriptionScopeOptionalParams)

Checks what restrictions Azure Policy will place on a resource within a subscription.

function checkAtSubscriptionScope(parameters: CheckRestrictionsRequest, options?: PolicyRestrictionsCheckAtSubscriptionScopeOptionalParams): Promise<CheckRestrictionsResult>

Parameters

parameters
CheckRestrictionsRequest

The check policy restrictions parameters.

options
PolicyRestrictionsCheckAtSubscriptionScopeOptionalParams

The options parameters.

Returns

Promise<CheckRestrictionsResult>