ALIYUN::ECD::Desktops - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

Sintaxe

{
  "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
  }
}

Propriedades

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
UserAssignMode	String	Não	Não	Modo de atribuição das cloud desktops a criar.	Valor padrão: ALL. Valores válidos: ALL: ao especificar a propriedade EndUserId, o sistema atribui as cloud desktops a cada usuário comum informado. PER_USER: ao especificar a propriedade EndUserId, o sistema distribui as cloud desktops uniformemente entre todos os usuários comuns informados. Nesse caso, garanta que o valor da propriedade Amount seja divisível pelo número de IDs de usuários comuns especificados na propriedade EndUserId. Nota Se você não especificar a propriedade EndUserId, as cloud desktops não serão atribuídas a usuários comuns.
PromotionId	String	Não	Não	ID da promoção de vendas.	Nenhuma.
PolicyGroupId	String	Sim	Não	ID da política.	Nenhuma.
AutoRenew	Boolean	Não	Não	Define se a renovação automática está ativada.	Valor padrão: false. Valores válidos: true: ativa a renovação automática. A duração da renovação corresponde à duração da assinatura definida no parâmetro Period durante a compra da cloud desktop. false: desativa a renovação automática. Nota Esta propriedade só tem efeito quando a propriedade ChargeType é definida como PrePaid.
Amount	Integer	Não	Não	Quantidade de cloud desktops a criar.	Valores válidos: 1 a 300. Valor padrão: 1.
DesktopName	String	Não	Não	Nome da cloud desktop.	Nenhuma.
Hostname	String	Não	Não	Hostname personalizado definido para a cloud desktop.	A definição de hostname personalizado é permitida apenas para cloud desktops Windows em workspaces do tipo conta enterprise Active Directory (AD). Ao criar uma única cloud desktop, o hostname especificado deve atender aos seguintes requisitos: Deve ter entre 2 e 15 caracteres. Pode conter letras, dígitos e hifens (-). Não pode iniciar ou terminar com hífen (-), conter hifens consecutivos (-) nem ser composto apenas por dígitos. Para criar múltiplas cloud desktops, os hostnames devem seguir o formato `name_prefix[begin_number,bits]name_suffix`. Por exemplo, se a propriedade Hostname for definida como `ecd-[1,4]-test`, a primeira cloud desktop receberá o hostname `ecd-0001-test` e a segunda receberá `ecd-0002-test`, seguindo essa lógica sequencialmente. Os parâmetros desse formato funcionam da seguinte maneira: `name_prefix`: prefixo do hostname. `begin_number,bits`: numeração ordenada inserida no hostname. `name_suffix`: sufixo do hostname.
Period	Integer	Não	Não	Duração da assinatura da cloud desktop a adquirir.	A unidade de tempo é determinada pela propriedade `PeriodUnit`. Esta propriedade torna-se obrigatória e entra em vigor somente quando a propriedade `ChargeType` é definida como `PrePaid`. Valores válidos com `PeriodUnit` igual a `Month`: 1, 2, 3 e 6. Valores válidos com `PeriodUnit` igual a `Year`: 1, 2, 3, 4 e 5.
VolumeEncryptionEnabled	Boolean	Não	Não	Indica se a criptografia de disco está ativada.	Valor padrão: false. Valores válidos: true false
AutoPay	Boolean	Não	Não	Define se o pagamento automático está ativado.	Valor padrão: true. Valores válidos: true: ativa o pagamento automático. Certifique-se de haver saldo suficiente em sua conta Alibaba Cloud. Caso contrário, o pedido será invalidado. false: desativa o pagamento automático. O pedido é gerado, mas o pagamento não é processado automaticamente.
GroupId	String	Não	Não	ID do grupo de desktops.	Nenhuma.
OfficeSiteId	String	Sim	Não	ID do workspace.	Nenhuma.
DesktopNameSuffix	Boolean	Não	Não	Define se um sufixo deve ser adicionado automaticamente ao nome da cloud desktop.	Valor padrão: false. Valores válidos: true false
BundleId	String	Sim	Não	ID do modelo de cloud desktop.	Nenhuma.
EndUserId	List	Não	Não	IDs dos usuários comuns autorizados a usar a cloud desktop.	A cloud desktop criada será atribuída aos usuários comuns listados. É possível especificar de 1 a 100 IDs de usuários. Apenas um usuário comum pode usar a cloud desktop por vez. Caso a propriedade EndUserId não seja especificada, a cloud desktop criada permanecerá sem atribuição a usuários comuns.
ChargeType	String	Não	Não	Método de faturamento da cloud desktop.	Valor padrão: PostPaid. Valores válidos: PostPaid: pagamento conforme o uso PrePaid: assinatura
VolumeEncryptionKey	String	Não	Não	ID da chave do Key Management Service (KMS) usada para ativar a criptografia de disco.	Para obter mais informações sobre como consultar o ID da chave, consulte ListKeys.
Tags	List	Não	Não	As tags.	Para mais detalhes, consulte Propriedades de Tags.
PeriodUnit	String	Não	Não	Unidade de tempo da duração da assinatura.	Valor padrão: Month. Valores válidos: Month Year
VpcId	String	Não	Não	Esta propriedade não está disponível.	Nenhuma.
DirectoryId	String	Não	Não	Esta propriedade não está disponível.	Nenhuma.
UserName	String	Não	Não	Esta propriedade não está disponível.	Nenhuma.

Sintaxe de Tags

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

Propriedades de Tags

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
Value	String	Não	Não	Valor da tag.	É possível especificar de 1 a 20 valores para uma tag.
Key	String	Sim	Não	Chave da tag.	É possível especificar de 1 a 20 chaves para uma tag.

Valores de retorno

Fn::GetAtt

DesktopId: ID da cloud desktop.
OrderId: ID do pedido.

Exemplos

Formato JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "PolicyGroupId": {
      "Type": "String",
      "Description": "The ID of the policy."
    },
    "OfficeSiteId": {
      "Type": "String",
      "Description": "The ID of the workspace."
    },
    "BundleId": {
      "Type": "String",
      "Description": "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": "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": "The ID of the order.\nNote This parameter is returned only when the ChargeType parameter is set to PrePaid.",
      "Value": {
        "Fn::GetAtt": [
          "Desktops",
          "OrderId"
        ]
      }
    }
  }
}

Formato YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  PolicyGroupId:
    Type: String
    Description: The ID of the policy.
  OfficeSiteId:
    Type: String
    Description: The ID of the workspace.
  BundleId:
    Type: String
    Description: 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: |-
      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: |-
      The ID of the order.
      Note This parameter is returned only when the ChargeType parameter is set to PrePaid.
    Value:
      Fn::GetAtt:
        - Desktops
        - OrderId