RoleAssignments interface
Интерфейс, представляющий RoleAssignments.
Методы
Сведения о методе
create(string, string, RoleAssignmentCreateParameters, RoleAssignmentsCreateOptionalParams)
Создает назначение роли.
function create(scope: string, roleAssignmentName: string, parameters: RoleAssignmentCreateParameters, options?: RoleAssignmentsCreateOptionalParams): Promise<RoleAssignment>
Параметры
- scope
-
string
Область создаваемого назначения роли. Областью может быть любой экземпляр ресурса REST. Например, используйте "/subscriptions/{идентификатор_подписки}/" для подписки, "/subscriptions/{идентификатор_подписки}/resourceGroups/{имя_группы_ресурсов}" для группы ресурсов и '/subscriptions/{идентификатор_подписки}/resourceGroups/{имя_группы_ресурсов}/providers/{resource-provider}/{тип_ресурса}/{имя_ресурса}' для ресурса.
- roleAssignmentName
-
string
GUID для создаваемого назначения роли. Имя должно быть уникальным и отличаться для каждого назначения ролей.
- parameters
- RoleAssignmentCreateParameters
Параметры для назначения роли.
Параметры параметров.
Возвращаемое значение
Promise<RoleAssignment>
createById(string, RoleAssignmentCreateParameters, RoleAssignmentsCreateByIdOptionalParams)
Создает назначение роли по идентификатору.
function createById(roleAssignmentId: string, parameters: RoleAssignmentCreateParameters, options?: RoleAssignmentsCreateByIdOptionalParams): Promise<RoleAssignment>
Параметры
- roleAssignmentId
-
string
Полный идентификатор назначения роли, включая область, имя ресурса и тип ресурса. Используйте формат /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Пример: /subscriptions/{subId}/resourcegroups/{rgname}//providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}.
- parameters
- RoleAssignmentCreateParameters
Параметры для назначения роли.
Параметры параметров.
Возвращаемое значение
Promise<RoleAssignment>
delete(string, string, RoleAssignmentsDeleteOptionalParams)
Удаляет назначение роли.
function delete(scope: string, roleAssignmentName: string, options?: RoleAssignmentsDeleteOptionalParams): Promise<RoleAssignment>
Параметры
- scope
-
string
Область назначения роли для удаления.
- roleAssignmentName
-
string
Имя удаляемого назначения роли.
Параметры параметров.
Возвращаемое значение
Promise<RoleAssignment>
deleteById(string, RoleAssignmentsDeleteByIdOptionalParams)
Удаляет назначение роли.
function deleteById(roleAssignmentId: string, options?: RoleAssignmentsDeleteByIdOptionalParams): Promise<RoleAssignment>
Параметры
- roleAssignmentId
-
string
Полный идентификатор назначения роли, включая область, имя ресурса и тип ресурса. Используйте формат /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Пример: /subscriptions/{subId}/resourcegroups/{rgname}//providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}.
Параметры параметров.
Возвращаемое значение
Promise<RoleAssignment>
get(string, string, RoleAssignmentsGetOptionalParams)
Получение указанного назначения роли.
function get(scope: string, roleAssignmentName: string, options?: RoleAssignmentsGetOptionalParams): Promise<RoleAssignment>
Параметры
- scope
-
string
Область назначения роли.
- roleAssignmentName
-
string
Имя получаемого назначения роли.
- options
- RoleAssignmentsGetOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<RoleAssignment>
getById(string, RoleAssignmentsGetByIdOptionalParams)
Возвращает назначение роли по идентификатору.
function getById(roleAssignmentId: string, options?: RoleAssignmentsGetByIdOptionalParams): Promise<RoleAssignment>
Параметры
- roleAssignmentId
-
string
Полный идентификатор назначения роли, включая область, имя ресурса и тип ресурса. Используйте формат /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Пример: /subscriptions/{subId}/resourcegroups/{rgname}//providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}.
Параметры параметров.
Возвращаемое значение
Promise<RoleAssignment>
list(RoleAssignmentsListOptionalParams)
Возвращает все назначения ролей для подписки.
function list(options?: RoleAssignmentsListOptionalParams): PagedAsyncIterableIterator<RoleAssignment, RoleAssignment[], PageSettings>
Параметры
Параметры параметров.
Возвращаемое значение
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
Удостоверение родительского ресурса.
- resourceType
-
string
Тип ресурса.
- resourceName
-
string
Имя ресурса для получения назначений ролей.
Параметры параметров.
Возвращаемое значение
listForResourceGroup(string, RoleAssignmentsListForResourceGroupOptionalParams)
Возвращает назначения ролей для группы ресурсов.
function listForResourceGroup(resourceGroupName: string, options?: RoleAssignmentsListForResourceGroupOptionalParams): PagedAsyncIterableIterator<RoleAssignment, RoleAssignment[], PageSettings>
Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
Параметры параметров.
Возвращаемое значение
listForScope(string, RoleAssignmentsListForScopeOptionalParams)
Возвращает назначения ролей для области.
function listForScope(scope: string, options?: RoleAssignmentsListForScopeOptionalParams): PagedAsyncIterableIterator<RoleAssignment, RoleAssignment[], PageSettings>
Параметры
- scope
-
string
Область назначения ролей.
Параметры параметров.