Share via

Read (GET) a UserRole [SPFSDK][VMMREF]

  • Article

 

Applies To: Windows Azure Pack

Get a UserRole [SPFSDK][VMMREF] entity by using the HTTP GET operation.

Here is a list of examples related to this collection operation.

  • Example: Get all user roles

  • Example: Get a specific user role by identifier

Request

For more information about returning multiple entities, see Common GET HTTP Info.

For more information about the placeholders used in the URI, see URL placeholders.

Method

Request URI

HTTP Version

GET

https://{server-name}:{auth-port}/{subscription-id}/services/systemcenter/vmm/UserRoles(ID=Guid'[value]')

HTTP/1.1

GET

https://{server-name}:{auth-port}/{subscription-id}/services/systemcenter/vmm/UserRoles

HTTP/1.1

Request URI Parameters

URI Parameter

Description

ID

[Edm.Guid] The type identifier of the user role.

Request Headers

This operation does not use any non-standard request headers.

For more information about the common request headers used by this operation, see Common HTTP request information.

Request Body

None

Response

Response Codes

This operation does not return any non-standard OData response codes. If successful, it will return code 200 OK.

Response Headers

This operation does not use any non-standard response headers.

For more information about the common response headers used by this operation, see Common HTTP response information.

Response Body

The response body will contain either (depending on the request headers) an XML or JSON encoded UserRole [SPFSDK][VMMREF] entity or entities. Here is the response body of a single entity.

{
  "odata.metadata": "https://contoso.com:30005/ae122d5f-3aab-4d75-ad48-d6593246a49e/services/systemcenter/vmm/$metadata#UserRoles/@Element",
  "AddMember": [],
  "AddResource": [],
  "AddScope": [],
  "AddCloudResourceExtension": [],
  "Description": null,
  "ID": "ae122d5f-3aab-4d75-ad48-d6593246a49e",
  "Members": [],
  "Name": "tenant@fabrikam.com_ae122d5f-3aab-4d75-ad48-d6593246a49e",
  "ParentUserRoleId": null,
  "Permission": [
    "Create",
    "PauseAndResume",
    "Start",
    "Stop",
    "AllowLocalAdmin",
    "RemoteConnect",
    "Remove",
    "Shutdown",
    "Checkpoint",
    "Store",
    "Save",
    "Author",
    "CanShare",
    "CanReceive",
    "CreateFromVHDOrTemplate",
    "CheckpointRestoreOnly",
    "AuthorVMNetwork"
  ],
  "CloudPermission": [],
  "Profile": "TenantAdmin",
  "Quotas": [
    {
      "Scope": "10f8e459-e7c3-4c40-b47c-b8f758ef4dc1",
      "StampId": null,
      "ScopeType": "Cloud",
      "RoleCPUCount": null,
      "RoleMemoryMB": null,
      "RoleStorageGB": null,
      "RoleCustomQuotaCount": null,
      "RoleVMCount": null,
      "MemberCPUCount": null,
      "MemberMemoryMB": null,
      "MemberStorageGB": null,
      "MemberCustomQuotaCount": null,
      "MemberVMCount": null
    }
  ],
  "RemoveMember": [],
  "UserRoleProfile": null,
  "PermissionInput": [],
  "CloudPermissionInput": [],
  "RemoveResource": [],
  "RemoveScope": [],
  "RemoveCloudResourceExtension": [],
  "VMId": null,
  "VMTemplateId": null,
  "UserRoleDataPath": [],
  "VMNetworkQuota": [
    {
      "StampId": null,
      "VMNetworkMaximum": null,
      "VMNetworkMaximumPerUser": null,
      "VPNConnectionMaximum": 99,
      "VPNConnectionMaximumPerUser": 99,
      "VMNetworkVPNMaximumBandwidthInKbps": null,
      "VMNetworkVPNMaximumBandwidthOutKbps": null,
      "RemoveVMNetworkMaximum": null,
      "RemoveVMNetworkMaximumPerUser": null,
      "RemoveVPNConnectionMaximum": null,
      "RemoveVPNConnectionMaximumPerUser": null,
      "RemoveVMNetworkVPNMaximumBandwidthIn": null,
      "RemoveVMNetworkVPNMaximumBandwidthOut": null
    }
  ]
}

