次の方法で共有


Users - List

特定のラボのユーザー プロファイルを一覧表示します。

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

URI パラメーター

名前 / 必須 説明
labName
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)'

$filter
query

string

操作に適用するフィルター。 例: '$filter=contains(name,'myName')

$orderby
query

string

OData 表記を使用した結果の順序付け式。 例: '$orderby=name desc'

$top
query

integer

int32

操作から返されるリソースの最大数。 例: '$top=10'

応答

名前 説明
200 OK

UserList

OK

Other Status Codes

CloudError

BadRequest

セキュリティ

azure_auth

OAuth2 暗黙的な許可

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation Microsoft Azure にアクセスする

Users_List

要求のサンプル

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

応答のサンプル

{
  "value": [
    {
      "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 属性。

UserList

リスト操作の応答。

UserSecretStore

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

CloudError

REST 要求からのエラー。

名前 説明
error

CloudErrorBody

発生したクラウド エラー

CloudErrorBody

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

名前 説明
code

string

エラー コード。

details

CloudErrorBody[]

内部エラー。

message

string

エラー メッセージ。

target

string

エラーのターゲット。

User

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

名前 説明
id

string

リソースの識別子。

location

string

リソースの場所。

name

string

リソースの名前。

properties.createdDate

string

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

properties.identity

UserIdentity

ユーザーの ID。

properties.provisioningState

string

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

properties.secretStore

UserSecretStore

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

properties.uniqueIdentifier

string

リソースの一意の不変識別子 (Guid)。

tags

object

リソースのタグ。

type

string

リソースの型。

UserIdentity

ラボ ユーザーの ID 属性。

名前 説明
appId

string

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

objectId

string

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

principalId

string

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

principalName

string

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

tenantId

string

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

UserList

リスト操作の応答。

名前 説明
nextLink

string

次の結果セットのリンク。

value

User[]

リスト操作の結果。

UserSecretStore

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

名前 説明
keyVaultId

string

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

keyVaultUri

string

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