PolicyAssignments interface
Интерфейс, представляющий PolicyAssignments.
Методы
create(string, string, Policy |
Эта операция создает или обновляет назначение политики с заданной областью и именем. Назначения политик применяются ко всем ресурсам, содержащимся в их области. Например, при назначении политики в области группы ресурсов эта политика применяется ко всем ресурсам в группе. |
create |
Эта операция создает или обновляет назначение политики с заданным идентификатором. Назначения политик, выполненные в области, применяются ко всем ресурсам, содержащимся в этой области. Например, при назначении политики группе ресурсов эта политика применяется ко всем ресурсам в группе. Идентификаторы назначений политик имеют следующий формат: "{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}". Допустимые области: группа управления (формат:/providers/Microsoft.Management/managementGroups/{managementGroup}), подписка (формат:/subscriptions/{subscriptionId}), группа ресурсов (формат:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}, или (формат: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}". |
delete(string, string, Policy |
Эта операция удаляет назначение политики с учетом его имени и области, в которую оно было создано. Область назначения политики является частью ее идентификатора, предшествующего "/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}". |
delete |
Эта операция удаляет политику с указанным идентификатором. Идентификаторы назначений политик имеют следующий формат: "{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}". Допустимые форматы для {scope}: "/providers/Microsoft.Management/managementGroups/{managementGroup}" (группа управления), "/subscriptions/{subscriptionId}" (подписка), "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}. (группа ресурсов) или /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}" (ресурс). |
get(string, string, Policy |
Эта операция получает одно назначение политики, учитывая его имя и область, в которую она была создана. |
get |
Операция получает назначение политики с заданным идентификатором. Идентификаторы назначений политик имеют следующий формат: "{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}". Допустимые области: группа управления (формат:/providers/Microsoft.Management/managementGroups/{managementGroup}), подписка (формат:/subscriptions/{subscriptionId}), группа ресурсов (формат:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}, или (формат: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}". |
list(Policy |
Эта операция извлекает список всех назначений политик, связанных с данной подпиской, которые соответствуют необязательной заданной $filter. Допустимые значения для $filter: "atScope()", "atExactScope()" или "policyDefinitionId eq "{value}". Если $filter не указан, список нефильтрованных включает все назначения политик, связанные с подпиской, включая те, которые применяются непосредственно или из групп управления, содержащих указанную подписку, а также любые назначения, применяемые к объектам, содержащимся в подписке. Если указан $filter=atScope(), возвращаемый список включает все назначения политик, применяемые к подписке, то есть все в неотфильтрованном списке, кроме тех, которые применяются к объектам, содержащимся в подписке. Если указан $filter=atExactScope(), возвращенный список включает только все назначения политик, которые указаны в подписке. Если указан $filter=policyDefinitionId eq "{value}", возвращаемый список включает все назначения политики определения политики, идентификатором которых является {value}. |
list |
Эта операция извлекает список всех назначений политик, применимых к группе управления, которые соответствуют заданному $filter. Допустимые значения для $filter: "atScope()", "atExactScope()" или "policyDefinitionId eq "{value}". Если указан $filter=atScope(), возвращаемый список включает все назначения политик, назначенные группе управления или предкам группы управления. Если указан $filter=atExactScope(), возвращаемый список включает только все назначения политик в группе управления. Если указан $filter=policyDefinitionId eq "{value}", возвращаемый список включает все назначения политики определения политики, идентификатором которых является {value}, применяемые к группе управления. |
list |
Эта операция извлекает список всех назначений политик, связанных с указанным ресурсом в заданной группе ресурсов и подписке, которые соответствуют необязательному $filter. Допустимые значения для $filter: "atScope()", "atExactScope()" или "policyDefinitionId eq "{value}". Если $filter не указан, список нефильтрованных включает все назначения политик, связанные с ресурсом, включая те, которые применяются непосредственно или из всех содержащихся областей, а также любые назначения, применяемые к ресурсам, содержащимся в ресурсе. Если указан $filter=atScope(), возвращаемый список включает все назначения политик, применяемые к ресурсу, то есть все в неотфильтрованном списке, кроме тех, которые применяются к ресурсам, содержащимся в ресурсе. Если указан $filter=atExactScope(), возвращаемый список включает только все назначения политик на уровне ресурсов. Если указан $filter=policyDefinitionId eq "{value}", возвращаемый список включает все назначения политики определения политики, идентификатором которых является {value}, применяемые к ресурсу. Для идентификации конкретного ресурса используются три параметра и имя ресурса. Если ресурс не является частью родительского ресурса (более распространенный случай), путь к родительскому ресурсу не следует предоставлять (или предоставлять как ""). Например, веб-приложение можно указать как ({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'). |
list |
Эта операция извлекает список всех назначений политик, связанных с заданной группой ресурсов в заданной подписке, которые соответствуют необязательному заданному $filter. Допустимые значения для $filter: "atScope()", "atExactScope()" или "policyDefinitionId eq "{value}". Если $filter не указан, список нефильтрованных содержит все назначения политик, связанные с группой ресурсов, включая те, которые применяются непосредственно или из содержащих областей, а также все назначения, применяемые к ресурсам, содержащимся в группе ресурсов. Если указан $filter=atScope(), возвращаемый список включает все назначения политик, применяемые к группе ресурсов, которая является всем в нефильтрованном списке, кроме тех, которые применяются к ресурсам, содержащимся в группе ресурсов. Если указан $filter=atExactScope(), возвращаемый список включает только все назначения политик в группе ресурсов. Если указан $filter=policyDefinitionId eq "{value}", возвращаемый список включает все назначения политики определения политики, идентификатором которых является {value}, применяемые к группе ресурсов. |
update(string, string, Policy |
Эта операция обновляет назначение политики с заданной областью и именем. Назначения политик применяются ко всем ресурсам, содержащимся в их области. Например, при назначении политики в области группы ресурсов эта политика применяется ко всем ресурсам в группе. |
update |
Эта операция обновляет назначение политики с помощью заданного идентификатора. Назначения политик, выполненные в области, применяются ко всем ресурсам, содержащимся в этой области. Например, при назначении политики группе ресурсов эта политика применяется ко всем ресурсам в группе. Идентификаторы назначений политик имеют следующий формат: "{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}". Допустимые области: группа управления (формат:/providers/Microsoft.Management/managementGroups/{managementGroup}), подписка (формат:/subscriptions/{subscriptionId}), группа ресурсов (формат:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}, или (формат: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}". |
Сведения о методе
create(string, string, PolicyAssignment, PolicyAssignmentsCreateOptionalParams)
Эта операция создает или обновляет назначение политики с заданной областью и именем. Назначения политик применяются ко всем ресурсам, содержащимся в их области. Например, при назначении политики в области группы ресурсов эта политика применяется ко всем ресурсам в группе.
function create(scope: string, policyAssignmentName: string, parameters: PolicyAssignment, options?: PolicyAssignmentsCreateOptionalParams): Promise<PolicyAssignment>
Параметры
- scope
-
string
Область назначения политики. Допустимые области: группа управления (формат:/providers/Microsoft.Management/managementGroups/{managementGroup}), подписка (формат:/subscriptions/{subscriptionId}), группа ресурсов (формат:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}, или ресурс (формат: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}".
- policyAssignmentName
-
string
Имя назначения политики.
- parameters
- PolicyAssignment
Параметры для назначения политики.
Параметры параметров.
Возвращаемое значение
Promise<PolicyAssignment>
createById(string, PolicyAssignment, PolicyAssignmentsCreateByIdOptionalParams)
Эта операция создает или обновляет назначение политики с заданным идентификатором. Назначения политик, выполненные в области, применяются ко всем ресурсам, содержащимся в этой области. Например, при назначении политики группе ресурсов эта политика применяется ко всем ресурсам в группе. Идентификаторы назначений политик имеют следующий формат: "{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}". Допустимые области: группа управления (формат:/providers/Microsoft.Management/managementGroups/{managementGroup}), подписка (формат:/subscriptions/{subscriptionId}), группа ресурсов (формат:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}, или (формат: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}".
function createById(policyAssignmentId: string, parameters: PolicyAssignment, options?: PolicyAssignmentsCreateByIdOptionalParams): Promise<PolicyAssignment>
Параметры
- policyAssignmentId
-
string
Идентификатор создаваемого назначения политики. Используйте формат "{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}".
- parameters
- PolicyAssignment
Параметры для назначения политики.
Параметры параметров.
Возвращаемое значение
Promise<PolicyAssignment>
delete(string, string, PolicyAssignmentsDeleteOptionalParams)
Эта операция удаляет назначение политики с учетом его имени и области, в которую оно было создано. Область назначения политики является частью ее идентификатора, предшествующего "/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}".
function delete(scope: string, policyAssignmentName: string, options?: PolicyAssignmentsDeleteOptionalParams): Promise<PolicyAssignment>
Параметры
- scope
-
string
Область назначения политики. Допустимые области: группа управления (формат:/providers/Microsoft.Management/managementGroups/{managementGroup}), подписка (формат:/subscriptions/{subscriptionId}), группа ресурсов (формат:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}, или ресурс (формат: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}".
- policyAssignmentName
-
string
Имя удаляемого назначения политики.
Параметры параметров.
Возвращаемое значение
Promise<PolicyAssignment>
deleteById(string, PolicyAssignmentsDeleteByIdOptionalParams)
Эта операция удаляет политику с указанным идентификатором. Идентификаторы назначений политик имеют следующий формат: "{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}". Допустимые форматы для {scope}: "/providers/Microsoft.Management/managementGroups/{managementGroup}" (группа управления), "/subscriptions/{subscriptionId}" (подписка), "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}. (группа ресурсов) или /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}" (ресурс).
function deleteById(policyAssignmentId: string, options?: PolicyAssignmentsDeleteByIdOptionalParams): Promise<PolicyAssignment>
Параметры
- policyAssignmentId
-
string
Идентификатор удаляемого назначения политики. Используйте формат "{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}".
Параметры параметров.
Возвращаемое значение
Promise<PolicyAssignment>
get(string, string, PolicyAssignmentsGetOptionalParams)
Эта операция получает одно назначение политики, учитывая его имя и область, в которую она была создана.
function get(scope: string, policyAssignmentName: string, options?: PolicyAssignmentsGetOptionalParams): Promise<PolicyAssignment>
Параметры
- scope
-
string
Область назначения политики. Допустимые области: группа управления (формат:/providers/Microsoft.Management/managementGroups/{managementGroup}), подписка (формат:/subscriptions/{subscriptionId}), группа ресурсов (формат:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}, или ресурс (формат: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}".
- policyAssignmentName
-
string
Имя получаемого назначения политики.
Параметры параметров.
Возвращаемое значение
Promise<PolicyAssignment>
getById(string, PolicyAssignmentsGetByIdOptionalParams)
Операция получает назначение политики с заданным идентификатором. Идентификаторы назначений политик имеют следующий формат: "{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}". Допустимые области: группа управления (формат:/providers/Microsoft.Management/managementGroups/{managementGroup}), подписка (формат:/subscriptions/{subscriptionId}), группа ресурсов (формат:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}, или (формат: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}".
function getById(policyAssignmentId: string, options?: PolicyAssignmentsGetByIdOptionalParams): Promise<PolicyAssignment>
Параметры
- policyAssignmentId
-
string
Идентификатор получаемого назначения политики. Используйте формат "{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}".
Параметры параметров.
Возвращаемое значение
Promise<PolicyAssignment>
list(PolicyAssignmentsListOptionalParams)
Эта операция извлекает список всех назначений политик, связанных с данной подпиской, которые соответствуют необязательной заданной $filter. Допустимые значения для $filter: "atScope()", "atExactScope()" или "policyDefinitionId eq "{value}". Если $filter не указан, список нефильтрованных включает все назначения политик, связанные с подпиской, включая те, которые применяются непосредственно или из групп управления, содержащих указанную подписку, а также любые назначения, применяемые к объектам, содержащимся в подписке. Если указан $filter=atScope(), возвращаемый список включает все назначения политик, применяемые к подписке, то есть все в неотфильтрованном списке, кроме тех, которые применяются к объектам, содержащимся в подписке. Если указан $filter=atExactScope(), возвращенный список включает только все назначения политик, которые указаны в подписке. Если указан $filter=policyDefinitionId eq "{value}", возвращаемый список включает все назначения политики определения политики, идентификатором которых является {value}.
function list(options?: PolicyAssignmentsListOptionalParams): PagedAsyncIterableIterator<PolicyAssignment, PolicyAssignment[], PageSettings>
Параметры
Параметры параметров.
Возвращаемое значение
listForManagementGroup(string, PolicyAssignmentsListForManagementGroupOptionalParams)
Эта операция извлекает список всех назначений политик, применимых к группе управления, которые соответствуют заданному $filter. Допустимые значения для $filter: "atScope()", "atExactScope()" или "policyDefinitionId eq "{value}". Если указан $filter=atScope(), возвращаемый список включает все назначения политик, назначенные группе управления или предкам группы управления. Если указан $filter=atExactScope(), возвращаемый список включает только все назначения политик в группе управления. Если указан $filter=policyDefinitionId eq "{value}", возвращаемый список включает все назначения политики определения политики, идентификатором которых является {value}, применяемые к группе управления.
function listForManagementGroup(managementGroupId: string, options?: PolicyAssignmentsListForManagementGroupOptionalParams): PagedAsyncIterableIterator<PolicyAssignment, PolicyAssignment[], PageSettings>
Параметры
- managementGroupId
-
string
Идентификатор группы управления.
Параметры параметров.
Возвращаемое значение
listForResource(string, string, string, string, string, PolicyAssignmentsListForResourceOptionalParams)
Эта операция извлекает список всех назначений политик, связанных с указанным ресурсом в заданной группе ресурсов и подписке, которые соответствуют необязательному $filter. Допустимые значения для $filter: "atScope()", "atExactScope()" или "policyDefinitionId eq "{value}". Если $filter не указан, список нефильтрованных включает все назначения политик, связанные с ресурсом, включая те, которые применяются непосредственно или из всех содержащихся областей, а также любые назначения, применяемые к ресурсам, содержащимся в ресурсе. Если указан $filter=atScope(), возвращаемый список включает все назначения политик, применяемые к ресурсу, то есть все в неотфильтрованном списке, кроме тех, которые применяются к ресурсам, содержащимся в ресурсе. Если указан $filter=atExactScope(), возвращаемый список включает только все назначения политик на уровне ресурсов. Если указан $filter=policyDefinitionId eq "{value}", возвращаемый список включает все назначения политики определения политики, идентификатором которых является {value}, применяемые к ресурсу. Для идентификации конкретного ресурса используются три параметра и имя ресурса. Если ресурс не является частью родительского ресурса (более распространенный случай), путь к родительскому ресурсу не следует предоставлять (или предоставлять как ""). Например, веб-приложение можно указать как ({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?: PolicyAssignmentsListForResourceOptionalParams): PagedAsyncIterableIterator<PolicyAssignment, PolicyAssignment[], PageSettings>
Параметры
- resourceGroupName
-
string
Имя группы ресурсов, содержащей ресурс.
- resourceProviderNamespace
-
string
Пространство имен поставщика ресурсов. Например, пространство имен виртуальной машины — Microsoft.Compute (из Microsoft.Compute/virtualMachines).
- parentResourcePath
-
string
Путь к родительскому ресурсу. Используйте пустую строку, если ее нет.
- resourceType
-
string
Имя типа ресурса. Например, имя типа веб-приложения — sites (из Microsoft.Web/sites).
- resourceName
-
string
Имя ресурса.
Параметры параметров.
Возвращаемое значение
listForResourceGroup(string, PolicyAssignmentsListForResourceGroupOptionalParams)
Эта операция извлекает список всех назначений политик, связанных с заданной группой ресурсов в заданной подписке, которые соответствуют необязательному заданному $filter. Допустимые значения для $filter: "atScope()", "atExactScope()" или "policyDefinitionId eq "{value}". Если $filter не указан, список нефильтрованных содержит все назначения политик, связанные с группой ресурсов, включая те, которые применяются непосредственно или из содержащих областей, а также все назначения, применяемые к ресурсам, содержащимся в группе ресурсов. Если указан $filter=atScope(), возвращаемый список включает все назначения политик, применяемые к группе ресурсов, которая является всем в нефильтрованном списке, кроме тех, которые применяются к ресурсам, содержащимся в группе ресурсов. Если указан $filter=atExactScope(), возвращаемый список включает только все назначения политик в группе ресурсов. Если указан $filter=policyDefinitionId eq "{value}", возвращаемый список включает все назначения политики определения политики, идентификатором которых является {value}, применяемые к группе ресурсов.
function listForResourceGroup(resourceGroupName: string, options?: PolicyAssignmentsListForResourceGroupOptionalParams): PagedAsyncIterableIterator<PolicyAssignment, PolicyAssignment[], PageSettings>
Параметры
- resourceGroupName
-
string
Имя группы ресурсов, содержащей назначения политик.
Параметры параметров.
Возвращаемое значение
update(string, string, PolicyAssignmentUpdate, PolicyAssignmentsUpdateOptionalParams)
Эта операция обновляет назначение политики с заданной областью и именем. Назначения политик применяются ко всем ресурсам, содержащимся в их области. Например, при назначении политики в области группы ресурсов эта политика применяется ко всем ресурсам в группе.
function update(scope: string, policyAssignmentName: string, parameters: PolicyAssignmentUpdate, options?: PolicyAssignmentsUpdateOptionalParams): Promise<PolicyAssignment>
Параметры
- scope
-
string
Область назначения политики. Допустимые области: группа управления (формат:/providers/Microsoft.Management/managementGroups/{managementGroup}), подписка (формат:/subscriptions/{subscriptionId}), группа ресурсов (формат:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}, или ресурс (формат: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}".
- policyAssignmentName
-
string
Имя назначения политики.
- parameters
- PolicyAssignmentUpdate
Параметры для запроса на исправление назначения политики.
Параметры параметров.
Возвращаемое значение
Promise<PolicyAssignment>
updateById(string, PolicyAssignmentUpdate, PolicyAssignmentsUpdateByIdOptionalParams)
Эта операция обновляет назначение политики с помощью заданного идентификатора. Назначения политик, выполненные в области, применяются ко всем ресурсам, содержащимся в этой области. Например, при назначении политики группе ресурсов эта политика применяется ко всем ресурсам в группе. Идентификаторы назначений политик имеют следующий формат: "{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}". Допустимые области: группа управления (формат:/providers/Microsoft.Management/managementGroups/{managementGroup}), подписка (формат:/subscriptions/{subscriptionId}), группа ресурсов (формат:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}, или (формат: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}".
function updateById(policyAssignmentId: string, parameters: PolicyAssignmentUpdate, options?: PolicyAssignmentsUpdateByIdOptionalParams): Promise<PolicyAssignment>
Параметры
- policyAssignmentId
-
string
Идентификатор обновляемого назначения политики. Используйте формат "{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}".
- parameters
- PolicyAssignmentUpdate
Параметры для запроса на исправление назначения политики.
Параметры параметров.
Возвращаемое значение
Promise<PolicyAssignment>