PolicyAssignmentsOperations クラス

警告

このクラスを直接インスタンス化しないでください。

代わりに、次の操作にアクセスする必要があります。

PolicyClient's

<xref:policy_assignments> 属性を使用する。

継承

builtins.object

PolicyAssignmentsOperations

コンストラクター

PolicyAssignmentsOperations(*args, **kwargs)

メソッド

create	ポリシーの割り当てを作成または更新します。 この操作では、指定されたスコープと名前を使用してポリシーの割り当てを作成または更新します。 ポリシー割り当ては、スコープ内に含まれるすべてのリソースに適用されます。 たとえば、リソース グループ スコープでポリシーを割り当てると、そのポリシーはグループ内のすべてのリソースに適用されます。
create_by_id	ポリシーの割り当てを作成または更新します。 この操作では、指定された ID を使用してポリシーの割り当てを作成または更新します。 スコープに対して行われたポリシー割り当ては、そのスコープに含まれるすべてのリソースに適用されます。 たとえば、リソース グループにポリシーを割り当てると、そのポリシーはグループ内のすべてのリソースに適用されます。 ポリシー割り当て 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}' の前の ID の一部です。
delete_by_id	ポリシーの割り当てを削除します。 この操作により、指定された ID を持つポリシーが削除されます。 ポリシー割り当て 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}' (resource)。
get	ポリシーの割り当てを取得します。 この操作では、名前と作成されたスコープを指定して、1 つのポリシー割り当てを取得します。
get_by_id	指定された ID を持つポリシーの割り当てを取得します。 操作は、指定された ID を持つポリシーの割り当てを取得します。 ポリシー割り当て 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}' が指定されている場合、返されるリストには、ID が {value} であるポリシー定義のすべてのポリシー割り当てが含まれます。
list_for_resource	リソースに適用されるすべてのポリシー割り当てを取得します。 この操作では、指定したリソース グループ内の指定したリソースに関連付けられているすべてのポリシー割り当てと、オプションの指定した$filterに一致するサブスクリプションの一覧を取得します。 $filterの有効な値は、'atScope()' または 'policyDefinitionId eq '{value}' です。 $filterが指定されていない場合、フィルター処理されていないリストには、リソースに関連付けられているすべてのポリシー割り当て (直接または含まれるすべてのスコープから適用されるもの、およびリソース内に含まれるリソースに適用されるものも含まれます) が含まれます。 $filter=atScope() が指定されている場合、返されるリストには、リソースに適用されるすべてのポリシー割り当てが含まれます。これは、リソース内に含まれるリソースに適用されるものを除き、フィルター処理されていないリスト内のすべてです。 $filter=policyDefinitionId eq '{value}' が指定されている場合、返されるリストには、リソースに適用される ID が {value} であるポリシー定義のすべてのポリシー割り当てが含まれます。 特定のリソースを識別するために、3 つのパラメーターとリソース名が使用されます。 リソースが親リソースの一部でない場合 (より一般的なケース)、親リソース パスを指定 (または '' として指定) しないでください。 たとえば、Web アプリを ({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_for_resource_group	リソース グループに適用されるすべてのポリシー割り当てを取得します。 この操作により、指定したサブスクリプション内の特定のリソース グループに関連付けられているすべてのポリシー割り当ての一覧が取得され、省略可能な特定の$filterに一致します。 $filterの有効な値は、'atScope()' または 'policyDefinitionId eq '{value}' です。 $filterが指定されていない場合、フィルター処理されていないリストには、リソース グループに関連付けられているすべてのポリシー割り当て (直接適用または含まれているスコープから適用されるもの、およびリソース グループ内に含まれるリソースに適用されるものも含まれます) が含まれます。 $filter=atScope() が指定されている場合、返される一覧には、リソース グループに適用されるすべてのポリシー割り当てが含まれます。これは、リソース グループ内に含まれるリソースに適用されるものを除き、フィルター処理されていない一覧のすべてです。 $filter=policyDefinitionId eq '{value}' が指定されている場合、返されるリストには、リソース グループに適用される ID が {value} であるポリシー定義のすべてのポリシー割り当てが含まれます。

create

ポリシーの割り当てを作成または更新します。

この操作では、指定されたスコープと名前を使用してポリシーの割り当てを作成または更新します。 ポリシー割り当ては、スコープ内に含まれるすべてのリソースに適用されます。 たとえば、リソース グループ スコープでポリシーを割り当てると、そのポリシーはグループ内のすべてのリソースに適用されます。

