@datafire/azure_authorization_authorization_racalls v5.0.0

@datafire/azure_authorization_authorization_racalls

Client library for AuthorizationManagementClient

Installation and Usage

npm install --save @datafire/azure_authorization_authorization_racalls

let azure_authorization_authorization_racalls = require('@datafire/azure_authorization_authorization_racalls').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role definitions and role assignments. A role definition describes the set of actions that can be performed on resources. A role assignment grants access to Azure Active Directory users.

Actions

RoleAssignments_List

Gets all role assignments for the subscription.

azure_authorization_authorization_racalls.RoleAssignments_List({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • $filter string: The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal.
  • api-version required string: The API version to use for this operation.
  • subscriptionId required string: The ID of the target subscription.

Output

• output RoleAssignmentListResult

RoleAssignments_ListForResourceGroup

Gets role assignments for a resource group.

azure_authorization_authorization_racalls.RoleAssignments_ListForResourceGroup({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • $filter string: The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal.
  • api-version required string: The API version to use for this operation.
  • subscriptionId required string: The ID of the target subscription.

Output

• output RoleAssignmentListResult

RoleAssignments_ListForResource

Gets role assignments for a resource.

azure_authorization_authorization_racalls.RoleAssignments_ListForResource({
  "resourceGroupName": "",
  "resourceProviderNamespace": "",
  "parentResourcePath": "",
  "resourceType": "",
  "resourceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • resourceProviderNamespace required string: The namespace of the resource provider.
  • parentResourcePath required string: The parent resource identity.
  • resourceType required string: The resource type of the resource.
  • resourceName required string: The name of the resource to get role assignments for.
  • $filter string: The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal.
  • api-version required string: The API version to use for this operation.
  • subscriptionId required string: The ID of the target subscription.

Output

• output RoleAssignmentListResult

RoleAssignments_DeleteById

Deletes a role assignment.

azure_authorization_authorization_racalls.RoleAssignments_DeleteById({
  "roleAssignmentId": "",
  "api-version": ""
}, context)

Input

• input object
  • roleAssignmentId required string: The ID of the role assignment to delete.
  • api-version required string: The API version to use for this operation.

Output

• output RoleAssignment

RoleAssignments_GetById

Gets a role assignment by ID.

azure_authorization_authorization_racalls.RoleAssignments_GetById({
  "roleAssignmentId": "",
  "api-version": ""
}, context)

Input

• input object
  • roleAssignmentId required string: The ID of the role assignment to get.
  • api-version required string: The API version to use for this operation.

Output

• output RoleAssignment

RoleAssignments_CreateById

Creates a role assignment by ID.

azure_authorization_authorization_racalls.RoleAssignments_CreateById({
  "roleAssignmentId": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

• input object
  • roleAssignmentId required string: The ID of the role assignment to create.
  • parameters required RoleAssignmentCreateParameters
  • api-version required string: The API version to use for this operation.

Output

• output RoleAssignment

RoleAssignments_ListForScope

Gets role assignments for a scope.

azure_authorization_authorization_racalls.RoleAssignments_ListForScope({
  "scope": "",
  "api-version": ""
}, context)

Input

• input object
  • scope required string: The scope of the role assignments.
  • $filter string: The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal.
  • api-version required string: The API version to use for this operation.

Output

• output RoleAssignmentListResult

RoleAssignments_Delete

Deletes a role assignment.

azure_authorization_authorization_racalls.RoleAssignments_Delete({
  "scope": "",
  "roleAssignmentName": "",
  "api-version": ""
}, context)

Input

• input object
  • scope required string: The scope of the role assignment to delete.
  • roleAssignmentName required string: The name of the role assignment to delete.
  • api-version required string: The API version to use for this operation.

Output

• output RoleAssignment

RoleAssignments_Get

Get the specified role assignment.

azure_authorization_authorization_racalls.RoleAssignments_Get({
  "scope": "",
  "roleAssignmentName": "",
  "api-version": ""
}, context)

Input

• input object
  • scope required string: The scope of the role assignment.
  • roleAssignmentName required string: The name of the role assignment to get.
  • api-version required string: The API version to use for this operation.

Output

• output RoleAssignment

RoleAssignments_Create

Creates a role assignment.

azure_authorization_authorization_racalls.RoleAssignments_Create({
  "scope": "",
  "roleAssignmentName": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

• input object
  • scope required string: The scope of the role assignment to create. The scope can be any REST resource instance. For example, use '/subscriptions/{subscription-id}/' for a subscription, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a resource group, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' for a resource.
  • roleAssignmentName required string: The name of the role assignment to create. It can be any valid GUID.
  • parameters required RoleAssignmentCreateParameters
  • api-version required string: The API version to use for this operation.

Output

• output RoleAssignment

Definitions

RoleAssignment

• RoleAssignment object: Role Assignments
  • id string: The role assignment ID.
  • name string: The role assignment name.
  • properties RoleAssignmentPropertiesWithScope
  • type string: The role assignment type.

RoleAssignmentCreateParameters

• RoleAssignmentCreateParameters object: Role assignment create parameters.
  • properties RoleAssignmentProperties

RoleAssignmentFilter

• RoleAssignmentFilter object: Role Assignments filter
  • canDelegate boolean: The Delegation flag for the role assignment
  • principalId string: Returns role assignment of the specific principal.

RoleAssignmentListResult

• RoleAssignmentListResult object: Role assignment list operation result.
  • nextLink string: The URL to use for getting the next set of results.
  • value array: Role assignment list.
    • items RoleAssignment

RoleAssignmentProperties

• RoleAssignmentProperties object: Role assignment properties.
  • canDelegate boolean: The delegation flag used for creating a role assignment
  • principalId string: The principal ID assigned to the role. This maps to the ID inside the Active Directory. It can point to a user, service principal, or security group.
  • roleDefinitionId string: The role definition ID used in the role assignment.

RoleAssignmentPropertiesWithScope

• RoleAssignmentPropertiesWithScope object: Role assignment properties with scope.
  • canDelegate boolean: The Delegation flag for the role assignment
  • principalId string: The principal ID.
  • roleDefinitionId string: The role definition ID.
  • scope string: The role assignment scope.