Labs - Create Or Update

サービス:: Dev Test Labs

API バージョン:: 2018-09-15

既存のラボを作成または置き換えます。この操作が完了するまでに時間がかかる場合があります。

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

URI パラメーター

名前	/	必須	型	説明
name	path	True	string	ラボの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前は大文字と小文字が区別されます。
subscriptionId	path	True	string minLength: 1	ターゲットサブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
location	string	リソースが存在する地理的な場所
properties.announcement	LabAnnouncementProperties	このラボに関連付けられているラボのお知らせのプロパティ
properties.environmentPermission	EnvironmentPermission	環境をプロビジョニングするときにユーザーに付与されるアクセス権
properties.extendedProperties	object	実験機能に使用されるラボの拡張プロパティ
properties.labStorageType	StorageType	ラボで使用されるストレージの種類。 Premium または Standard のいずれかを指定できます。既定値は Premium です。
properties.mandatoryArtifactsResourceIdsLinux	string[]	ユーザーが指定した成果物の前に、既定ですべての Linux VM の作成に適用する必要がある成果物リソース ID の順序付きリスト。
properties.mandatoryArtifactsResourceIdsWindows	string[]	ユーザーが指定した成果物の前に、既定ですべての Windows VM の作成に適用する必要がある成果物リソース ID の順序付きリスト。
properties.premiumDataDisks	PremiumDataDisk	Premium データディスクの使用を有効にする設定。値が "有効" の場合、Standard または Premium データディスクの作成が許可されます。値が 'Disabled' の場合、Standard データディスクの作成のみが許可されます。
properties.support	LabSupportProperties	このラボに関連付けられているラボサポートメッセージのプロパティ
tags	object	リソースタグ。

応答

名前	型	説明
200 OK	Lab	リソース 'Lab' 更新操作に成功しました
201 Created	Lab	リソース 'Lab' の作成操作に成功しましたヘッダー Location: string Retry-After: integer
Other Status Codes	ErrorResponse	予期しないエラー応答。

名前

型

説明

200 OK

Lab

リソース 'Lab' 更新操作に成功しました

201 Created

Lab

リソース 'Lab' の作成操作に成功しました

ヘッダー

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Labs_CreateOrUpdate

要求のサンプル

HTTP

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

{
  "location": "{location}",
  "properties": {
    "labStorageType": "{Standard|Premium}"
  },
  "tags": {
    "tagName1": "tagValue1"
  }
}

応答のサンプル

状態コード:: 200

