UserRole [SPFSDK][VMMREF]

 

Applies To: Windows Azure Pack

The UserRole entity represents a Virtual Machine Manager (VMM) user role, such as Administrator or SelfServiceUser.

Inheritance Hierarchy

VMM
  UserRole

Entity Properties

For more information about how the properties of an entity interact with HTTP operations, see Entity Basics.

Name	Create (POST)	Read (GET)	Update (PUT)	Delete (DELETE)	Type	Nullable	Description
ID	-	Optional	Required	Required	Edm.Guid	False	Key Property The identifier of the user role.
AddCloudResourceExtension	-	Optional	Optional	-	Collection(UserRoleCloudResourceExtension)	False	Cloud resource extensions that will be added to the user role.
AddMember	-	Optional	Optional	-	Collection(Edm.String)	False	Identifiers of each member that will be added to the user role.
AddResource	-	Optional	Optional	-	Collection(UserRoleResource)	False	Resources that will be added to the user role.
AddScope	-	Optional	Optional	-	Collection(UserRoleScope)	False	Scopes that will be added to the user role.
CloudPermission	-	Optional	-	-	Collection(UserRoleCloudPermission)	False	Cloud permissions associated with the user role.
CloudPermissionInput	-	Optional	Optional	-	Collection(UserRoleCloudPermissionInput)	False	Cloud permission input associated with the user role.
Description	Optional	Optional	Optional	-	Edm.String	True	A description of the user role.
Members	-	Optional	-	-	Collection(Edm.String)	False	Current members of the user role.
Name	Required	Optional	Optional	-	Edm.String	True	The name of the user role.
ParentUserRoleId	-	Optional	-	-	Edm.Guid	True	The identifier of the parent user role.
Permission	-	Optional	-	-	Collection(Edm.String)	False	Permissions associated with the user role.
PermissionInput	-	Optional	Optional	-	Collection(UserRolePermission)	False	Permissions input associated with the user role.
Profile	-	Optional	-	-	Edm.String	True	Profile associated with the user role.
Quotas	-	Optional	-	-	Collection(UserRoleScope)	False	The user role scopes associated with the user role.
RemoveCloudResourceExtension	-	Optional	Optional	-	Collection(UserRoleCloudResourceExtension)	False	Cloud resource extensions that will be removed from the user role.
RemoveMember	-	Optional	Optional	-	Collection(Edm.String)	False	Members that will be removed from this user role.
RemoveResource	-	Optional	Optional Optional	-	Collection(UserRoleResource)	False	Resources that will be removed from this user role.
RemoveScope	-	Optional	-	-	Collection(UserRoleScope)	False	Scopes to that will be removed from this user role.
UserRoleDataPath	-	Optional	Optional	-	Collection(UserRoleDataPath)	False	Library share paths that the user role can upload data to.
UserRoleProfile	Required	Optional	-	-	Edm.String	True	The current user role profile associated with the user role. Either TenantAdmin or SelfServiceUser.
VMId	-	Optional	-	-	Edm.Guid	True	The identifier of the virtual machine.
VMNetworkQuota	-	Optional	Optional	-	Collection(VMNetworkQuota)	False	The network quotas associated with the user role.
VMTemplateId	-	Optional	-	-	Edm.Guid	True	The identifier of the template the virtual machine is based on.

Relationships

For more information about how the relationships of an entity are used, see Entity Basics.

Name	Relationship Type	From Property	To Entity	To Property
Clouds	Many	Not specified	Cloud [SPFSDK][VMMREF]	Not specified

OData Operations

None

Examples

• Example: Get all user roles

• Example: Get a specific user role by identifier

• Example: Create a new UserRole

• Example: Add a permission to a user role

• Example: Delete an existing user role

See Also

Entities [SPFSDK][VMMREF]
UserRoles Collection [SPFSDK][VMMREF]