PolicyExemptions interface

Пакет:

@azure/arm-policy

Интерфейс, представляющий PolicyExemptions.

Методы

createOrUpdate(string, string, PolicyExemption, PolicyExemptionsCreateOrUpdateOptionalParams)	Эта операция создает или обновляет исключение политики с заданной областью и именем. Исключения политики применяются ко всем ресурсам, содержащимся в их области. Например, при создании исключения политики в области группы ресурсов для назначения политики на том же или более высоком уровне исключение освобождает все применимые ресурсы в группе ресурсов.
delete(string, string, PolicyExemptionsDeleteOptionalParams)	Эта операция удаляет исключение политики, учитывая его имя и область, в которую она была создана. Область исключения политики является частью своего идентификатора выше "/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName}".
get(string, string, PolicyExemptionsGetOptionalParams)	Эта операция получает одно исключение политики, учитывая его имя и область, в которую она была создана.
list(PolicyExemptionsListOptionalParams)	Эта операция извлекает список всех исключений политики, связанных с данной подпиской, которая соответствует необязательному $filter. Допустимые значения для $filter: "atScope()", "atExactScope()", "excludeExpired()" или "policyAssignmentId eq "{value}". Если $filter не предоставлено, список безфильтрованных политик включает все исключения политики, связанные с подпиской, включая те, которые применяются непосредственно или из групп управления, содержащих указанную подписку, а также любые примененные к объектам, содержащимся в подписке.
listForManagementGroup(string, PolicyExemptionsListForManagementGroupOptionalParams)	Эта операция извлекает список всех исключений политики, применимых к группе управления, соответствующей заданной $filter. Допустимые значения для $filter: "atScope()", "atExactScope()", "excludeExpired()" или "policyAssignmentId eq "{value}". Если указана $filter=atScope(), возвращенный список включает все исключения политик, назначенные группе управления или предкам группы управления.
listForResource(string, string, string, string, string, PolicyExemptionsListForResourceOptionalParams)	Эта операция извлекает список всех исключений политики, связанных с указанным ресурсом в данной группе ресурсов и подписке, которые соответствуют необязательному $filter. Допустимые значения для $filter: "atScope()", "atExactScope()", "excludeExpired()" или "policyAssignmentId eq "{value}". Если $filter не предоставлено, нефильтрованный список включает все исключения политики, связанные с ресурсом, включая те, которые применяются непосредственно или из всех содержащих областей, а также любые примененные к ресурсам, содержащимся в ресурсе. Для идентификации определенного ресурса используются три параметра, а также имя ресурса. Если ресурс не является частью родительского ресурса (более распространенным случаем), родительский путь к ресурсу не должен быть указан (или указан как "). Например, веб-приложение можно указать как ({resourceProviderNamespace} == 'Microsoft.Web', {parentResourcePath} == '', {resourceType} == 'sites', {resourceName} == 'MyWebApp'). Если ресурс является частью родительского ресурса, необходимо предоставить все параметры. Например, DNS-имя виртуальной машины можно указать как ({resourceProviderNamespace} == 'Microsoft.Compute', {parentResourcePath} == 'virtualMachines/MyVirtualMachine', {resourceType} == 'domainNames', {resourceName} == 'MyComputerName'). Удобная альтернатива предоставлению пространства имен и имени типа отдельно заключается в том, чтобы указать оба параметра {resourceType}, формат: ({resourceProviderNamespace} == ', {parentResourcePath} == '', {resourceType} == 'Microsoft.Web/sites', {resourceName} == 'MyWebApp').
listForResourceGroup(string, PolicyExemptionsListForResourceGroupOptionalParams)	Эта операция извлекает список всех исключений политики, связанных с данной группой ресурсов в данной подписке, которая соответствует необязательному $filter. Допустимые значения для $filter: "atScope()", "atExactScope()", "excludeExpired()" или "policyAssignmentId eq "{value}". Если $filter не предоставлено, нефильтрованный список включает все исключения политики, связанные с группой ресурсов, включая те, которые применяются непосредственно или применяются из содержащих областей, а также любые применены к ресурсам, содержащимся в группе ресурсов.
update(string, string, PolicyExemptionUpdate, PolicyExemptionsUpdateOptionalParams)	Эта операция обновляет исключение политики с заданной областью и именем.

Сведения о методе

createOrUpdate(string, string, PolicyExemption, PolicyExemptionsCreateOrUpdateOptionalParams)

Эта операция создает или обновляет исключение политики с заданной областью и именем. Исключения политики применяются ко всем ресурсам, содержащимся в их области. Например, при создании исключения политики в области группы ресурсов для назначения политики на том же или более высоком уровне исключение освобождает все применимые ресурсы в группе ресурсов.

function createOrUpdate(scope: string, policyExemptionName: string, parameters: PolicyExemption, options?: PolicyExemptionsCreateOrUpdateOptionalParams): Promise<PolicyExemption>

Параметры

scope

string

Область исключения политики. Допустимые области: группа управления (формат :/providers/Microsoft.Management/managementGroups/{managementGroup}), подписка (формат '/subscriptions/{subscriptionId}'), группа ресурсов (формат :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', или ресурс (формат: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}"

policyExemptionName

string

Имя удаления политики.

parameters

PolicyExemption

Параметры исключения политики.

options

PolicyExemptionsCreateOrUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<PolicyExemption>

delete(string, string, PolicyExemptionsDeleteOptionalParams)

Эта операция удаляет исключение политики, учитывая его имя и область, в которую она была создана. Область исключения политики является частью своего идентификатора выше "/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName}".

function delete(scope: string, policyExemptionName: string, options?: PolicyExemptionsDeleteOptionalParams): Promise<void>

Параметры

scope

string

Область исключения политики. Допустимые области: группа управления (формат :/providers/Microsoft.Management/managementGroups/{managementGroup}), подписка (формат '/subscriptions/{subscriptionId}'), группа ресурсов (формат :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', или ресурс (формат: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}"

policyExemptionName

string

Имя удаления политики.

options

PolicyExemptionsDeleteOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<void>

get(string, string, PolicyExemptionsGetOptionalParams)

Эта операция получает одно исключение политики, учитывая его имя и область, в которую она была создана.

function get(scope: string, policyExemptionName: string, options?: PolicyExemptionsGetOptionalParams): Promise<PolicyExemption>

Параметры

scope

string

Область исключения политики. Допустимые области: группа управления (формат :/providers/Microsoft.Management/managementGroups/{managementGroup}), подписка (формат '/subscriptions/{subscriptionId}'), группа ресурсов (формат :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', или ресурс (формат: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}"

policyExemptionName

string

Имя удаления политики.

options

PolicyExemptionsGetOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<PolicyExemption>

list(PolicyExemptionsListOptionalParams)

Эта операция извлекает список всех исключений политики, связанных с данной подпиской, которая соответствует необязательному $filter. Допустимые значения для $filter: "atScope()", "atExactScope()", "excludeExpired()" или "policyAssignmentId eq "{value}". Если $filter не предоставлено, список безфильтрованных политик включает все исключения политики, связанные с подпиской, включая те, которые применяются непосредственно или из групп управления, содержащих указанную подписку, а также любые примененные к объектам, содержащимся в подписке.

function list(options?: PolicyExemptionsListOptionalParams): PagedAsyncIterableIterator<PolicyExemption, PolicyExemption[], PageSettings>

Параметры

options

PolicyExemptionsListOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<PolicyExemption, PolicyExemption[], PageSettings>

listForManagementGroup(string, PolicyExemptionsListForManagementGroupOptionalParams)

Эта операция извлекает список всех исключений политики, применимых к группе управления, соответствующей заданной $filter. Допустимые значения для $filter: "atScope()", "atExactScope()", "excludeExpired()" или "policyAssignmentId eq "{value}". Если указана $filter=atScope(), возвращенный список включает все исключения политик, назначенные группе управления или предкам группы управления.

function listForManagementGroup(managementGroupId: string, options?: PolicyExemptionsListForManagementGroupOptionalParams): PagedAsyncIterableIterator<PolicyExemption, PolicyExemption[], PageSettings>

Параметры

managementGroupId

string

Идентификатор группы управления.

options

PolicyExemptionsListForManagementGroupOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<PolicyExemption, PolicyExemption[], PageSettings>

listForResource(string, string, string, string, string, PolicyExemptionsListForResourceOptionalParams)

Эта операция извлекает список всех исключений политики, связанных с указанным ресурсом в данной группе ресурсов и подписке, которые соответствуют необязательному $filter. Допустимые значения для $filter: "atScope()", "atExactScope()", "excludeExpired()" или "policyAssignmentId eq "{value}". Если $filter не предоставлено, нефильтрованный список включает все исключения политики, связанные с ресурсом, включая те, которые применяются непосредственно или из всех содержащих областей, а также любые примененные к ресурсам, содержащимся в ресурсе. Для идентификации определенного ресурса используются три параметра, а также имя ресурса. Если ресурс не является частью родительского ресурса (более распространенным случаем), родительский путь к ресурсу не должен быть указан (или указан как "). Например, веб-приложение можно указать как ({resourceProviderNamespace} == 'Microsoft.Web', {parentResourcePath} == '', {resourceType} == 'sites', {resourceName} == 'MyWebApp'). Если ресурс является частью родительского ресурса, необходимо предоставить все параметры. Например, DNS-имя виртуальной машины можно указать как ({resourceProviderNamespace} == 'Microsoft.Compute', {parentResourcePath} == 'virtualMachines/MyVirtualMachine', {resourceType} == 'domainNames', {resourceName} == 'MyComputerName'). Удобная альтернатива предоставлению пространства имен и имени типа отдельно заключается в том, чтобы указать оба параметра {resourceType}, формат: ({resourceProviderNamespace} == ', {parentResourcePath} == '', {resourceType} == 'Microsoft.Web/sites', {resourceName} == 'MyWebApp').

function listForResource(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, options?: PolicyExemptionsListForResourceOptionalParams): PagedAsyncIterableIterator<PolicyExemption, PolicyExemption[], PageSettings>

Параметры

resourceGroupName

string

Имя группы ресурсов, содержащей ресурс.

resourceProviderNamespace

string

Пространство имен поставщика ресурсов. Например, пространство имен виртуальной машины — Microsoft.Compute (из Microsoft.Compute/virtualMachines)

parentResourcePath

string

Родительский путь к ресурсу. Используйте пустую строку, если нет.

resourceType

string

Имя типа ресурса. Например, имя типа веб-приложения — "сайты" (из Microsoft.Web/sites).

resourceName

string

Имя ресурса.

options

PolicyExemptionsListForResourceOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<PolicyExemption, PolicyExemption[], PageSettings>

listForResourceGroup(string, PolicyExemptionsListForResourceGroupOptionalParams)

Эта операция извлекает список всех исключений политики, связанных с данной группой ресурсов в данной подписке, которая соответствует необязательному $filter. Допустимые значения для $filter: "atScope()", "atExactScope()", "excludeExpired()" или "policyAssignmentId eq "{value}". Если $filter не предоставлено, нефильтрованный список включает все исключения политики, связанные с группой ресурсов, включая те, которые применяются непосредственно или применяются из содержащих областей, а также любые применены к ресурсам, содержащимся в группе ресурсов.

function listForResourceGroup(resourceGroupName: string, options?: PolicyExemptionsListForResourceGroupOptionalParams): PagedAsyncIterableIterator<PolicyExemption, PolicyExemption[], PageSettings>

Параметры

resourceGroupName

string

Имя группы ресурсов, содержащей ресурс.

options

PolicyExemptionsListForResourceGroupOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<PolicyExemption, PolicyExemption[], PageSettings>

update(string, string, PolicyExemptionUpdate, PolicyExemptionsUpdateOptionalParams)

Эта операция обновляет исключение политики с заданной областью и именем.

function update(scope: string, policyExemptionName: string, parameters: PolicyExemptionUpdate, options?: PolicyExemptionsUpdateOptionalParams): Promise<PolicyExemption>

Параметры

scope

string

Область исключения политики. Допустимые области: группа управления (формат :/providers/Microsoft.Management/managementGroups/{managementGroup}), подписка (формат '/subscriptions/{subscriptionId}'), группа ресурсов (формат :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', или ресурс (формат: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}"

policyExemptionName

string

Имя удаления политики.

parameters

PolicyExemptionUpdate

Параметры запроса на исправление исключения политики.

options

PolicyExemptionsUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<PolicyExemption>