RoleAssignmentsOperations クラス

警告

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

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

AuthorizationManagementClient's

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

継承

builtins.object

RoleAssignmentsOperations

コンストラクター

RoleAssignmentsOperations(*args, **kwargs)

メソッド

create	スコープと名前でロールの割り当てを作成または更新します。
create_by_id	ID でロールの割り当てを作成または更新します。
delete	スコープと名前でロールの割り当てを削除します。
delete_by_id	ID でロールの割り当てを削除します。
get	スコープと名前でロールの割り当てを取得します。
get_by_id	ID でロールの割り当てを取得します。
list_for_resource	リソースに適用されるすべてのロールの割り当てを一覧表示します。
list_for_resource_group	リソース グループに適用されるすべてのロールの割り当てを一覧表示します。
list_for_scope	スコープに適用されるすべてのロールの割り当てを一覧表示します。
list_for_subscription	サブスクリプションに適用されるすべてのロールの割り当てを一覧表示します。
validate	スコープと名前でロールの割り当ての作成または更新操作を検証します。
validate_by_id	ロールの割り当ての作成または更新操作を ID で検証します。

create

スコープと名前でロールの割り当てを作成または更新します。

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

パラメーター

scope

str

必須

操作またはリソースのスコープ。 有効なスコープは、サブスクリプション (形式: '/subscriptions/{subscriptionId}')、リソース グループ (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}')、またはリソース (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}') です。 必須。

role_assignment_name

str

必須

ロールの割り当ての名前。 任意の有効な GUID を指定できます。 必須。

parameters

RoleAssignmentCreateParameters または IO

必須

ロールの割り当てのパラメーター。 RoleAssignmentCreateParameters 型または IO 型のいずれかです。 必須。

content_type

str

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

cls

callable

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

戻り値

RoleAssignment または cls(response) の結果

の戻り値の型 :

RoleAssignment

例外

HttpResponseError

create_by_id

ID でロールの割り当てを作成または更新します。

create_by_id(role_assignment_id: str, parameters: _models.RoleAssignmentCreateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.RoleAssignment

パラメーター

role_assignment_id

str

必須

スコープ、リソース名、リソースの種類など、ロールの割り当ての完全修飾 ID。 形式: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}。 例: /subscriptions/<SUB_ID>/resourcegroups/<RESOURCE_GROUP>/providers/Microsoft.Authorization/roleAssignments/<ROLE_ASSIGNMENT_NAME>。 必須。

parameters

RoleAssignmentCreateParameters または IO

必須

ロールの割り当てのパラメーター。 RoleAssignmentCreateParameters 型または IO 型のいずれかです。 必須。

content_type

str

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

cls

callable

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

戻り値

RoleAssignment または cls(response) の結果

の戻り値の型 :

RoleAssignment

例外

HttpResponseError

delete

スコープと名前でロールの割り当てを削除します。

delete(scope: str, role_assignment_name: str, tenant_id: str | None = None, **kwargs: Any) -> RoleAssignment | None

パラメーター

scope

str

必須

操作またはリソースのスコープ。 有効なスコープは、サブスクリプション (形式: '/subscriptions/{subscriptionId}')、リソース グループ (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}')、またはリソース (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}') です。 必須。

role_assignment_name

str

必須

ロールの割り当ての名前。 任意の有効な GUID を指定できます。 必須。

tenant_id

str

必須

テナント間要求のテナント ID。 既定値は [なし] です。

cls

callable

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

戻り値

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

の戻り値の型 :

RoleAssignment,

None

例外

HttpResponseError

delete_by_id

ID でロールの割り当てを削除します。

delete_by_id(role_assignment_id: str, tenant_id: str | None = None, **kwargs: Any) -> RoleAssignment | None

パラメーター

role_assignment_id

str

必須

スコープ、リソース名、リソースの種類など、ロールの割り当ての完全修飾 ID。 形式: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}。 例: /subscriptions/<SUB_ID>/resourcegroups/<RESOURCE_GROUP>/providers/Microsoft.Authorization/roleAssignments/<ROLE_ASSIGNMENT_NAME>。 必須。

tenant_id

str

必須

テナント間要求のテナント ID。 既定値は [なし] です。

cls

callable

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

戻り値

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

の戻り値の型 :

RoleAssignment,

None

例外

HttpResponseError

get

スコープと名前でロールの割り当てを取得します。

get(scope: str, role_assignment_name: str, tenant_id: str | None = None, **kwargs: Any) -> RoleAssignment

パラメーター

scope

str

必須

操作またはリソースのスコープ。 有効なスコープは、サブスクリプション (形式: '/subscriptions/{subscriptionId}')、リソース グループ (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}')、またはリソース (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}') です。 必須。

role_assignment_name

str

必須

ロールの割り当ての名前。 任意の有効な GUID を指定できます。 必須。

tenant_id

str

必須

テナント間要求のテナント ID。 既定値は [なし] です。

cls

callable

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

戻り値

RoleAssignment または cls(response) の結果

の戻り値の型 :

RoleAssignment

例外

HttpResponseError

get_by_id

ID でロールの割り当てを取得します。

get_by_id(role_assignment_id: str, tenant_id: str | None = None, **kwargs: Any) -> RoleAssignment

パラメーター

role_assignment_id

str

必須

スコープ、リソース名、リソースの種類など、ロールの割り当ての完全修飾 ID。 形式: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}。 例: /subscriptions/<SUB_ID>/resourcegroups/<RESOURCE_GROUP>/providers/Microsoft.Authorization/roleAssignments/<ROLE_ASSIGNMENT_NAME>。 必須。

