@datafire/azure_authorization_authorization_rolebasedcalls

Client library for AuthorizationManagementClient

Installation and Usage

npm install --save @datafire/azure_authorization_authorization_rolebasedcalls

let azure_authorization_authorization_rolebasedcalls = require('@datafire/azure_authorization_authorization_rolebasedcalls').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

ProviderOperationsMetadata_List

Gets provider operations metadata for all resource providers.

azure_authorization_authorization_rolebasedcalls.ProviderOperationsMetadata_List({
  "api-version": ""
}, context)

Input

• input object
  • api-version required string: The API version to use for this operation.
  • $expand string: Specifies whether to expand the values.

Output

• output ProviderOperationsMetadataListResult

ProviderOperationsMetadata_Get

Gets provider operations metadata for the specified resource provider.

azure_authorization_authorization_rolebasedcalls.ProviderOperationsMetadata_Get({
  "resourceProviderNamespace": "",
  "api-version": ""
}, context)

Input

• input object
  • resourceProviderNamespace required string: The namespace of the resource provider.
  • api-version required string: The API version to use for this operation.
  • $expand string: Specifies whether to expand the values.

Output

• output ProviderOperationsMetadata

RoleAssignments_List

Gets all role assignments for the subscription.

azure_authorization_authorization_rolebasedcalls.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_rolebasedcalls.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

Permissions_ListForResourceGroup

Gets all permissions the caller has for a resource group.

azure_authorization_authorization_rolebasedcalls.Permissions_ListForResourceGroup({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • api-version required string: The API version to use for this operation.
  • subscriptionId required string: The ID of the target subscription.

Output

• output PermissionGetResult

Permissions_ListForResource

Gets all permissions the caller has for a resource.

azure_authorization_authorization_rolebasedcalls.Permissions_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 the permissions for.
  • api-version required string: The API version to use for this operation.
  • subscriptionId required string: The ID of the target subscription.

Output

• output PermissionGetResult

RoleAssignments_ListForResource

Gets role assignments for a resource.

azure_authorization_authorization_rolebasedcalls.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_rolebasedcalls.RoleAssignments_DeleteById({
  "roleId": "",
  "api-version": ""
}, context)

Input

• input object
  • roleId 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_rolebasedcalls.RoleAssignments_GetById({
  "roleId": "",
  "api-version": ""
}, context)

Input

• input object
  • roleId 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_rolebasedcalls.RoleAssignments_CreateById({
  "roleId": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

• input object
  • roleId 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_rolebasedcalls.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_rolebasedcalls.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_rolebasedcalls.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_rolebasedcalls.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

RoleDefinitions_List

Get all role definitions that are applicable at scope and above.

azure_authorization_authorization_rolebasedcalls.RoleDefinitions_List({
  "scope": "",
  "api-version": ""
}, context)

Input

• input object
  • scope required string: The scope of the role definition.
  • $filter string: The filter to apply on the operation. Use atScopeAndBelow filter to search below the given scope as well.
  • api-version required string: The API version to use for this operation.

Output

• output RoleDefinitionListResult

RoleDefinitions_Delete

Deletes a role definition.

azure_authorization_authorization_rolebasedcalls.RoleDefinitions_Delete({
  "scope": "",
  "roleDefinitionId": "",
  "api-version": ""
}, context)

Input

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

Output

• output RoleDefinition

RoleDefinitions_Get

Get role definition by name (GUID).

azure_authorization_authorization_rolebasedcalls.RoleDefinitions_Get({
  "scope": "",
  "roleDefinitionId": "",
  "api-version": ""
}, context)

Input

• input object
  • scope required string: The scope of the role definition.
  • roleDefinitionId required string: The ID of the role definition.
  • api-version required string: The API version to use for this operation.

Output

• output RoleDefinition

RoleDefinitions_CreateOrUpdate

Creates or updates a role definition.

azure_authorization_authorization_rolebasedcalls.RoleDefinitions_CreateOrUpdate({
  "scope": "",
  "roleDefinitionId": "",
  "roleDefinition": null,
  "api-version": ""
}, context)

Input

• input object
  • scope required string: The scope of the role definition.
  • roleDefinitionId required string: The ID of the role definition.
  • roleDefinition required RoleDefinition
  • api-version required string: The API version to use for this operation.

Output

• output RoleDefinition

Definitions

Permission

• Permission object: Role definition permissions.
  • actions array: Allowed actions.
    • items string
  • dataActions array: Allowed Data actions.
    • items string
  • notActions array: Denied actions.
    • items string
  • notDataActions array: Denied Data actions.
    • items string

PermissionGetResult

• PermissionGetResult object: Permissions information.
  • nextLink string: The URL to use for getting the next set of results.
  • value array: An array of permissions.
    • items Permission

ProviderOperation

• ProviderOperation object: Operation
  • description string: The operation description.
  • displayName string: The operation display name.
  • isDataAction boolean: The dataAction flag to specify the operation type.
  • name string: The operation name.
  • origin string: The operation origin.
  • properties object: The operation properties.

ProviderOperationsMetadata

• ProviderOperationsMetadata object: Provider Operations metadata
  • displayName string: The provider display name.
  • id string: The provider id.
  • name string: The provider name.
  • operations array: The provider operations.
    • items ProviderOperation
  • resourceTypes array: The provider resource types
    • items ResourceType
  • type string: The provider type.

ProviderOperationsMetadataListResult

• ProviderOperationsMetadataListResult object: Provider operations metadata list
  • nextLink string: The URL to use for getting the next set of results.
  • value array: The list of providers.
    • items ProviderOperationsMetadata

ResourceType

• ResourceType object: Resource Type
  • displayName string: The resource type display name.
  • name string: The resource type name.
  • operations array: The resource type operations.
    • items ProviderOperation

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 roleassignment
  • 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 delgation 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 roleassignment
  • principalId string: The principal ID.
  • roleDefinitionId string: The role definition ID.
  • scope string: The role assignment scope.

RoleDefinition

• RoleDefinition object: Role definition.
  • id string: The role definition ID.
  • name string: The role definition name.
  • properties RoleDefinitionProperties
  • type string: The role definition type.

RoleDefinitionFilter

• RoleDefinitionFilter object: Role Definitions filter
  • roleName string: Returns role definition with the specific name.
  • type string: Returns role definition with the specific type.

RoleDefinitionListResult

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

RoleDefinitionProperties

• RoleDefinitionProperties object: Role definition properties.
  • assignableScopes array: Role definition assignable scopes.
    • items string
  • description string: The role definition description.
  • permissions array: Role definition permissions.
    • items Permission
  • roleName string: The role name.
  • type string: The role type.