C# Class Microsoft.Azure.Commands.Resources.Models.Authorization.AuthorizationClient

Show file Open project: Azure/azure-powershell Class Usage Examples

Public Methods

Method	Description
AuthorizationClient ( AzureContext context ) : Hyak.Common	Creates PoliciesClient using AzureContext instance.
CreateRoleAssignment ( Microsoft.Azure.Commands.Resources.Models.Authorization.FilterRoleAssignmentsOptions parameters ) : PSRoleAssignment	Creates new role assignment.
CreateRoleDefinition ( Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition roleDefinition ) : Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition	Creates a new role definition.
FilterRoleAssignments ( Microsoft.Azure.Commands.Resources.Models.Authorization.FilterRoleAssignmentsOptions options, string currentSubscription ) : List	Filters role assignments based on the passed options.
FilterRoleDefinitions ( FilterRoleDefinitionOptions options ) : List
FilterRoleDefinitions ( string name, string scope, bool scopeAndBelow = false ) : List	Filters the existing role Definitions. If name is not provided, all role definitions are fetched.
FilterRoleDefinitionsByCustom ( string scope, bool scopeAndBelow ) : List	Filters the existing role Definitions by CustomRole.
GetAllRoleDefinitionsAtScopeAndBelow ( string scope ) : List	Fetches all existing role Definitions.
GetRoleDefinition ( System.Guid roleId, string scope ) : Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition	Gets a single role definition by the role Id guid.
GetRoleDefinition ( string roleId ) : Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition	Gets a single role definition by a fully qualified role Id
GetSingleRoleDefinitionByName ( string name, string scope ) : Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition
RemoveRoleAssignment ( Microsoft.Azure.Commands.Resources.Models.Authorization.FilterRoleAssignmentsOptions options, string subscriptionId ) : IEnumerable	Deletes a role assignments based on the used options.
RemoveRoleDefinition ( FilterRoleDefinitionOptions options ) : Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition
RemoveRoleDefinition ( System.Guid roleDefinitionId, string scope ) : Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition	Deletes a role definition based on the id.
RemoveRoleDefinition ( string roleDefinitionName, string scope ) : Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition	Deletes a role definition based on the name.
UpdateRoleDefinition ( Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition roleDefinition ) : Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition	Updates a role definiton.

Private Methods

Method	Description
AuthorizationClient ( ) : Hyak.Common
CreateOrUpdateRoleDefinition ( System.Guid roleDefinitionId, Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition roleDefinition ) : Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition
ValidateRoleDefinition ( Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition roleDefinition ) : void

Method Details

AuthorizationClient() public method

Creates PoliciesClient using AzureContext instance.

public AuthorizationClient ( AzureContext context ) : Hyak.Common
context	Microsoft.Azure.Commands.Common.Authentication.Models.AzureContext	The AzureContext instance
return	Hyak.Common

CreateRoleAssignment() public method

Creates new role assignment.

public CreateRoleAssignment ( Microsoft.Azure.Commands.Resources.Models.Authorization.FilterRoleAssignmentsOptions parameters ) : PSRoleAssignment
parameters	Microsoft.Azure.Commands.Resources.Models.Authorization.FilterRoleAssignmentsOptions	The create parameters
return	PSRoleAssignment

CreateRoleDefinition() public method

Creates a new role definition.

public CreateRoleDefinition ( Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition roleDefinition ) : Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition
roleDefinition	Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition	The role definition to create.
return	Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition

FilterRoleAssignments() public method

Filters role assignments based on the passed options.

public FilterRoleAssignments ( Microsoft.Azure.Commands.Resources.Models.Authorization.FilterRoleAssignmentsOptions options, string currentSubscription ) : List
options	Microsoft.Azure.Commands.Resources.Models.Authorization.FilterRoleAssignmentsOptions	The filtering options
currentSubscription	string	The current subscription
return	List

FilterRoleDefinitions() public method

public FilterRoleDefinitions ( FilterRoleDefinitionOptions options ) : List
options	FilterRoleDefinitionOptions
return	List

FilterRoleDefinitions() public method

Filters the existing role Definitions. If name is not provided, all role definitions are fetched.

public FilterRoleDefinitions ( string name, string scope, bool scopeAndBelow = false ) : List
name	string	The role name
scope	string
scopeAndBelow	bool
return	List

FilterRoleDefinitionsByCustom() public method

Filters the existing role Definitions by CustomRole.

public FilterRoleDefinitionsByCustom ( string scope, bool scopeAndBelow ) : List
scope	string
scopeAndBelow	bool
return	List

GetAllRoleDefinitionsAtScopeAndBelow() public method

Fetches all existing role Definitions.

public GetAllRoleDefinitionsAtScopeAndBelow ( string scope ) : List
scope	string
return	List

GetRoleDefinition() public method

Gets a single role definition by the role Id guid.

public GetRoleDefinition ( System.Guid roleId, string scope ) : Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition
roleId	System.Guid	RoleId guid
scope	string
return	Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition

GetRoleDefinition() public method

Gets a single role definition by a fully qualified role Id

public GetRoleDefinition ( string roleId ) : Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition
roleId	string	Fully qualified roleId
return	Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition

GetSingleRoleDefinitionByName() public method

public GetSingleRoleDefinitionByName ( string name, string scope ) : Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition
name	string
scope	string
return	Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition

RemoveRoleAssignment() public method

Deletes a role assignments based on the used options.

public RemoveRoleAssignment ( Microsoft.Azure.Commands.Resources.Models.Authorization.FilterRoleAssignmentsOptions options, string subscriptionId ) : IEnumerable
options	Microsoft.Azure.Commands.Resources.Models.Authorization.FilterRoleAssignmentsOptions	The role assignment filtering options
subscriptionId	string	Current subscription id
return	IEnumerable

RemoveRoleDefinition() public method

public RemoveRoleDefinition ( FilterRoleDefinitionOptions options ) : Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition
options	FilterRoleDefinitionOptions
return	Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition

RemoveRoleDefinition() public method

Deletes a role definition based on the id.

public RemoveRoleDefinition ( System.Guid roleDefinitionId, string scope ) : Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition
roleDefinitionId	System.Guid	The role definition id to delete
scope	string
return	Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition

RemoveRoleDefinition() public method

Deletes a role definition based on the name.

public RemoveRoleDefinition ( string roleDefinitionName, string scope ) : Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition
roleDefinitionName	string	The role definition name.
scope	string
return	Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition

UpdateRoleDefinition() public method

Updates a role definiton.

public UpdateRoleDefinition ( Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition roleDefinition ) : Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition
roleDefinition	Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition	The role definition to update.
return	Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition