Users - Get

ユーザー プロファイルを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}?api-version=2018-09-15
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}?$expand={$expand}&api-version=2018-09-15

URI パラメーター

Name In Required Type Description
labName
path True
  • string

ラボの名前。

name
path True
  • string

ユーザー プロファイルの名前。

resourceGroupName
path True
  • string

リソース グループの名前。

subscriptionId
path True
  • string

サブスクリプション ID です。

api-version
query True
  • string

クライアント API バージョン。

$expand
query
  • string

$expand クエリを指定します。 例: 'properties($select=identity)'

応答

Name Type Description
200 OK

OK

Other Status Codes

BadRequest

セキュリティ

azure_auth

OAuth2 暗黙的な付与

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation アクセス Microsoft Azure

Users_Get

Sample Request

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{devtestlabName}/users/{userName}?api-version=2018-09-15

Sample Response

{
  "properties": {
    "identity": {
      "principalName": "{principalName}",
      "principalId": "{principalId}",
      "tenantId": "{tenantId}",
      "objectId": "{objectId}",
      "appId": "{appId}"
    },
    "secretStore": {
      "keyVaultUri": "{keyVaultUri}",
      "keyVaultId": "{keyVaultId}"
    },
    "createdDate": "2018-10-01T18:40:48.1739018-07:00",
    "provisioningState": "Succeeded",
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "id": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}",
  "name": "{userName}",
  "type": "Microsoft.DevTestLab/labs/users",
  "location": "{location}",
  "tags": {
    "tagName1": "tagValue1"
  }
}

定義

CloudError

REST 要求からのエラー。

CloudErrorBody

REST 要求からのエラーの本文。

User

ラボ ユーザーのプロファイル。

UserIdentity

ラボ ユーザーの ID 属性。

UserSecretStore

ユーザーのシークレット ストアのプロパティ。

CloudError

REST 要求からのエラー。

Name Type Description
error

発生したクラウド エラー

CloudErrorBody

REST 要求からのエラーの本文。

Name Type Description
code
  • string

エラー コード。

details

内部エラー。

message
  • string

エラー メッセージ。

target
  • string

エラーターゲット。

User

ラボ ユーザーのプロファイル。

Name Type Description
id
  • string

リソースの識別子。

location
  • string

リソースの場所。

name
  • string

リソースの名前。

properties.createdDate
  • string

ユーザー プロファイルの作成日。

properties.identity

ユーザーの ID。

properties.provisioningState
  • string

リソースのプロビジョニング状態。

properties.secretStore

ユーザーのシークレット ストア。

properties.uniqueIdentifier
  • string

リソースの一意の変更できない識別子 (Guid)。

tags
  • object

リソースのタグ。

type
  • string

リソースの型。

UserIdentity

ラボ ユーザーの ID 属性。

Name Type Description
appId
  • string

要求を行うクライアント JWT のアプリ ID に設定します。

objectId
  • string

要求を行うクライアント JWT のオブジェクト ID に設定します。 すべてのユーザーがオブジェクト ID を持っているわけではありません。たとえば、CSP (リセラー) のシナリオでは、オブジェクト ID は使用できません。

principalId
  • string

要求を行うクライアント JWT のプリンシパル ID に設定します。 サービス プリンシパルにはプリンシパル ID がありません。

principalName
  • string

要求を行うクライアント JWT のプリンシパル名/UPN に設定します。

tenantId
  • string

要求を行うクライアント JWT のテナント ID に設定します。

UserSecretStore

ユーザーのシークレット ストアのプロパティ。

Name Type Description
keyVaultId
  • string

ユーザーのキー コンテナーの ID。

keyVaultUri
  • string

ユーザーのキー コンテナーの URI。