{
  "name": "{labName}",
  "type": "Microsoft.DevTestLab/labs",
  "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}",
  "location": "{location}",
  "properties": {
    "announcement": {
      "enabled": "Disabled",
      "expired": false,
      "markdown": "",
      "title": ""
    },
    "createdDate": "2018-10-01T18:40:48.1739018-07:00",
    "environmentPermission": "Reader",
    "labStorageType": "Standard",
    "mandatoryArtifactsResourceIdsLinux": [],
    "mandatoryArtifactsResourceIdsWindows": [],
    "premiumDataDisks": "Disabled",
    "provisioningState": "Creating",
    "support": {
      "enabled": "Disabled",
      "markdown": ""
    },
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "tags": {
    "tagName1": "tagValue1"
  }
}

状態コード:: 201

{
  "name": "{labName}",
  "type": "Microsoft.DevTestLab/labs",
  "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}",
  "location": "{location}",
  "properties": {
    "announcement": {
      "enabled": "Disabled",
      "expired": false,
      "markdown": "",
      "title": ""
    },
    "createdDate": "2018-10-01T18:40:48.1739018-07:00",
    "environmentPermission": "Reader",
    "labStorageType": "Standard",
    "mandatoryArtifactsResourceIdsLinux": [],
    "mandatoryArtifactsResourceIdsWindows": [],
    "premiumDataDisks": "Disabled",
    "provisioningState": "Creating",
    "support": {
      "enabled": "Disabled",
      "markdown": ""
    },
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "tags": {
    "tagName1": "tagValue1"
  }
}

定義

名前	説明
createdByType	リソースを作成した ID の種類。
EnableStatus	成果物ソースが有効になっているかどうかを示します (値: 有効、無効)。
EnvironmentPermission	環境をプロビジョニングするときにユーザーに付与されるアクセス権
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
Lab	ラボ。
LabAnnouncementProperties	ラボのお知らせバナーのプロパティ
LabSupportProperties	ラボのサポートバナーのプロパティ
PremiumDataDisk	Premium データディスクの使用を有効にする設定。値が "有効" の場合、Standard または Premium データディスクの作成が許可されます。値が 'Disabled' の場合、Standard データディスクの作成のみが許可されます。
StorageType	ディスクのストレージの種類 (Standard、Premium など)。
systemData	リソースの作成と最後の変更に関連するメタデータ。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

EnableStatus

列挙

成果物ソースが有効になっているかどうかを示します (値: 有効、無効)。

値	説明
Enabled
Disabled

EnvironmentPermission

列挙

環境をプロビジョニングするときにユーザーに付与されるアクセス権

値	説明
Reader
Contributor

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

Lab

Object

ラボ。

名前	型	規定値	説明
id	string		リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		リソースが存在する地理的な場所
name	string		リソースの名前
properties.announcement	LabAnnouncementProperties		このラボに関連付けられているラボのお知らせのプロパティ
properties.artifactsStorageAccount	string		ラボのアーティファクトストレージアカウント。
properties.createdDate	string (date-time)		ラボの作成日。
properties.defaultPremiumStorageAccount	string		ラボの既定の Premium Storage アカウント。
properties.defaultStorageAccount	string		ラボの既定のストレージアカウント。
properties.environmentPermission	EnvironmentPermission		環境をプロビジョニングするときにユーザーに付与されるアクセス権
properties.extendedProperties	object		実験機能に使用されるラボの拡張プロパティ
properties.labStorageType	StorageType	Premium	ラボで使用されるストレージの種類。 Premium または Standard のいずれかを指定できます。既定値は Premium です。
properties.loadBalancerId	string		共有 IP アドレスを使用するラボ VM に使用されるロードバランサー。
properties.mandatoryArtifactsResourceIdsLinux	string[]		ユーザーが指定した成果物の前に、既定ですべての Linux VM の作成に適用する必要がある成果物リソース ID の順序付きリスト。
properties.mandatoryArtifactsResourceIdsWindows	string[]		ユーザーが指定した成果物の前に、既定ですべての Windows VM の作成に適用する必要がある成果物リソース ID の順序付きリスト。
properties.networkSecurityGroupId	string		ラボ VM に接続されているネットワークセキュリティグループは、開いているポートを制限するためのネットワークインターフェイスです。
properties.premiumDataDiskStorageAccount	string		ラボの Premium データディスクストレージアカウント。
properties.premiumDataDisks	PremiumDataDisk		Premium データディスクの使用を有効にする設定。値が "有効" の場合、Standard または Premium データディスクの作成が許可されます。値が 'Disabled' の場合、Standard データディスクの作成のみが許可されます。
properties.provisioningState	string		リソースのプロビジョニング状態。
properties.publicIpId	string		ラボのロードバランサーのパブリック IP アドレス。
properties.support	LabSupportProperties		このラボに関連付けられているラボサポートメッセージのプロパティ
properties.uniqueIdentifier	string		リソースの一意の変更できない識別子 (Guid)。
properties.vaultName	string		ラボのキーコンテナー。
properties.vmCreationResourceGroup	string		すべての新しいラボ仮想マシンが作成されるリソースグループ。 DevTest Labs でリソースグループの作成を管理できるようにするには、この値を null に設定します。
systemData	systemData		createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object		リソースタグ。
type	string		リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

LabAnnouncementProperties

Object

ラボのお知らせバナーのプロパティ

名前	型	説明
enabled	EnableStatus	ラボのお知らせは、この時点でアクティブ/有効になっていますか?
expirationDate	string (date-time)	お知らせの有効期限が切れる時刻 (無期限の場合は null)
expired	boolean	このお知らせの有効期限は切れていますか?
markdown	string	このラボが UI に表示するマークダウンテキスト (存在する場合)。空または null のままにすると、何も表示されません。
provisioningState	string	リソースのプロビジョニング状態。
title	string	ラボのお知らせのプレーンテキストタイトル
uniqueIdentifier	string	リソースの一意の変更できない識別子 (Guid)。

LabSupportProperties

Object

ラボのサポートバナーのプロパティ

名前	型	説明
enabled	EnableStatus	ラボサポートバナーは、現時点でアクティブ/有効になっていますか?
markdown	string	このラボが UI に表示するマークダウンテキスト (存在する場合)。空または null のままにすると、何も表示されません。

PremiumDataDisk

列挙

Premium データディスクの使用を有効にする設定。値が "有効" の場合、Standard または Premium データディスクの作成が許可されます。値が 'Disabled' の場合、Standard データディスクの作成のみが許可されます。

値	説明
Disabled
Enabled

StorageType

列挙

ディスクのストレージの種類 (Standard、Premium など)。

値	説明
Standard
Premium
StandardSSD

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有

Labs - Create Or Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

Labs_CreateOrUpdate

要求のサンプル

応答のサンプル

定義

createdByType

EnableStatus

EnvironmentPermission

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Lab

LabAnnouncementProperties

LabSupportProperties

PremiumDataDisk

StorageType

systemData