Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoleDefinitions

Package version

Class representing a RoleDefinitions.

Hierarchy

  • RoleDefinitions

Index

Constructors

Methods

Constructors

constructor

Methods

createOrUpdate

  • createOrUpdate(scope: string, roleDefinitionId: string, options?: Models.RoleDefinitionsCreateOrUpdateOptionalParams): Promise<Models.RoleDefinitionsCreateOrUpdateResponse>
  • createOrUpdate(scope: string, roleDefinitionId: string, callback: msRest.ServiceCallback<RoleDefinition>): void
  • createOrUpdate(scope: string, roleDefinitionId: string, options: RoleDefinitionsCreateOrUpdateOptionalParams, callback: msRest.ServiceCallback<RoleDefinition>): void

  • Creates or updates a role definition.

    Parameters

    • scope: string

      The scope of the role definition.

    • roleDefinitionId: string

      The ID of the role definition.

    • Optional options: Models.RoleDefinitionsCreateOrUpdateOptionalParams

    Returns Promise<Models.RoleDefinitionsCreateOrUpdateResponse>

    Promise<Models.RoleDefinitionsCreateOrUpdateResponse>

  • Parameters

    • scope: string

      The scope of the role definition.

    • roleDefinitionId: string

      The ID of the role definition.

    • callback: msRest.ServiceCallback<RoleDefinition>

      The callback

    Returns void

  • Parameters

    Returns void

deleteMethod

  • deleteMethod(scope: string, roleDefinitionId: string, options?: msRest.RequestOptionsBase): Promise<Models.RoleDefinitionsDeleteMethodResponse>
  • deleteMethod(scope: string, roleDefinitionId: string, callback: msRest.ServiceCallback<RoleDefinition>): void
  • deleteMethod(scope: string, roleDefinitionId: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RoleDefinition>): void

  • Deletes a role definition.

    Parameters

    • scope: string

      The scope of the role definition.

    • roleDefinitionId: string

      The ID of the role definition to delete.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.RoleDefinitionsDeleteMethodResponse>

    Promise<Models.RoleDefinitionsDeleteMethodResponse>

  • Parameters

    • scope: string

      The scope of the role definition.

    • roleDefinitionId: string

      The ID of the role definition to delete.

    • callback: msRest.ServiceCallback<RoleDefinition>

      The callback

    Returns void

  • Parameters

    • scope: string

      The scope of the role definition.

    • roleDefinitionId: string

      The ID of the role definition to delete.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<RoleDefinition>

      The callback

    Returns void

get

  • get(scope: string, roleDefinitionId: string, options?: msRest.RequestOptionsBase): Promise<Models.RoleDefinitionsGetResponse>
  • get(scope: string, roleDefinitionId: string, callback: msRest.ServiceCallback<RoleDefinition>): void
  • get(scope: string, roleDefinitionId: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RoleDefinition>): void

  • Get role definition by name (GUID).

    Parameters

    • scope: string

      The scope of the role definition.

    • roleDefinitionId: string

      The ID of the role definition.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.RoleDefinitionsGetResponse>

    Promise<Models.RoleDefinitionsGetResponse>

  • Parameters

    • scope: string

      The scope of the role definition.

    • roleDefinitionId: string

      The ID of the role definition.

    • callback: msRest.ServiceCallback<RoleDefinition>

      The callback

    Returns void

  • Parameters

    • scope: string

      The scope of the role definition.

    • roleDefinitionId: string

      The ID of the role definition.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<RoleDefinition>

      The callback

    Returns void

getById

  • getById(roleDefinitionId: string, options?: msRest.RequestOptionsBase): Promise<Models.RoleDefinitionsGetByIdResponse>
  • getById(roleDefinitionId: string, callback: msRest.ServiceCallback<RoleDefinition>): void
  • getById(roleDefinitionId: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RoleDefinition>): void

  • Gets a role definition by ID.

    Parameters

    • roleDefinitionId: string

      The fully qualified role definition ID. Use the format, /subscriptions/{guid}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for subscription level role definitions, or /providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for tenant level role definitions.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.RoleDefinitionsGetByIdResponse>

    Promise<Models.RoleDefinitionsGetByIdResponse>

  • Parameters

    • roleDefinitionId: string

      The fully qualified role definition ID. Use the format, /subscriptions/{guid}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for subscription level role definitions, or /providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for tenant level role definitions.

    • callback: msRest.ServiceCallback<RoleDefinition>

      The callback

    Returns void

  • Parameters

    • roleDefinitionId: string

      The fully qualified role definition ID. Use the format, /subscriptions/{guid}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for subscription level role definitions, or /providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for tenant level role definitions.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<RoleDefinition>

      The callback

    Returns void

list

listNext

  • listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.RoleDefinitionsListNextResponse>
  • listNext(nextPageLink: string, callback: msRest.ServiceCallback<RoleDefinitionListResult>): void
  • listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RoleDefinitionListResult>): void

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

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.RoleDefinitionsListNextResponse>

    Promise<Models.RoleDefinitionsListNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<RoleDefinitionListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<RoleDefinitionListResult>

      The callback

    Returns void

Generated using TypeDoc