async 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

PolicyAssignment または IO

必須

ポリシー割り当てのパラメーター。 PolicyAssignment 型または IO 型のいずれかです。 必須。

content_type

str

Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。

cls

callable

直接応答が渡されるカスタム型または関数

戻り値

PolicyAssignment または cls(response) の結果

の戻り値の型 :

PolicyAssignment

例外

HttpResponseError

create_by_id

ポリシーの割り当てを作成または更新します。

この操作では、指定された ID を使用してポリシーの割り当てを作成または更新します。 スコープに対して行われたポリシー割り当ては、そのスコープに含まれるすべてのリソースに適用されます。 たとえば、リソース グループにポリシーを割り当てると、そのポリシーはグループ内のすべてのリソースに適用されます。 ポリシー割り当て 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}'

async create_by_id(policy_assignment_id: str, parameters: _models.PolicyAssignment, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PolicyAssignment

パラメーター

policy_assignment_id

str

必須

作成するポリシー割り当ての ID。 '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}' の形式を使用します。 必須。

parameters

PolicyAssignment または IO

必須

ポリシー割り当てのパラメーター。 PolicyAssignment 型または IO 型のいずれかです。 必須。

content_type

str

Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。

cls

callable

直接応答が渡されるカスタム型または関数

戻り値

PolicyAssignment または cls(response) の結果

の戻り値の型 :

PolicyAssignment

例外

HttpResponseError

delete

ポリシーの割り当てを削除します。

この操作は、ポリシー割り当ての名前と作成されたスコープを指定して、削除します。 ポリシー割り当てのスコープは、'/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}' の前の ID の一部です。

async 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(response) の結果

の戻り値の型 :

PolicyAssignment,

None

例外

HttpResponseError

delete_by_id

ポリシーの割り当てを削除します。

この操作により、指定された ID を持つポリシーが削除されます。 ポリシー割り当て 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}' (resource)。

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

パラメーター

policy_assignment_id

str

必須

削除するポリシー割り当ての ID。 '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}' の形式を使用します。 必須。

cls

callable

直接応答が渡されるカスタム型または関数

戻り値

PolicyAssignment または None、または cls(response) の結果

の戻り値の型 :

PolicyAssignment,

None

例外

HttpResponseError

get

ポリシーの割り当てを取得します。

この操作では、名前と作成されたスコープを指定して、1 つのポリシー割り当てを取得します。

async 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(response) の結果

の戻り値の型 :

PolicyAssignment

例外

HttpResponseError

get_by_id

指定された ID を持つポリシーの割り当てを取得します。

操作は、指定された ID を持つポリシーの割り当てを取得します。 ポリシー割り当て 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}'

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

パラメーター

policy_assignment_id

str

必須

取得するポリシー割り当ての ID。 '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}' の形式を使用します。 必須。

cls

callable

直接応答が渡されるカスタム型または関数

戻り値

PolicyAssignment または cls(response) の結果

の戻り値の型 :

PolicyAssignment

例外

HttpResponseError

list

サブスクリプションに適用されるすべてのポリシー割り当てを取得します。

この操作では、指定されたサブスクリプションに関連付けられているすべてのポリシー割り当ての一覧が、指定されたオプションの$filterに一致します。 $filterの有効な値は、'atScope()' または 'policyDefinitionId eq '{value}' です。 $filterが指定されていない場合、フィルター処理されていない一覧には、サブスクリプションに関連付けられているすべてのポリシー割り当て (指定されたサブスクリプションを含む直接または管理グループから適用されるもの、およびサブスクリプション内に含まれるオブジェクトに適用されたものを含む) が含まれます。 $filter=atScope() が指定されている場合、返される一覧には、サブスクリプションに適用されるすべてのポリシー割り当てが含まれます。これは、サブスクリプション内に含まれるオブジェクトに適用されるものを除き、フィルター処理されていないリスト内のすべてです。 $filter=policyDefinitionId eq '{value}' が指定されている場合、返されるリストには、ID が {value} であるポリシー定義のすべてのポリシー割り当てが含まれます。

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

パラメーター

filter

str

必須

操作に適用するフィルター。 $filterの有効な値は、'atScope()' または 'policyDefinitionId eq '{value}' です。 $filterが指定されていない場合、フィルター処理は実行されません。 既定値は [なし] です。