Example: Get all user roles

This example reads all the of the user roles.

For more information about how to get started with using the code examples provided in this programming guide, see Program in Visual Studio with the Windows Azure Pack IaaS Resource Provider [SPFSDK].

var userRoles = vmmService.UserRoles.ToList();

HTTP Request

GET https://contoso.com:30005/ae122d5f-3aab-4d75-ad48-d6593246a49e/services/systemcenter/vmm/UserRoles HTTP/1.1
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/json;odata=minimalmetadata
Accept-Charset: UTF-8
DataServiceUrlConventions: KeyAsSegment
User-Agent: Microsoft ADO.NET Data Services
Authorization: Bearer {ENCODED AUTHENTICATION TOKEN}
x-ms-principal-id: tenant@fabrikam.com
Host: contoso.com:30005

HTTP Response

HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 1672
Content-Type: application/json; odata=minimalmetadata; streaming=true; charset=utf-8
Server: Microsoft-IIS/8.5
X-Content-Type-Options: nosniff
request-id: d3df681c-b278-0000-d860-e3d378b2cf01
DataServiceVersion: 3.0;
Server: Microsoft-IIS/8.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
X-Powered-By: ASP.NET
Date: Fri, 10 Oct 2014 16:56:38 GMT

{"odata.metadata":"https://contoso.com:30005/ae122d5f-3aab-4d75-ad48-d6593246a49e/services/systemcenter/vmm/$metadata#UserRoles","value":[{"AddMember":[],"AddResource":[],"AddScope":[],"AddCloudResourceExtension":[],"Description":null,"ID":"ae122d5f-3aab-4d75-ad48-d6593246a49e","Members":[],"Name":"tenant@fabrikam.com_ae122d5f-3aab-4d75-ad48-d6593246a49e","ParentUserRoleId":null,"Permission":["Create","PauseAndResume","Start","Stop","AllowLocalAdmin","RemoteConnect","Remove","Shutdown","Checkpoint","Store","Save","Author","CanShare","CanReceive","CreateFromVHDOrTemplate","CheckpointRestoreOnly","AuthorVMNetwork"],"CloudPermission":[],"Profile":"TenantAdmin","Quotas":[{"Scope":"10f8e459-e7c3-4c40-b47c-b8f758ef4dc1","StampId":null,"ScopeType":"Cloud","RoleCPUCount":null,"RoleMemoryMB":null,"RoleStorageGB":null,"RoleCustomQuotaCount":null,"RoleVMCount":null,"MemberCPUCount":null,"MemberMemoryMB":null,"MemberStorageGB":null,"MemberCustomQuotaCount":null,"MemberVMCount":null}],"RemoveMember":[],"UserRoleProfile":null,"PermissionInput":[],"CloudPermissionInput":[],"RemoveResource":[],"RemoveScope":[],"RemoveCloudResourceExtension":[],"VMId":null,"VMTemplateId":null,"UserRoleDataPath":[],"VMNetworkQuota":[{"StampId":null,"VMNetworkMaximum":null,"VMNetworkMaximumPerUser":null,"VPNConnectionMaximum":99,"VPNConnectionMaximumPerUser":99,"VMNetworkVPNMaximumBandwidthInKbps":null,"VMNetworkVPNMaximumBandwidthOutKbps":null,"RemoveVMNetworkMaximum":null,"RemoveVMNetworkMaximumPerUser":null,"RemoveVPNConnectionMaximum":null,"RemoveVPNConnectionMaximumPerUser":null,"RemoveVMNetworkVPNMaximumBandwidthIn":null,"RemoveVMNetworkVPNMaximumBandwidthOut":null}]}]}

Example: Get a specific user role by identifier

This example reads a specific user role.

For more information about how to get started with using the code examples provided in this programming guide, see Program in Visual Studio with the Windows Azure Pack IaaS Resource Provider [SPFSDK].

Guid userRoleId = new Guid("ae122d5f-3aab-4d75-ad48-d6593246a49e");

var userRole = vmmService.UserRoles.Where(u => u.ID == userRoleId).First();

HTTP Request

GET https://contoso.com:30005/ae122d5f-3aab-4d75-ad48-d6593246a49e/services/systemcenter/vmm/UserRoles/ae122d5f-3aab-4d75-ad48-d6593246a49e HTTP/1.1
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/json;odata=minimalmetadata
Accept-Charset: UTF-8
DataServiceUrlConventions: KeyAsSegment
User-Agent: Microsoft ADO.NET Data Services
Authorization: Bearer {ENCODED AUTHENTICATION TOKEN}
x-ms-principal-id: tenant@fabrikam.com
Host: contoso.com:30005

HTTP Response

HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 1669
Content-Type: application/json; odata=minimalmetadata; streaming=true; charset=utf-8
Server: Microsoft-IIS/8.5
X-Content-Type-Options: nosniff
request-id: d3df681c-b278-0000-3161-e3d378b2cf01
DataServiceVersion: 3.0;
Server: Microsoft-IIS/8.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
X-Powered-By: ASP.NET
Date: Fri, 10 Oct 2014 16:56:55 GMT

{"odata.metadata":"https://contoso.com:30005/ae122d5f-3aab-4d75-ad48-d6593246a49e/services/systemcenter/vmm/$metadata#UserRoles/@Element","AddMember":[],"AddResource":[],"AddScope":[],"AddCloudResourceExtension":[],"Description":null,"ID":"ae122d5f-3aab-4d75-ad48-d6593246a49e","Members":[],"Name":"tenant@fabrikam.com_ae122d5f-3aab-4d75-ad48-d6593246a49e","ParentUserRoleId":null,"Permission":["Create","PauseAndResume","Start","Stop","AllowLocalAdmin","RemoteConnect","Remove","Shutdown","Checkpoint","Store","Save","Author","CanShare","CanReceive","CreateFromVHDOrTemplate","CheckpointRestoreOnly","AuthorVMNetwork"],"CloudPermission":[],"Profile":"TenantAdmin","Quotas":[{"Scope":"10f8e459-e7c3-4c40-b47c-b8f758ef4dc1","StampId":null,"ScopeType":"Cloud","RoleCPUCount":null,"RoleMemoryMB":null,"RoleStorageGB":null,"RoleCustomQuotaCount":null,"RoleVMCount":null,"MemberCPUCount":null,"MemberMemoryMB":null,"MemberStorageGB":null,"MemberCustomQuotaCount":null,"MemberVMCount":null}],"RemoveMember":[],"UserRoleProfile":null,"PermissionInput":[],"CloudPermissionInput":[],"RemoveResource":[],"RemoveScope":[],"RemoveCloudResourceExtension":[],"VMId":null,"VMTemplateId":null,"UserRoleDataPath":[],"VMNetworkQuota":[{"StampId":null,"VMNetworkMaximum":null,"VMNetworkMaximumPerUser":null,"VPNConnectionMaximum":99,"VPNConnectionMaximumPerUser":99,"VMNetworkVPNMaximumBandwidthInKbps":null,"VMNetworkVPNMaximumBandwidthOutKbps":null,"RemoveVMNetworkMaximum":null,"RemoveVMNetworkMaximumPerUser":null,"RemoveVPNConnectionMaximum":null,"RemoveVPNConnectionMaximumPerUser":null,"RemoveVMNetworkVPNMaximumBandwidthIn":null,"RemoveVMNetworkVPNMaximumBandwidthOut":null}]}

See Also

UserRoles Collection [SPFSDK][VMMREF]
UserRole [SPFSDK][VMMREF]