tenant_id

str

必須

テナント間要求のテナント ID。 既定値は [なし] です。

cls

callable

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

戻り値

RoleAssignment または cls(response) の結果

の戻り値の型 :

RoleAssignment

例外

HttpResponseError

list_for_resource

リソースに適用されるすべてのロールの割り当てを一覧表示します。

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

パラメーター

resource_group_name

str

必須

リソース グループの名前。 名前の大文字と小文字は区別されます。 必須。

resource_provider_namespace

str

必須

リソース プロバイダーの名前空間。 必須。

resource_type

str

必須

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

resource_name

str

必須

リソースの名前。 必須。

filter

str

必須

操作に適用するフィルター。 スコープ以上のすべてのロールの割り当てを返すには、$filter=atScope() を使用します。 $filter=principalId eq {id} を使用して、指定したプリンシパルのスコープの上または下にあるすべてのロールの割り当てを返します。 既定値は [なし] です。

tenant_id

str

必須

テナント間要求のテナント ID。 既定値は [なし] です。

cls

callable

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

戻り値

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

の戻り値の型 :

ItemPaged[RoleAssignment]

例外

HttpResponseError

list_for_resource_group

リソース グループに適用されるすべてのロールの割り当てを一覧表示します。

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

パラメーター

resource_group_name

str

必須

リソース グループの名前。 名前の大文字と小文字は区別されます。 必須。

filter

str

必須

操作に適用するフィルター。 スコープ以上のすべてのロールの割り当てを返すには、$filter=atScope() を使用します。 指定したプリンシパルのスコープの上または下にあるすべてのロールの割り当てを返すには、$filter=principalId eq {id} を使用します。 既定値は [なし] です。

tenant_id

str

必須

テナント間要求のテナント ID。 既定値は [なし] です。

cls

callable

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

戻り値

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

の戻り値の型 :

ItemPaged[RoleAssignment]

例外

HttpResponseError

list_for_scope

スコープに適用されるすべてのロールの割り当てを一覧表示します。

list_for_scope(scope: str, filter: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> Iterable[RoleAssignment]

パラメーター

scope

str

必須

操作またはリソースのスコープ。 有効なスコープは、サブスクリプション (形式: '/subscriptions/{subscriptionId}')、リソース グループ (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'、またはリソース (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' です。 必須。

filter

str

必須

操作に適用するフィルター。 スコープ以上のすべてのロールの割り当てを返すには、$filter=atScope() を使用します。 指定したプリンシパルのスコープの上または下にあるすべてのロールの割り当てを返すには、$filter=principalId eq {id} を使用します。 既定値は [なし] です。

tenant_id

str

必須

テナント間要求のテナント ID。 既定値は [なし] です。

cls

callable

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

戻り値

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

の戻り値の型 :

ItemPaged[RoleAssignment]

例外

HttpResponseError

list_for_subscription

サブスクリプションに適用されるすべてのロールの割り当てを一覧表示します。

list_for_subscription(filter: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> Iterable[RoleAssignment]

パラメーター

filter

str

必須

操作に適用するフィルター。 スコープ以上のすべてのロールの割り当てを返すには、$filter=atScope() を使用します。 指定したプリンシパルのスコープの上または下にあるすべてのロールの割り当てを返すには、$filter=principalId eq {id} を使用します。 既定値は [なし] です。

tenant_id

str

必須

テナント間要求のテナント ID。 既定値は [なし] です。

cls

callable

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

戻り値

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

の戻り値の型 :

ItemPaged[RoleAssignment]

例外

HttpResponseError

validate

スコープと名前でロールの割り当ての作成または更新操作を検証します。

validate(scope: str, role_assignment_name: str, parameters: _models.RoleAssignmentCreateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ValidationResponse

パラメーター

scope

str

必須

操作またはリソースのスコープ。 有効なスコープは、サブスクリプション (形式: '/subscriptions/{subscriptionId}')、リソース グループ (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'、またはリソース (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' です。 必須。

role_assignment_name

str

必須

ロールの割り当ての名前。 任意の有効な GUID を指定できます。 必須。

parameters

RoleAssignmentCreateParameters または IO

必須

ロールの割り当てのパラメーター。 RoleAssignmentCreateParameters 型または IO 型のいずれかです。 必須。

content_type

str

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

cls

callable

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

戻り値

ValidationResponse または cls(response) の結果

の戻り値の型 :

ValidationResponse

例外

HttpResponseError

validate_by_id

ロールの割り当ての作成または更新操作を ID で検証します。

validate_by_id(role_assignment_id: str, parameters: _models.RoleAssignmentCreateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ValidationResponse

パラメーター

role_assignment_id

str

必須

スコープ、リソース名、リソースの種類など、ロールの割り当ての完全修飾 ID。 形式: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName} 例: /subscriptions/<SUB_ID>/resourcegroups/<RESOURCE_GROUP>/providers/Microsoft.Authorization/roleAssignments/<ROLE_ASSIGNMENT_NAME>。 必須。

parameters

RoleAssignmentCreateParameters または IO

必須

ロールの割り当てのパラメーター。 RoleAssignmentCreateParameters 型または IO 型のいずれかです。 必須。

content_type

str

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

cls

callable

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

戻り値

ValidationResponse または cls(response) の結果

の戻り値の型 :

ValidationResponse

例外

HttpResponseError

属性

models

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