RoleAssignments interface
RoleAssignments を表すインターフェイス。
メソッド
create(string, string, Role |
スコープと名前でロールの割り当てを作成または更新します。 |
create |
ID でロールの割り当てを作成または更新します。 |
delete(string, string, Role |
スコープと名前でロールの割り当てを削除します。 |
delete |
ID でロールの割り当てを削除します。 |
get(string, string, Role |
スコープと名前でロールの割り当てを取得します。 |
get |
ID でロールの割り当てを取得します。 |
list |
リソースに適用されるすべてのロールの割り当てを一覧表示します。 |
list |
リソース グループに適用されるすべてのロールの割り当てを一覧表示します。 |
list |
スコープに適用されるすべてのロールの割り当てを一覧表示します。 |
list |
サブスクリプションに適用されるすべてのロールの割り当てを一覧表示します。 |
メソッドの詳細
create(string, string, RoleAssignmentCreateParameters, RoleAssignmentsCreateOptionalParams)
スコープと名前でロールの割り当てを作成または更新します。
function create(scope: string, roleAssignmentName: string, parameters: RoleAssignmentCreateParameters, options?: RoleAssignmentsCreateOptionalParams): Promise<RoleAssignment>
パラメーター
- scope
-
string
操作またはリソースのスコープ。 有効なスコープは、サブスクリプション (形式: '/subscriptions/{subscriptionId}')、リソース グループ (形式: '/subscriptionId}/resourceGroups/{resourceGroupName}')、またはリソース (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' です。
- roleAssignmentName
-
string
ロールの割り当ての名前。 任意の有効な GUID を指定できます。
- parameters
- RoleAssignmentCreateParameters
ロールの割り当てのパラメーター。
options パラメーター。
戻り値
Promise<RoleAssignment>
createById(string, RoleAssignmentCreateParameters, RoleAssignmentsCreateByIdOptionalParams)
ID でロールの割り当てを作成または更新します。
function createById(roleAssignmentId: string, parameters: RoleAssignmentCreateParameters, options?: RoleAssignmentsCreateByIdOptionalParams): Promise<RoleAssignment>
パラメーター
- roleAssignmentId
-
string
スコープ、リソース名、リソースの種類など、ロールの割り当ての完全修飾 ID。 形式: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}。 例: /subscriptions/<SUB_ID>/resourcegroups/<RESOURCE_GROUP>/providers/Microsoft.Authorization/roleAssignments/<ROLE_ASSIGNMENT_NAME>
- parameters
- RoleAssignmentCreateParameters
ロールの割り当てのパラメーター。
options パラメーター。
戻り値
Promise<RoleAssignment>
delete(string, string, RoleAssignmentsDeleteOptionalParams)
スコープと名前でロールの割り当てを削除します。
function delete(scope: string, roleAssignmentName: string, options?: RoleAssignmentsDeleteOptionalParams): Promise<RoleAssignment>
パラメーター
- scope
-
string
操作またはリソースのスコープ。 有効なスコープは、サブスクリプション (形式: '/subscriptions/{subscriptionId}')、リソース グループ (形式: '/subscriptionId}/resourceGroups/{resourceGroupName}')、またはリソース (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' です。
- roleAssignmentName
-
string
ロールの割り当ての名前。 任意の有効な GUID を指定できます。
options パラメーター。
戻り値
Promise<RoleAssignment>
deleteById(string, RoleAssignmentsDeleteByIdOptionalParams)
ID でロールの割り当てを削除します。
function deleteById(roleAssignmentId: string, options?: RoleAssignmentsDeleteByIdOptionalParams): Promise<RoleAssignment>
パラメーター
- roleAssignmentId
-
string
スコープ、リソース名、リソースの種類など、ロールの割り当ての完全修飾 ID。 形式: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}。 例: /subscriptions/<SUB_ID>/resourcegroups/<RESOURCE_GROUP>/providers/Microsoft.Authorization/roleAssignments/<ROLE_ASSIGNMENT_NAME>
options パラメーター。
戻り値
Promise<RoleAssignment>
get(string, string, RoleAssignmentsGetOptionalParams)
スコープと名前でロールの割り当てを取得します。
function get(scope: string, roleAssignmentName: string, options?: RoleAssignmentsGetOptionalParams): Promise<RoleAssignment>
パラメーター
- scope
-
string
操作またはリソースのスコープ。 有効なスコープは、サブスクリプション (形式: '/subscriptions/{subscriptionId}')、リソース グループ (形式: '/subscriptionId}/resourceGroups/{resourceGroupName}')、またはリソース (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' です。
- roleAssignmentName
-
string
ロールの割り当ての名前。 任意の有効な GUID を指定できます。
- options
- RoleAssignmentsGetOptionalParams
options パラメーター。
戻り値
Promise<RoleAssignment>
getById(string, RoleAssignmentsGetByIdOptionalParams)
ID でロールの割り当てを取得します。
function getById(roleAssignmentId: string, options?: RoleAssignmentsGetByIdOptionalParams): Promise<RoleAssignment>
パラメーター
- roleAssignmentId
-
string
スコープ、リソース名、リソースの種類など、ロールの割り当ての完全修飾 ID。 形式: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}。 例: /subscriptions/<SUB_ID>/resourcegroups/<RESOURCE_GROUP>/providers/Microsoft.Authorization/roleAssignments/<ROLE_ASSIGNMENT_NAME>
options パラメーター。
戻り値
Promise<RoleAssignment>
listForResource(string, string, string, string, RoleAssignmentsListForResourceOptionalParams)
リソースに適用されるすべてのロールの割り当てを一覧表示します。
function listForResource(resourceGroupName: string, resourceProviderNamespace: string, resourceType: string, resourceName: string, options?: RoleAssignmentsListForResourceOptionalParams): PagedAsyncIterableIterator<RoleAssignment, RoleAssignment[], PageSettings>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- resourceProviderNamespace
-
string
リソース プロバイダーの名前空間。
- resourceType
-
string
リソースの種類名。 たとえば、Web アプリの型名は 'sites' です (Microsoft.Web/sites から)。
- resourceName
-
string
リソースの名前。
options パラメーター。
戻り値
listForResourceGroup(string, RoleAssignmentsListForResourceGroupOptionalParams)
リソース グループに適用されるすべてのロールの割り当てを一覧表示します。
function listForResourceGroup(resourceGroupName: string, options?: RoleAssignmentsListForResourceGroupOptionalParams): PagedAsyncIterableIterator<RoleAssignment, RoleAssignment[], PageSettings>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
options パラメーター。
戻り値
listForScope(string, RoleAssignmentsListForScopeOptionalParams)
スコープに適用されるすべてのロールの割り当てを一覧表示します。
function listForScope(scope: string, options?: RoleAssignmentsListForScopeOptionalParams): PagedAsyncIterableIterator<RoleAssignment, RoleAssignment[], PageSettings>
パラメーター
- scope
-
string
操作またはリソースのスコープ。 有効なスコープは、サブスクリプション (形式: '/subscriptions/{subscriptionId}')、リソース グループ (形式: '/subscriptionId}/resourceGroups/{resourceGroupName}')、またはリソース (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' です。
options パラメーター。
戻り値
listForSubscription(RoleAssignmentsListForSubscriptionOptionalParams)
サブスクリプションに適用されるすべてのロールの割り当てを一覧表示します。
function listForSubscription(options?: RoleAssignmentsListForSubscriptionOptionalParams): PagedAsyncIterableIterator<RoleAssignment, RoleAssignment[], PageSettings>
パラメーター
options パラメーター。