RoleAssignments interface
Интерфейс, представляющий roleAssignments.
Методы
Сведения о методе
create(string, string, RoleAssignmentCreateParameters, RoleAssignmentsCreateOptionalParams)
Создайте или обновите назначение ролей по область и имени.
function create(scope: string, roleAssignmentName: string, parameters: RoleAssignmentCreateParameters, options?: RoleAssignmentsCreateOptionalParams): Promise<RoleAssignment>
Параметры
- scope
-
string
Область операции или ресурса. Допустимые области: подписка (формат:/subscriptions/{subscriptionId}), группа ресурсов (формат:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}) или ресурс (формат: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}.
- roleAssignmentName
-
string
Имя назначения роли. Это может быть любой допустимый GUID.
- parameters
- RoleAssignmentCreateParameters
Параметры для назначения роли.
Параметры параметров.
Возвращаемое значение
Promise<RoleAssignment>
createById(string, RoleAssignmentCreateParameters, RoleAssignmentsCreateByIdOptionalParams)
Создание или обновление назначения ролей по идентификатору.
function createById(roleAssignmentId: string, parameters: RoleAssignmentCreateParameters, options?: RoleAssignmentsCreateByIdOptionalParams): Promise<RoleAssignment>
Параметры
- roleAssignmentId
-
string
Полный идентификатор назначения роли, включая область, имя ресурса и тип ресурса. Формат: /{область}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Пример: /subscriptions/<SUB_ID>/resourcegroups/<RESOURCE_GROUP>/providers/Microsoft.Authorization/roleAssignments/<ROLE_ASSIGNMENT_NAME>
- parameters
- RoleAssignmentCreateParameters
Параметры для назначения роли.
Параметры параметров.
Возвращаемое значение
Promise<RoleAssignment>
delete(string, string, RoleAssignmentsDeleteOptionalParams)
Удаление назначения ролей по область и имени.
function delete(scope: string, roleAssignmentName: string, options?: RoleAssignmentsDeleteOptionalParams): Promise<RoleAssignment>
Параметры
- scope
-
string
Область операции или ресурса. Допустимые области: подписка (формат:/subscriptions/{subscriptionId}), группа ресурсов (формат:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}) или ресурс (формат: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}.
- roleAssignmentName
-
string
Имя назначения роли. Это может быть любой допустимый GUID.
Параметры параметров.
Возвращаемое значение
Promise<RoleAssignment>
deleteById(string, RoleAssignmentsDeleteByIdOptionalParams)
Удаление назначения ролей по идентификатору.
function deleteById(roleAssignmentId: string, options?: RoleAssignmentsDeleteByIdOptionalParams): Promise<RoleAssignment>
Параметры
- roleAssignmentId
-
string
Полный идентификатор назначения роли, включая область, имя ресурса и тип ресурса. Формат: /{область}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Пример: /subscriptions/<SUB_ID>/resourcegroups/<RESOURCE_GROUP>/providers/Microsoft.Authorization/roleAssignments/<ROLE_ASSIGNMENT_NAME>
Параметры параметров.
Возвращаемое значение
Promise<RoleAssignment>
get(string, string, RoleAssignmentsGetOptionalParams)
Получение назначения роли по область и имени.
function get(scope: string, roleAssignmentName: string, options?: RoleAssignmentsGetOptionalParams): Promise<RoleAssignment>
Параметры
- scope
-
string
Область операции или ресурса. Допустимые области: подписка (формат:/subscriptions/{subscriptionId}), группа ресурсов (формат:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}) или ресурс (формат: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}.
- roleAssignmentName
-
string
Имя назначения роли. Это может быть любой допустимый GUID.
- options
- RoleAssignmentsGetOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<RoleAssignment>
getById(string, RoleAssignmentsGetByIdOptionalParams)
Получение назначения роли по идентификатору.
function getById(roleAssignmentId: string, options?: RoleAssignmentsGetByIdOptionalParams): Promise<RoleAssignment>
Параметры
- roleAssignmentId
-
string
Полный идентификатор назначения роли, включая область, имя ресурса и тип ресурса. Формат: /{область}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Пример: /subscriptions/<SUB_ID>/resourcegroups/<RESOURCE_GROUP>/providers/Microsoft.Authorization/roleAssignments/<ROLE_ASSIGNMENT_NAME>
Параметры параметров.
Возвращаемое значение
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
Имя типа ресурса. Например, имя типа веб-приложения — sites (из Microsoft.Web/sites).
- 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
Область операции или ресурса. Допустимые области: подписка (формат:/subscriptions/{subscriptionId}), группа ресурсов (формат:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}) или ресурс (формат: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}.
Параметры параметров.
Возвращаемое значение
listForSubscription(RoleAssignmentsListForSubscriptionOptionalParams)
Список всех назначений ролей, применимых к подписке.
function listForSubscription(options?: RoleAssignmentsListForSubscriptionOptionalParams): PagedAsyncIterableIterator<RoleAssignment, RoleAssignment[], PageSettings>
Параметры
Параметры параметров.