共用方式為


PolicyAssignmentsOperations 類別

警告

請勿直接具現化此類別。

相反地,您應該透過 存取下列作業

PolicyClient's

<xref:policy_assignments> 屬性。

繼承
builtins.object
PolicyAssignmentsOperations

建構函式

PolicyAssignmentsOperations(*args, **kwargs)

方法

create

建立或更新原則指派。

此作業會建立或更新具有指定範圍和名稱的原則指派。 原則指派會套用至其範圍內所包含的所有資源。 例如,當您在資源群組範圍指派原則時,該原則會套用至群組中的所有資源。

create_by_id

建立或更新原則指派。

此作業會建立或更新具有指定識別碼的原則指派。 在範圍上所做的原則指派會套用至該範圍中包含的所有資源。 例如,當您將原則指派給套用至群組中所有資源的資源群組時。 原則指派識別碼的格式如下:'{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

刪除原則指派。

此作業會刪除原則指派,並指定其名稱及其建立範圍。 原則指派的範圍是其識別碼在 '/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}' 之前的一部分。

delete_by_id

刪除原則指派。

此作業會刪除具有指定識別碼的原則。 原則指派識別碼的格式如下:'{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

擷取原則指派。

此作業會擷取單一原則指派,並指定其名稱及其建立範圍。

get_by_id

擷取具有指定識別碼的原則指派。

作業會擷取具有指定識別碼的原則指派。 原則指派識別碼的格式如下:'{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

擷取套用至訂用帳戶的所有原則指派。

此作業會擷取與指定訂用帳戶相關聯的所有原則指派清單,該指派符合選擇性指定$filter。 $filter的有效值為:'atScope () ' 或 'policyDefinitionId eq '{value}''。 如果未提供$filter,未篩選的清單會包含與訂用帳戶相關聯的所有原則指派,包括直接套用或套用自包含指定訂用帳戶的管理群組,以及套用至訂用帳戶內包含之物件的任何指派。 如果提供 $filter=atScope () ,則傳回的清單會包含套用至訂用帳戶的所有原則指派,這是未篩選清單中的所有專案,但套用至訂用帳戶內包含的物件除外。 如果提供 $filter=policyDefinitionId eq '{value}' ,則傳回的清單會包含識別碼為 {value} 的原則定義的所有原則指派。

list_for_resource

擷取套用至資源的所有原則指派。

此作業會擷取與指定資源群組中指定資源相關聯的所有原則指派清單,以及符合選擇性指定$filter的訂用帳戶。 $filter的有效值為:'atScope () ' 或 'policyDefinitionId eq '{value}''。 如果未提供$filter,則未篩選清單會包含與資源相關聯的所有原則指派,包括直接套用或從所有包含範圍套用的原則指派,以及套用至資源內所含資源的任何指派。 如果提供 $filter=atScope () ,則傳回的清單會包含套用至資源的所有原則指派,也就是未篩選清單中的所有專案,但套用至資源內含資源的資源除外。 如果提供 $filter=policyDefinitionId eq '{value}' ,則傳回的清單會包含套用至資源的原則定義識別碼為 {value} 的所有原則指派。 三個參數加上資源名稱可用來識別特定資源。 如果資源不是父資源的一部分, (較常見的案例) ,則不應該 (提供父資源路徑,或提供為 '') 。 例如,Web 應用程式可以指定為 ({resourceProviderNamespace} == 'Microsoft.Web', {parentResourcePath} == '', {resourceType} == 'sites', {resourceName} == 'MyWebApp') 。 如果資源是父資源的一部分,則應該提供所有參數。 例如,可以將虛擬機器 DNS 名稱指定為 ({resourceProviderNamespace} == 'Microsoft.Compute', {parentResourcePath} == 'virtualMachines/MyVirtualMachine', {resourceType} == 'domainNames', {resourceName} == 'MyComputerName') 。 另外提供命名空間和類型名稱的便利替代方式是使用 {resourceType} 參數、格式: ({resourceProviderNamespace} == ''、{parentResourcePath} == ''、{resourceType} == ''、{resourceType} == 'Microsoft.Web/sites'、{resourceName} == 'MyWebApp') 。

list_for_resource_group

擷取套用至資源群組的所有原則指派。

此作業會擷取指定訂用帳戶中與指定資源群組相關聯的所有原則指派清單,該指派符合選擇性指定$filter。 $filter的有效值為:'atScope () ' 或 'policyDefinitionId eq '{value}''。 如果未提供$filter,則未篩選清單會包含與資源群組相關聯的所有原則指派,包括直接套用或套用自包含範圍的指派,以及套用至資源群組內所含資源的任何指派。 如果已提供 $filter=atScope () ,則傳回的清單會包含套用至資源群組的所有原則指派,這是未篩選清單中的所有專案,但套用至資源群組內包含的資源除外。 如果提供 $filter=policyDefinitionId eq '{value}' ,則傳回的清單會包含套用至資源群組的原則定義識別碼為 {value} 的所有原則指派。

