全部产品
Search
文档中心

资源编排:ALIYUN::ECD::SimpleOfficeSite

更新时间:Aug 12, 2024

ALIYUN::ECD::SimpleOfficeSite类型用于创建一个使用便捷账号的工作区。

语法

{
  "Type": "ALIYUN::ECD::SimpleOfficeSite",
  "Properties": {
    "VerifyCode": String,
    "NeedVerifyZeroDevice": Boolean,
    "CenOwnerId": Integer,
    "Bandwidth": Integer,
    "VSwitchId": String,
    "EnableAdminAccess": Boolean,
    "CloudBoxOfficeSite": Boolean,
    "CenId": String,
    "OfficeSiteName": String,
    "DesktopAccessType": String,
    "CidrBlock": String,
    "EnableInternetAccess": Boolean
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

VerifyCode

String

验证码。

如果配置的CenId属于其他阿里云账号,必须先调用SendVerifyCode获取验证码。

NeedVerifyZeroDevice

Boolean

是否开启可信设备校验。

取值:

  • true:开启可信设备校验。

  • false:不开启可信设备校验。

CenOwnerId

Integer

云企业网实例所属的阿里云账号ID。

  • 如果未配置CenId,或者配置的CenId属于本阿里云账号,该参数无需配置。

  • 如果配置的CenId属于其他阿里云账号,请填写所属阿里云账号的ID。

Bandwidth

Integer

公网带宽峰值。

取值范围:10~200。

带宽单位为:Mbps。

EnableInternetAccess配置为true时,可以设置该参数。

VSwitchId

String

专有网络VPC中的交换机ID。

创建云盒工作区时,需要填写该参数。

EnableAdminAccess

Boolean

是否为使用云桌面的用户赋予本地管理员权限。

取值:

  • true(默认值):赋予本地管理员权限。

  • false:不赋予本地管理员权限。

CloudBoxOfficeSite

Boolean

是否为云盒工作区。

取值:

  • true:云盒工作区。

  • false:公网工作区。

CenId

String

云企业网CEN实例ID。

说明

如果想要通过VPC连接的方式接入云桌面,可以将工作区网络加入到云企业网实例中。该云企业网实例为本地网络通过VPN或者专线接入的云企业网实例。

OfficeSiteName

String

工作区名称。

长度为2~255个英文或中文字符。必须以大小字母或中文开头,不能以http://https://开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。

DesktopAccessType

String

连接云桌面时允许使用的接入方式。

说明

VPC连接方式依赖于阿里云私网连接PrivateLink服务,该服务不收取费用。该参数设置为VPC或者Any时,系统将自动为您开通私网连接服务。

CidrBlock

String

工作区对应的安全办公网络包含的IPv4网段。

系统将根据输入的IPv4网段,自动创建一个专有网络VPC。建议您使用10.0.0.0/12172.16.0.0/12192.168.0.0/16及其子网作为IPv4网段。如果设置了10或者172网段,掩码有效范围为12~24位,如果设置了192网段,掩码有效范围为16~24位。

EnableInternetAccess

Boolean

是否开通公网访问功能。

取值:

  • true:开通公网访问功能。

  • false(默认值):不开通公网访问功能。

返回值

Fn::GetAtt

OfficeSiteId:工作区ID。

示例

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  OfficeSiteName:
    Type: String
    Description: The name of the workspace. The name must be 2 to 255 characters in length. It must start with a letter and cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-).
    Default: test
Resources:
  SimpleOfficeSite:
    Type: ALIYUN::ECD::SimpleOfficeSite
    Properties:
      OfficeSiteName:
        Ref: OfficeSiteName
      CidrBlock: 172.16.0.0/12
Outputs:
  OfficeSiteId:
    Description: The ID of the workspace.
    Value:
      Fn::GetAtt:
        - SimpleOfficeSite
        - OfficeSiteId

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "OfficeSiteName": {
      "Type": "String",
      "Description": "The name of the workspace. The name must be 2 to 255 characters in length. It must start with a letter and cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-).",
      "Default": "test"
    }
  },
  "Resources": {
    "SimpleOfficeSite": {
      "Type": "ALIYUN::ECD::SimpleOfficeSite",
      "Properties": {
        "OfficeSiteName": {
          "Ref": "OfficeSiteName"
        },
        "CidrBlock": "172.16.0.0/12"
      }
    }
  },
  "Outputs": {
    "OfficeSiteId": {
      "Description": "The ID of the workspace.",
      "Value": {
        "Fn::GetAtt": [
          "SimpleOfficeSite",
          "OfficeSiteId"
        ]
      }
    }
  }
}