RoleAssignments interface
Interface que representa um RoleAssignments.
Métodos
Detalhes do método
create(string, string, RoleAssignmentCreateParameters, RoleAssignmentsCreateOptionalParams)
Cria uma atribuição de função.
function create(scope: string, roleAssignmentName: string, parameters: RoleAssignmentCreateParameters, options?: RoleAssignmentsCreateOptionalParams): Promise<RoleAssignment>Parâmetros
- scope
-
string
O escopo da atribuição de função a ser criada. O escopo pode ser qualquer instância de recurso REST. Por exemplo, use '/subscriptions/{subscription-id}/' para uma assinatura, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' para um grupo de recursos e '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' para um recurso.
- roleAssignmentName
-
string
Um GUID para a atribuição de função a ser criada. O nome deve ser exclusivo e diferente para cada atribuição de função.
- parameters
- RoleAssignmentCreateParameters
Parâmetros para a atribuição de função.
Os parâmetros de opções.
Retornos
Promise<RoleAssignment>
createById(string, RoleAssignmentCreateParameters, RoleAssignmentsCreateByIdOptionalParams)
Cria uma atribuição de função por ID.
function createById(roleAssignmentId: string, parameters: RoleAssignmentCreateParameters, options?: RoleAssignmentsCreateByIdOptionalParams): Promise<RoleAssignment>Parâmetros
- roleAssignmentId
-
string
A ID totalmente qualificada da atribuição de função, incluindo o escopo, o nome do recurso e o tipo de recurso. Use o formato /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Exemplo: /subscriptions/{subId}/resourcegroups/{rgname}//providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}.
- parameters
- RoleAssignmentCreateParameters
Parâmetros para a atribuição de função.
Os parâmetros de opções.
Retornos
Promise<RoleAssignment>
delete(string, string, RoleAssignmentsDeleteOptionalParams)
Exclui uma atribuição de função.
function delete(scope: string, roleAssignmentName: string, options?: RoleAssignmentsDeleteOptionalParams): Promise<RoleAssignment>Parâmetros
- scope
-
string
O escopo da atribuição de função a ser excluída.
- roleAssignmentName
-
string
O nome da atribuição de função a ser excluída.
Os parâmetros de opções.
Retornos
Promise<RoleAssignment>
deleteById(string, RoleAssignmentsDeleteByIdOptionalParams)
Exclui uma atribuição de função.
function deleteById(roleAssignmentId: string, options?: RoleAssignmentsDeleteByIdOptionalParams): Promise<RoleAssignment>Parâmetros
- roleAssignmentId
-
string
A ID totalmente qualificada da atribuição de função, incluindo o escopo, o nome do recurso e o tipo de recurso. Use o formato /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Exemplo: /subscriptions/{subId}/resourcegroups/{rgname}//providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}.
Os parâmetros de opções.
Retornos
Promise<RoleAssignment>
get(string, string, RoleAssignmentsGetOptionalParams)
Obtenha a atribuição de função especificada.
function get(scope: string, roleAssignmentName: string, options?: RoleAssignmentsGetOptionalParams): Promise<RoleAssignment>Parâmetros
- scope
-
string
O escopo da atribuição de função.
- roleAssignmentName
-
string
O nome da atribuição de função a ser obtido.
- options
- RoleAssignmentsGetOptionalParams
Os parâmetros de opções.
Retornos
Promise<RoleAssignment>
getById(string, RoleAssignmentsGetByIdOptionalParams)
Obtém uma atribuição de função por ID.
function getById(roleAssignmentId: string, options?: RoleAssignmentsGetByIdOptionalParams): Promise<RoleAssignment>Parâmetros
- roleAssignmentId
-
string
A ID totalmente qualificada da atribuição de função, incluindo o escopo, o nome do recurso e o tipo de recurso. Use o formato /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Exemplo: /subscriptions/{subId}/resourcegroups/{rgname}//providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}.
Os parâmetros de opções.
Retornos
Promise<RoleAssignment>
list(RoleAssignmentsListOptionalParams)
Obtém todas as atribuições de função para a assinatura.
function list(options?: RoleAssignmentsListOptionalParams): PagedAsyncIterableIterator<RoleAssignment, RoleAssignment[], PageSettings>Parâmetros
Os parâmetros de opções.
Retornos
listForResource(string, string, string, string, string, RoleAssignmentsListForResourceOptionalParams)
Obtém atribuições de função para um recurso.
function listForResource(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, options?: RoleAssignmentsListForResourceOptionalParams): PagedAsyncIterableIterator<RoleAssignment, RoleAssignment[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- resourceProviderNamespace
-
string
O namespace do provedor de recursos.
- parentResourcePath
-
string
A identidade do recurso pai.
- resourceType
-
string
O tipo de recurso do recurso.
- resourceName
-
string
O nome do recurso para o qual obter atribuições de função.
Os parâmetros de opções.
Retornos
listForResourceGroup(string, RoleAssignmentsListForResourceGroupOptionalParams)
Obtém atribuições de função para um grupo de recursos.
function listForResourceGroup(resourceGroupName: string, options?: RoleAssignmentsListForResourceGroupOptionalParams): PagedAsyncIterableIterator<RoleAssignment, RoleAssignment[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
Os parâmetros de opções.
Retornos
listForScope(string, RoleAssignmentsListForScopeOptionalParams)
Obtém atribuições de função para um escopo.
function listForScope(scope: string, options?: RoleAssignmentsListForScopeOptionalParams): PagedAsyncIterableIterator<RoleAssignment, RoleAssignment[], PageSettings>Parâmetros
- scope
-
string
O escopo das atribuições de função.
Os parâmetros de opções.