create

建立或更新原則指派。

此作業會建立或更新具有指定範圍和名稱的原則指派。 原則指派會套用至其範圍內所包含的所有資源。 例如,當您在資源群組範圍指派原則時,該原則會套用至群組中的所有資源。

create(scope: str, policy_assignment_name: str, parameters: _models.PolicyAssignment, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PolicyAssignment

參數

scope
str
必要

原則指派的範圍。 有效範圍包括:管理群組 (格式:'/providers/Microsoft.Management/managementGroups/{managementGroup}') 、 訂閱 (格式:'/subscriptions/{subscriptionId}') 、資源群組 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'或資源 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'。 必要。

policy_assignment_name
str
必要

原則指派的名稱。 必要。

parameters
PolicyAssignmentIO
必要

原則指派的參數。 這是 PolicyAssignment 類型或 IO 類型。 必要。

content_type
str

Body 參數內容類型。 已知值為:'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

PolicyAssignment 或 cls 的結果 (回應)

傳回類型

例外狀況

create_by_id

建立或更新原則指派。

此作業會建立或更新具有指定識別碼的原則指派。 在範圍上所做的原則指派會套用至該範圍中包含的所有資源。 例如,當您將原則指派給套用至群組中所有資源的資源群組時。 原則指派識別碼的格式如下:'{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_by_id(policy_assignment_id: str, parameters: _models.PolicyAssignment, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PolicyAssignment

參數

policy_assignment_id
str
必要

要建立的原則指派識別碼。 使用格式 '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'。 必要。

parameters
PolicyAssignmentIO
必要

原則指派的參數。 這是 PolicyAssignment 類型或 IO 類型。 必要。

content_type
str

Body 參數內容類型。 已知值為:'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

PolicyAssignment 或 cls 的結果 (回應)

傳回類型

例外狀況

delete

刪除原則指派。

此作業會刪除原則指派,並指定其名稱及其建立範圍。 原則指派的範圍是其識別碼在 '/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}' 之前的一部分。

delete(scope: str, policy_assignment_name: str, **kwargs: Any) -> PolicyAssignment | None

參數

scope
str
必要

原則指派的範圍。 有效範圍包括:管理群組 (格式:'/providers/Microsoft.Management/managementGroups/{managementGroup}') 、 訂閱 (格式:'/subscriptions/{subscriptionId}') 、資源群組 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'或資源 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'。 必要。

policy_assignment_name
str
必要

要刪除的原則指派名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

PolicyAssignment 或 None 或 cls (回應的結果)

傳回類型

例外狀況

delete_by_id

刪除原則指派。

此作業會刪除具有指定識別碼的原則。 原則指派識別碼的格式如下:'{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}' (資源) 。

delete_by_id(policy_assignment_id: str, **kwargs: Any) -> PolicyAssignment | None

參數

policy_assignment_id
str
必要

要刪除的原則指派識別碼。 使用格式 '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

PolicyAssignment 或 None 或 cls (回應的結果)

傳回類型

例外狀況

get

擷取原則指派。

此作業會擷取單一原則指派,並指定其名稱及其建立範圍。

get(scope: str, policy_assignment_name: str, **kwargs: Any) -> PolicyAssignment

參數

scope
str
必要

原則指派的範圍。 有效範圍包括:管理群組 (格式:'/providers/Microsoft.Management/managementGroups/{managementGroup}') 、 訂閱 (格式:'/subscriptions/{subscriptionId}') 、資源群組 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'或資源 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'。 必要。

policy_assignment_name
str
必要

要取得的原則指派名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

PolicyAssignment 或 cls 的結果 (回應)

傳回類型

例外狀況

get_by_id

擷取具有指定識別碼的原則指派。

作業會擷取具有指定識別碼的原則指派。 原則指派識別碼的格式如下:'{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}'。

get_by_id(policy_assignment_id: str, **kwargs: Any) -> PolicyAssignment

參數

policy_assignment_id
str
必要

要取得的原則指派識別碼。 使用格式 '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

PolicyAssignment 或 cls 的結果 (回應)

傳回類型

例外狀況

list

擷取套用至訂用帳戶的所有原則指派。

此作業會擷取與指定訂用帳戶相關聯的所有原則指派清單,該指派符合選擇性指定$filter。 $filter的有效值為:'atScope () ' 或 'policyDefinitionId eq '{value}''。 如果未提供$filter,未篩選的清單會包含與訂用帳戶相關聯的所有原則指派,包括直接套用或套用自包含指定訂用帳戶的管理群組,以及套用至訂用帳戶內包含之物件的任何指派。 如果提供 $filter=atScope () ,則傳回的清單會包含套用至訂用帳戶的所有原則指派,這是未篩選清單中的所有專案,但套用至訂用帳戶內包含的物件除外。 如果提供 $filter=policyDefinitionId eq '{value}' ,則傳回的清單會包含識別碼為 {value} 的原則定義的所有原則指派。

list(filter: str | None = None, **kwargs: Any) -> Iterable[PolicyAssignment]

參數

filter
str
必要

要套用至作業的篩選。 $filter的有效值為:'atScope () ' 或 'policyDefinitionId eq '{value}''。 如果未提供$filter,則不會執行篩選。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

Iterator,例如 PolicyAssignment 實例或 cls 的結果 (回應)

傳回類型

例外狀況

list_for_resource

擷取套用至資源的所有原則指派。

此作業會擷取與指定資源群組中指定資源相關聯的所有原則指派清單,以及符合選擇性指定$filter的訂用帳戶。 $filter的有效值為:'atScope () ' 或 'policyDefinitionId eq '{value}''。 如果未提供$filter,則未篩選清單會包含與資源相關聯的所有原則指派,包括直接套用或從所有包含範圍套用的原則指派,以及套用至資源內所含資源的任何指派。 如果提供 $filter=atScope () ,則傳回的清單會包含套用至資源的所有原則指派,也就是未篩選清單中的所有專案,但套用至資源內含資源的資源除外。 如果提供 $filter=policyDefinitionId eq '{value}' ,則傳回的清單會包含套用至資源的原則定義識別碼為 {value} 的所有原則指派。 三個參數加上資源名稱可用來識別特定資源。 如果資源不是父資源的一部分, (較常見的案例) ,則不應該 (提供父資源路徑,或提供為 '') 。 例如,Web 應用程式可以指定為 ({resourceProviderNamespace} == 'Microsoft.Web', {parentResourcePath} == '', {resourceType} == 'sites', {resourceName} == 'MyWebApp') 。 如果資源是父資源的一部分,則應該提供所有參數。 例如,可以將虛擬機器 DNS 名稱指定為 ({resourceProviderNamespace} == 'Microsoft.Compute', {parentResourcePath} == 'virtualMachines/MyVirtualMachine', {resourceType} == 'domainNames', {resourceName} == 'MyComputerName') 。 另外提供命名空間和類型名稱的便利替代方式是使用 {resourceType} 參數、格式: ({resourceProviderNamespace} == ''、{parentResourcePath} == ''、{resourceType} == ''、{resourceType} == 'Microsoft.Web/sites'、{resourceName} == 'MyWebApp') 。

list_for_resource(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, filter: str | None = None, **kwargs: Any) -> Iterable[PolicyAssignment]

參數

resource_group_name
str
必要

包含資源的資源組名。 必要。

resource_provider_namespace
str
必要

資源提供者的命名空間。 例如,虛擬機器的命名空間是 Microsoft.Compute/virtualMachines) 的 Microsoft.Compute (。 必要。

parent_resource_path
str
必要

父資源路徑。 如果沒有,請使用空字串。 必要。

resource_type
str
必要

資源類型名稱。 例如,Web 應用程式的類型名稱是 Microsoft.Web/sites) (。 必要。

resource_name
str
必要

資源名稱。 必要。

filter
str
必要

要套用至作業的篩選。 $filter的有效值為:'atScope () ' 或 'policyDefinitionId eq '{value}''。 如果未提供$filter,則不會執行篩選。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

Iterator,例如 PolicyAssignment 實例或 cls 的結果 (回應)

傳回類型

例外狀況

list_for_resource_group

擷取套用至資源群組的所有原則指派。

此作業會擷取指定訂用帳戶中與指定資源群組相關聯的所有原則指派清單,該指派符合選擇性指定$filter。 $filter的有效值為:'atScope () ' 或 'policyDefinitionId eq '{value}''。 如果未提供$filter,則未篩選清單會包含與資源群組相關聯的所有原則指派,包括直接套用或套用自包含範圍的指派,以及套用至資源群組內所含資源的任何指派。 如果已提供 $filter=atScope () ,則傳回的清單會包含套用至資源群組的所有原則指派,這是未篩選清單中的所有專案,但套用至資源群組內包含的資源除外。 如果提供 $filter=policyDefinitionId eq '{value}' ,則傳回的清單會包含套用至資源群組的原則定義識別碼為 {value} 的所有原則指派。

list_for_resource_group(resource_group_name: str, filter: str | None = None, **kwargs: Any) -> Iterable[PolicyAssignment]

參數

resource_group_name
str
必要

包含原則指派的資源群組名稱。 必要。

filter
str
必要

要套用至作業的篩選。 $filter的有效值為:'atScope () ' 或 'policyDefinitionId eq '{value}''。 如果未提供$filter,則不會執行篩選。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

Iterator,例如 PolicyAssignment 實例或 cls 的結果 (回應)

傳回類型

例外狀況

屬性

models

models = <module 'azure.mgmt.resource.policy.v2019_06_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\policy\\v2019_06_01\\models\\__init__.py'>