RoleAssignments interface
RoleAssignments を表すインターフェイス。
メソッド
| create(string, string, Role |
ロールの割り当てを作成します。 |
| create |
ID によるロールの割り当てを作成します。 |
| delete(string, string, Role |
ロールの割り当てを削除します。 |
| delete |
ロールの割り当てを削除します。 |
| get(string, string, Role |
指定したロールの割り当てを取得します。 |
| get |
ID でロールの割り当てを取得します。 |
| list(Role |
サブスクリプションのすべてのロールの割り当てを取得します。 |
| list |
リソースのロールの割り当てを取得します。 |
| list |
リソース グループのロールの割り当てを取得します。 |
| list |
スコープのロールの割り当てを取得します。 |
メソッドの詳細
create(string, string, RoleAssignmentCreateParameters, RoleAssignmentsCreateOptionalParams)
ロールの割り当てを作成します。
function create(scope: string, roleAssignmentName: string, parameters: RoleAssignmentCreateParameters, options?: RoleAssignmentsCreateOptionalParams): Promise<RoleAssignment>パラメーター
- scope
-
string
作成するロールの割り当てのスコープ。 スコープには、任意の REST リソース インスタンスを指定できます。 たとえば、サブスクリプションの場合は '/subscriptions/{subscription-id}/'、リソース グループには '/subscriptions/{subscription-id}/{resource-group-name}'、リソースの場合は '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' を使用します。
- 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/{subId}/resourcegroups/{rgname}//providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
- parameters
- RoleAssignmentCreateParameters
ロールの割り当てのパラメーター。
options パラメーター。
戻り値
Promise<RoleAssignment>
delete(string, string, RoleAssignmentsDeleteOptionalParams)
ロールの割り当てを削除します。
function delete(scope: string, roleAssignmentName: string, options?: RoleAssignmentsDeleteOptionalParams): Promise<RoleAssignment>パラメーター
- scope
-
string
削除するロールの割り当てのスコープ。
- roleAssignmentName
-
string
削除するロールの割り当ての名前。
options パラメーター。
戻り値
Promise<RoleAssignment>
deleteById(string, RoleAssignmentsDeleteByIdOptionalParams)
ロールの割り当てを削除します。
function deleteById(roleAssignmentId: string, options?: RoleAssignmentsDeleteByIdOptionalParams): Promise<RoleAssignment>パラメーター
- roleAssignmentId
-
string
スコープ、リソース名、リソースの種類など、ロールの割り当ての完全修飾 ID。 形式 /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName} を使用します。 例: /subscriptions/{subId}/resourcegroups/{rgname}//providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
options パラメーター。
戻り値
Promise<RoleAssignment>
get(string, string, RoleAssignmentsGetOptionalParams)
指定したロールの割り当てを取得します。
function get(scope: string, roleAssignmentName: string, options?: RoleAssignmentsGetOptionalParams): Promise<RoleAssignment>パラメーター
- scope
-
string
ロールの割り当てのスコープ。
- roleAssignmentName
-
string
取得するロールの割り当ての名前。
- 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/{subId}/resourcegroups/{rgname}//providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
options パラメーター。
戻り値
Promise<RoleAssignment>
list(RoleAssignmentsListOptionalParams)
サブスクリプションのすべてのロールの割り当てを取得します。
function list(options?: RoleAssignmentsListOptionalParams): PagedAsyncIterableIterator<RoleAssignment, RoleAssignment[], PageSettings>パラメーター
options パラメーター。
戻り値
listForResource(string, string, string, string, string, RoleAssignmentsListForResourceOptionalParams)
リソースのロールの割り当てを取得します。
function listForResource(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, options?: RoleAssignmentsListForResourceOptionalParams): PagedAsyncIterableIterator<RoleAssignment, RoleAssignment[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- resourceProviderNamespace
-
string
リソース プロバイダーの名前空間。
- parentResourcePath
-
string
親リソース ID。
- resourceType
-
string
リソースのリソースの種類。
- 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
ロールの割り当てのスコープ。
options パラメーター。