cls

callable

直接応答が渡されるカスタム型または関数

戻り値

PolicyAssignment または cls(response) の結果のいずれかのインスタンスのような反復子

の戻り値の型 :

AsyncItemPaged[PolicyAssignment]

例外

HttpResponseError

list_for_resource

リソースに適用されるすべてのポリシー割り当てを取得します。

この操作では、指定したリソース グループ内の指定したリソースに関連付けられているすべてのポリシー割り当てと、オプションの指定した$filterに一致するサブスクリプションの一覧を取得します。 $filterの有効な値は、'atScope()' または 'policyDefinitionId eq '{value}' です。 $filterが指定されていない場合、フィルター処理されていないリストには、リソースに関連付けられているすべてのポリシー割り当て (直接または含まれるすべてのスコープから適用されるもの、およびリソース内に含まれるリソースに適用されるものも含まれます) が含まれます。 $filter=atScope() が指定されている場合、返されるリストには、リソースに適用されるすべてのポリシー割り当てが含まれます。これは、リソース内に含まれるリソースに適用されるものを除き、フィルター処理されていないリスト内のすべてです。 $filter=policyDefinitionId eq '{value}' が指定されている場合、返されるリストには、リソースに適用される ID が {value} であるポリシー定義のすべてのポリシー割り当てが含まれます。 特定のリソースを識別するために、3 つのパラメーターとリソース名が使用されます。 リソースが親リソースの一部でない場合 (より一般的なケース)、親リソース パスを指定 (または '' として指定) しないでください。 たとえば、Web アプリを ({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_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) -> AsyncIterable[PolicyAssignment]

パラメーター

resource_group_name

str

必須

リソースを含むリソース グループの名前。 必須。

resource_provider_namespace

str

必須

リソース プロバイダーの名前空間。 たとえば、仮想マシンの名前空間は Microsoft.Compute (Microsoft.Compute/virtualMachines) です。 必須。

parent_resource_path

str

必須

親リソース パス。 空の文字列がない場合は、空の文字列を使用します。 必須。

resource_type

str

必須

リソースの種類名。 たとえば、Web アプリの型名は 'sites' です (Microsoft.Web/sites から)。 必須。

resource_name

str

必須

リソースの名前。 必須。

filter

str

必須

操作に適用するフィルター。 $filterの有効な値は、'atScope()' または 'policyDefinitionId eq '{value}' です。 $filterが指定されていない場合、フィルター処理は実行されません。 既定値は [なし] です。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

PolicyAssignment のインスタンスや cls(response) の結果のような反復子

の戻り値の型 :

AsyncItemPaged[PolicyAssignment]

例外

HttpResponseError

list_for_resource_group

リソース グループに適用されるすべてのポリシー割り当てを取得します。

この操作により、指定したサブスクリプション内の特定のリソース グループに関連付けられているすべてのポリシー割り当ての一覧が取得され、省略可能な特定の$filterに一致します。 $filterの有効な値は、'atScope()' または 'policyDefinitionId eq '{value}' です。 $filterが指定されていない場合、フィルター処理されていないリストには、リソース グループに関連付けられているすべてのポリシー割り当て (直接適用または含まれているスコープから適用されるもの、およびリソース グループ内に含まれるリソースに適用されるものも含まれます) が含まれます。 $filter=atScope() が指定されている場合、返される一覧には、リソース グループに適用されるすべてのポリシー割り当てが含まれます。これは、リソース グループ内に含まれるリソースに適用されるものを除き、フィルター処理されていない一覧のすべてです。 $filter=policyDefinitionId eq '{value}' が指定されている場合、返されるリストには、リソース グループに適用される ID が {value} であるポリシー定義のすべてのポリシー割り当てが含まれます。

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

パラメーター

resource_group_name

str

必須

ポリシー割り当てを含むリソース グループの名前。 必須。

filter

str

必須

操作に適用するフィルター。 $filterの有効な値は、'atScope()' または 'policyDefinitionId eq '{value}' です。 $filterが指定されていない場合、フィルター処理は実行されません。 既定値は [なし] です。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

PolicyAssignment のインスタンスや cls(response) の結果のような反復子

の戻り値の型 :

AsyncItemPaged[PolicyAssignment]

例外

HttpResponseError

属性

models

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