Labs - Create Or Update
既存のラボを作成または置き換えます。 この操作が完了するまでに時間がかかる場合があります。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}?api-version=2018-09-15
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
name
|
path | True |
string |
ラボの名前。 |
resource
|
path | True |
string |
リソース グループの名前。 |
subscription
|
path | True |
string |
サブスクリプション ID。 |
api-version
|
query | True |
string |
クライアント API のバージョン。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
___location |
string |
リソースの場所。 |
properties.announcement |
このラボに関連付けられているラボのお知らせのプロパティ |
|
properties.environmentPermission |
環境をプロビジョニングするときにユーザーに付与されるアクセス権 |
|
properties.extendedProperties |
object |
実験機能に使用されるラボの拡張プロパティ |
properties.labStorageType |
ラボで使用されるストレージの種類。 Premium または Standard のいずれかを指定できます。 既定値は Premium です。 |
|
properties.mandatoryArtifactsResourceIdsLinux |
string[] |
ユーザーが指定した成果物の前に、既定ですべての Linux VM の作成に適用する必要がある成果物リソース ID の順序付きリスト。 |
properties.mandatoryArtifactsResourceIdsWindows |
string[] |
ユーザーが指定した成果物の前に、既定ですべての Windows VM の作成に適用する必要がある成果物リソース ID の順序付きリスト。 |
properties.premiumDataDisks |
Premium データ ディスクの使用を有効にする設定。 値が "有効" の場合、Standard または Premium データ ディスクの作成が許可されます。 値が 'Disabled' の場合、Standard データ ディスクの作成のみが許可されます。 |
|
properties.support |
このラボに関連付けられているラボ サポート メッセージのプロパティ |
|
tags |
object |
リソースのタグ。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
わかりました |
|
201 Created |
作成 |
|
Other Status Codes |
不正なリクエスト |
セキュリティ
azure_auth
OAuth2 暗黙的な許可
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | Microsoft Azure にアクセスする |
例
Labs_CreateOrUpdate
要求のサンプル
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}?api-version=2018-09-15
{
"properties": {
"labStorageType": "{Standard|Premium}"
},
"___location": "{___location}",
"tags": {
"tagName1": "tagValue1"
}
}
応答のサンプル
{
"properties": {
"labStorageType": "Standard",
"mandatoryArtifactsResourceIdsLinux": [],
"mandatoryArtifactsResourceIdsWindows": [],
"createdDate": "2018-10-01T18:40:48.1739018-07:00",
"premiumDataDisks": "Disabled",
"environmentPermission": "Reader",
"announcement": {
"title": "",
"markdown": "",
"enabled": "Disabled",
"expired": false
},
"support": {
"enabled": "Disabled",
"markdown": ""
},
"provisioningState": "Creating",
"uniqueIdentifier": "{uniqueIdentifier}"
},
"id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}",
"name": "{labName}",
"type": "Microsoft.DevTestLab/labs",
"___location": "{___location}",
"tags": {
"tagName1": "tagValue1"
}
}
{
"properties": {
"labStorageType": "Standard",
"mandatoryArtifactsResourceIdsLinux": [],
"mandatoryArtifactsResourceIdsWindows": [],
"createdDate": "2018-10-01T18:40:48.1739018-07:00",
"premiumDataDisks": "Disabled",
"environmentPermission": "Reader",
"announcement": {
"title": "",
"markdown": "",
"enabled": "Disabled",
"expired": false
},
"support": {
"enabled": "Disabled",
"markdown": ""
},
"provisioningState": "Creating",
"uniqueIdentifier": "{uniqueIdentifier}"
},
"id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}",
"name": "{labName}",
"type": "Microsoft.DevTestLab/labs",
"___location": "{___location}",
"tags": {
"tagName1": "tagValue1"
}
}
定義
名前 | 説明 |
---|---|
Cloud |
REST 要求からのエラー。 |
Cloud |
REST 要求からのエラーの本文。 |
Enable |
スケジュールの状態 (有効、無効) |
Environment |
環境をプロビジョニングするときにユーザーに付与されるアクセス権 |
Lab |
ラボ。 |
Lab |
ラボのお知らせバナーのプロパティ |
Lab |
ラボのサポート バナーのプロパティ |
Premium |
Premium データ ディスクの使用を有効にする設定。 値が "有効" の場合、Standard または Premium データ ディスクの作成が許可されます。 値が 'Disabled' の場合、Standard データ ディスクの作成のみが許可されます。 |
Storage |
ディスクのストレージの種類 (Standard、Premium など)。 |
CloudError
REST 要求からのエラー。
名前 | 型 | 説明 |
---|---|---|
error |
発生したクラウド エラー |
CloudErrorBody
REST 要求からのエラーの本文。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
details |
内部エラー。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーターゲット。 |
EnableStatus
スケジュールの状態 (有効、無効)
値 | 説明 |
---|---|
Disabled | |
Enabled |
EnvironmentPermission
環境をプロビジョニングするときにユーザーに付与されるアクセス権
値 | 説明 |
---|---|
Contributor | |
Reader |
Lab
ラボ。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
id |
string |
リソースの識別子。 |
|
___location |
string |
リソースの場所。 |
|
name |
string |
リソースの名前。 |
|
properties.announcement |
このラボに関連付けられているラボのお知らせのプロパティ |
||
properties.artifactsStorageAccount |
string |
ラボのアーティファクト ストレージ アカウント。 |
|
properties.createdDate |
string (date-time) |
ラボの作成日。 |
|
properties.defaultPremiumStorageAccount |
string |
ラボの既定の Premium Storage アカウント。 |
|
properties.defaultStorageAccount |
string |
ラボの既定のストレージ アカウント。 |
|
properties.environmentPermission |
環境をプロビジョニングするときにユーザーに付与されるアクセス権 |
||
properties.extendedProperties |
object |
実験機能に使用されるラボの拡張プロパティ |
|
properties.labStorageType | 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 |
Premium データ ディスクの使用を有効にする設定。 値が "有効" の場合、Standard または Premium データ ディスクの作成が許可されます。 値が 'Disabled' の場合、Standard データ ディスクの作成のみが許可されます。 |
||
properties.provisioningState |
string |
リソースのプロビジョニング状態。 |
|
properties.publicIpId |
string |
ラボのロード バランサーのパブリック IP アドレス。 |
|
properties.support |
このラボに関連付けられているラボ サポート メッセージのプロパティ |
||
properties.uniqueIdentifier |
string |
リソースの一意の変更できない識別子 (Guid)。 |
|
properties.vaultName |
string |
ラボのキー コンテナー。 |
|
properties.vmCreationResourceGroup |
string |
すべての新しいラボ仮想マシンが作成されるリソース グループ。 DevTest Labs でリソース グループの作成を管理できるようにするには、この値を null に設定します。 |
|
tags |
object |
リソースのタグ。 |
|
type |
string |
リソースの種類。 |
LabAnnouncementProperties
ラボのお知らせバナーのプロパティ
名前 | 型 | 説明 |
---|---|---|
enabled |
ラボのお知らせは、この時点でアクティブ/有効になっていますか? |
|
expirationDate |
string (date-time) |
お知らせの有効期限が切れる時刻 (無期限の場合は null) |
expired |
boolean |
このお知らせの有効期限は切れていますか? |
markdown |
string |
このラボが UI に表示するマークダウン テキスト (存在する場合)。 空または null のままにすると、何も表示されません。 |
provisioningState |
string |
リソースのプロビジョニング状態。 |
title |
string |
ラボのお知らせのプレーン テキスト タイトル |
uniqueIdentifier |
string |
リソースの一意の変更できない識別子 (Guid)。 |
LabSupportProperties
ラボのサポート バナーのプロパティ
名前 | 型 | 説明 |
---|---|---|
enabled |
ラボ サポート バナーは、現時点でアクティブ/有効になっていますか? |
|
markdown |
string |
このラボが UI に表示するマークダウン テキスト (存在する場合)。 空または null のままにすると、何も表示されません。 |
PremiumDataDisk
Premium データ ディスクの使用を有効にする設定。 値が "有効" の場合、Standard または Premium データ ディスクの作成が許可されます。 値が 'Disabled' の場合、Standard データ ディスクの作成のみが許可されます。
値 | 説明 |
---|---|
Disabled | |
Enabled |
StorageType
ディスクのストレージの種類 (Standard、Premium など)。
値 | 説明 |
---|---|
Premium | |
Standard | |
StandardSSD |