ALIYUN::ECD::Desktops - Resource Orchestration Service - Alibaba Cloud ドキュメントセンター

ALIYUN::ECD::Desktops は、1 つ以上のクラウドデスクトップを作成するために使用されます。

構文

{
  "Type": "ALIYUN::ECD::Desktops",
  "Properties": {
    "UserAssignMode": String,
    "PromotionId": String,
    "PolicyGroupId": String,
    "UserName": String,
    "AutoRenew": Boolean,
    "Amount": Integer,
    "DesktopName": String,
    "Hostname": String,
    "Period": Integer,
    "VolumeEncryptionEnabled": Boolean,
    "AutoPay": Boolean,
    "GroupId": String,
    "OfficeSiteId": String,
    "DesktopNameSuffix": Boolean,
    "BundleId": String,
    "EndUserId": List,
    "VpcId": String,
    "ChargeType": String,
    "VolumeEncryptionKey": String,
    "Tags": List,
    "PeriodUnit": String,
    "DirectoryId": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
UserAssignMode	String	いいえ	いいえ	作成するクラウドデスクトップの割り当てモード。	デフォルト値：ALL。有効な値： ALL：EndUserId プロパティを指定した場合、クラウドデスクトップは指定した各正規ユーザーに割り当てられます。 PER_USER：EndUserId プロパティを指定した場合、クラウドデスクトップは指定したすべての正規ユーザーに均等に割り当てられます。この場合、Amount プロパティの値が、EndUserId プロパティで指定された正規ユーザー ID の数で割り切れることを確認する必要があります。説明 EndUserId プロパティを指定しない場合、クラウドデスクトップは正規ユーザーに割り当てられません。
PromotionId	String	いいえ	いいえ	販売プロモーションの ID。	なし。
PolicyGroupId	String	はい	いいえ	ポリシーの ID。	なし。
AutoRenew	Boolean	いいえ	いいえ	自動更新を有効にするかどうかを指定します。	デフォルト値：false。有効な値： true：自動更新を有効にします。更新期間は、クラウドデスクトップの購入時に Period パラメーターに指定したサブスクリプション期間と同じです。 false：自動更新を無効にします。説明このプロパティは、ChargeType プロパティを PrePaid に設定した場合にのみ有効になります。
Amount	Integer	いいえ	いいえ	作成するクラウドデスクトップの数。	有効な値：1 ～ 300。デフォルト値：1。
DesktopName	String	いいえ	いいえ	クラウドデスクトップの名前。	なし。
Hostname	String	いいえ	いいえ	クラウドデスクトップに指定するカスタムホスト名。	カスタムホスト名は、企業 Active Directory（AD）アカウントタイプのワークスペース内の Windows クラウドデスクトップに対してのみ指定できます。クラウドデスクトップを作成する場合、指定するホスト名は次の要件を満たしている必要があります。ホスト名は 2 ～ 15 文字である必要があります。ホスト名には、文字、数字、およびハイフン（-）を含めることができます。ホスト名はハイフン（-）で開始または終了したり、連続したハイフン（-）を含めたり、数字のみを含めることはできません。複数のクラウドデスクトップを作成する場合、指定するホスト名は `name_prefix[begin_number,bits]name_suffix` 形式である必要があります。たとえば、Hostname プロパティを `ecd-[1,4]-test` に設定した場合、最初のクラウドデスクトップのホスト名は `ecd-0001-test` で、2 番目のクラウドデスクトップのホスト名は `ecd-0002-test` です。残りは類推によって推測できます。形式のパラメーターについて、以下に説明します。 `name_prefix`：ホスト名のプレフィックス。 `begin_number,bits`：ホスト名内の順序番号。 `name_suffix`：ホスト名のサフィックス。
Period	Integer	いいえ	いいえ	購入するクラウドデスクトップのサブスクリプション期間。	値の単位は、`PeriodUnit` プロパティによって指定されます。このプロパティは、`ChargeType` プロパティを `PrePaid` に設定した場合にのみ有効になり、必須となります。 `PeriodUnit` プロパティを `Month` に設定した場合の有効な値：1、2、3、および 6。 `PeriodUnit` プロパティを `Year` に設定した場合の有効な値：1、2、3、4、および 5。
VolumeEncryptionEnabled	Boolean	いいえ	いいえ	ディスクの暗号化を有効にするかどうかを指定します。	デフォルト値：false。有効な値： true false
AutoPay	Boolean	いいえ	いいえ	自動支払いを有効にするかどうかを指定します。	デフォルト値：true。有効な値： true：自動支払いを有効にします。 Alibaba Cloud アカウントに残高が十分にあることを確認してください。そうでない場合、注文は無効になります。 false：自動支払いを無効にします。この場合、注文は生成されますが、支払いは行われません。
GroupId	String	いいえ	いいえ	デスクトップグループの ID。	なし。
OfficeSiteId	String	はい	いいえ	ワークスペースの ID。	なし。
DesktopNameSuffix	Boolean	いいえ	いいえ	クラウドデスクトップ名にサフィックスを自動的に追加するかどうかを指定します。	デフォルト値：false。有効な値： true false
BundleId	String	はい	いいえ	クラウドデスクトップテンプレートの ID。	なし。
EndUserId	List	いいえ	いいえ	クラウドデスクトップの使用を許可されている正規ユーザーの ID。	作成したクラウドデスクトップは、正規ユーザーに割り当てられます。1 ～ 100 個のユーザー ID を指定できます。一度にクラウドデスクトップを使用できる正規ユーザーは 1 人だけです。 EndUserId プロパティを指定しない場合、作成したクラウドデスクトップは正規ユーザーに割り当てられません。
ChargeType	String	いいえ	いいえ	クラウドデスクトップの課金方法。	デフォルト値：PostPaid。有効な値： PostPaid：従量課金制 PrePaid：サブスクリプション
VolumeEncryptionKey	String	いいえ	いいえ	ディスクの暗号化が有効になっている場合に使用される Key Management Service（KMS）キーの ID。	キー ID のクエリ方法については、「ListKeys」をご参照ください。
Tags	List	いいえ	いいえ	タグ。	詳細については、「タグのプロパティ」をご参照ください。
PeriodUnit	String	いいえ	いいえ	サブスクリプション期間の単位。	デフォルト値：Month。有効な値： Month Year
VpcId	String	いいえ	いいえ	このプロパティは使用できません。	なし。
DirectoryId	String	いいえ	いいえ	このプロパティは使用できません。	なし。
UserName	String	いいえ	いいえ	このプロパティは使用できません。	なし。

タグの構文

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

タグのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Value	String	いいえ	いいえ	タグの値。	タグには 1 ～ 20 個の値を指定できます。
Key	String	はい	いいえ	タグのキー。	タグには 1 ～ 20 個のキーを指定できます。

戻り値

Fn::GetAtt

DesktopId：クラウドデスクトップの ID。
OrderId：注文の ID。

例

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "PolicyGroupId": {
      "Type": "String",
      "Description": "ポリシーのID。" // The ID of the policy.
    },
    "OfficeSiteId": {
      "Type": "String",
      "Description": "ワークスペースのID。" // The ID of the workspace.
    },
    "BundleId": {
      "Type": "String",
      "Description": "クラウドデスクトップテンプレートのID。" // The ID of the cloud desktop template.
    }
  },
  "Resources": {
    "Desktops": {
      "Type": "ALIYUN::ECD::Desktops",
      "Properties": {
        "PolicyGroupId": {
          "Ref": "PolicyGroupId"
        },
        "OfficeSiteId": {
          "Ref": "OfficeSiteId"
        },
        "BundleId": {
          "Ref": "BundleId"
        }
      }
    }
  },
  "Outputs": {
    "DesktopId": {
      "Description": "クラウドデスクトップのID。1 回の呼び出しで複数のクラウドデスクトップが作成された場合、クラウドデスクトップのIDが返されます。", // The ID of the cloud desktop. If multiple cloud desktops are created in a call, the\nIDs of the cloud desktops are returned.
      "Value": {
        "Fn::GetAtt": [
          "Desktops",
          "DesktopId"
        ]
      }
    },
    "OrderId": {
      "Description": "注文のID。\n注：このパラメーターは、ChargeType パラメーターが PrePaid に設定されている場合にのみ返されます。", // The ID of the order.\nNote This parameter is returned only when the ChargeType parameter is set to PrePaid.
      "Value": {
        "Fn::GetAtt": [
          "Desktops",
          "OrderId"
        ]
      }
    }
  }
}

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  PolicyGroupId:
    Type: String
    Description: ポリシーの ID。 # The ID of the policy.
  OfficeSiteId:
    Type: String
    Description: ワークスペースの ID。 # The ID of the workspace.
  BundleId:
    Type: String
    Description: クラウドデスクトップテンプレートの ID。 # The ID of the cloud desktop template.
Resources:
  Desktops:
    Type: ALIYUN::ECD::Desktops
    Properties:
      PolicyGroupId:
        Ref: PolicyGroupId
      OfficeSiteId:
        Ref: OfficeSiteId
      BundleId:
        Ref: BundleId
Outputs:
  DesktopId:
    Description: |-
      クラウドデスクトップの ID。1 回の呼び出しで複数のクラウドデスクトップが作成された場合、
      クラウドデスクトップの ID が返されます。 # The ID of the cloud desktop. If multiple cloud desktops are created in a call, the
      # IDs of the cloud desktops are returned.
    Value:
      Fn::GetAtt:
        - Desktops
        - DesktopId
  OrderId:
    Description: |-
      注文の ID。
      注：このパラメーターは、ChargeType パラメーターが PrePaid に設定されている場合にのみ返されます。 # The ID of the order.
      # Note This parameter is returned only when the ChargeType parameter is set to PrePaid.
    Value:
      Fn::GetAtt:
        - Desktops
        - OrderId