你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Microsoft.Web staticSites 2020-10-01

Bicep 资源定义

可以使用面向以下操作部署 staticSites 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Web/staticSites 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Web/staticSites@2020-10-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capabilities: [
      {
        name: 'string'
        reason: 'string'
        value: 'string'
      }
    ]
    capacity: int
    family: 'string'
    locations: [
      'string'
    ]
    name: 'string'
    size: 'string'
    skuCapacity: {
      default: int
      maximum: int
      minimum: int
      scaleType: 'string'
    }
    tier: 'string'
  }
  kind: 'string'
  properties: {
    branch: 'string'
    buildProperties: {
      apiLocation: 'string'
      appArtifactLocation: 'string'
      appLocation: 'string'
    }
    repositoryToken: 'string'
    repositoryUrl: 'string'
  }
}

属性值

staticSites

名称 说明
name 资源名称 字符串 (必需)
location 资源位置。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
sku 可缩放资源的 SKU 说明。 SkuDescription
kind 资源类型。 string
properties 核心资源属性 StaticSite

StaticSite

名称 说明
branch 存储库中的目标分支。 string
buildProperties 生成要对存储库配置的属性。 StaticSiteBuildProperties
repositoryToken 用户的 github 存储库令牌。 这用于设置 Github Actions 工作流文件和 API 机密。 字符串
repositoryUrl 静态站点存储库的 URL。 字符串

StaticSiteBuildProperties

名称 说明
apiLocation 存储库中 API 代码的路径。 string
appArtifactLocation 生成后应用项目的路径。 字符串
appLocation 存储库中应用代码的路径。 字符串

SkuDescription

名称 说明
capabilities SKU 的功能,例如是否启用了流量管理器? Capability[]
容量 分配给资源的当前实例数。 int
family 资源 SKU 的系列代码。 string
locations SKU 的位置。 string[]
name 资源 SKU 的名称。 string
大小 资源 SKU 的大小说明符。 string
skuCapacity SKU 的最小、最大和默认缩放值。 SkuCapacity
资源 SKU 的服务层。 字符串

功能

名称 说明
name SKU 功能的名称。 string
reason SKU 功能的原因。 string
value SKU 功能的值。 string

SkuCapacity

名称 说明
默认值 此App 服务计划 SKU 的默认辅助角色数。 int
最大值 此App 服务计划 SKU 的最大辅助角色数。 int
最小值 此App 服务计划 SKU 的最小辅助角色数。 int
scaleType App 服务计划的可用缩放配置。 string

ARM 模板资源定义

可以使用面向以下操作部署 staticSites 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Web/staticSites 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Web/staticSites",
  "apiVersion": "2020-10-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capabilities": [
      {
        "name": "string",
        "reason": "string",
        "value": "string"
      }
    ],
    "capacity": "int",
    "family": "string",
    "locations": [ "string" ],
    "name": "string",
    "size": "string",
    "skuCapacity": {
      "default": "int",
      "maximum": "int",
      "minimum": "int",
      "scaleType": "string"
    },
    "tier": "string"
  },
  "kind": "string",
  "properties": {
    "branch": "string",
    "buildProperties": {
      "apiLocation": "string",
      "appArtifactLocation": "string",
      "appLocation": "string"
    },
    "repositoryToken": "string",
    "repositoryUrl": "string"
  }
}

属性值

staticSites

名称 说明 Value
type 资源类型 'Microsoft.Web/staticSites'
apiVersion 资源 API 版本 '2020-10-01'
name 资源名称 字符串 (必需)
location 资源位置。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
sku 可缩放资源的 SKU 说明。 SkuDescription
kind 资源类型。 string
properties 核心资源属性 StaticSite

StaticSite

名称 说明
branch 存储库中的目标分支。 字符串
buildProperties 生成要对存储库配置的属性。 StaticSiteBuildProperties
repositoryToken 用户的 github 存储库令牌。 这用于设置 Github Actions 工作流文件和 API 机密。 字符串
repositoryUrl 静态站点存储库的 URL。 string

StaticSiteBuildProperties

名称 说明
apiLocation 存储库中 API 代码的路径。 字符串
appArtifactLocation 生成后应用项目的路径。 字符串
appLocation 存储库中应用代码的路径。 字符串

SkuDescription

名称 说明
capabilities SKU 的功能,例如是否启用了流量管理器? Capability[]
容量 分配给资源的当前实例数。 int
family 资源 SKU 的系列代码。 字符串
locations SKU 的位置。 string[]
name 资源 SKU 的名称。 string
大小 资源 SKU 的大小说明符。 字符串
skuCapacity SKU 的最小、最大和默认缩放值。 SkuCapacity
资源 SKU 的服务层。 string

功能

名称 说明
name SKU 功能的名称。 string
reason SKU 功能的原因。 string
value SKU 功能的值。 string

SkuCapacity

名称 说明
默认值 此App 服务计划 SKU 的默认辅助角色数。 int
最大值 此App 服务计划 SKU 的最大辅助角色数。 int
最小值 此App 服务计划 SKU 的最小辅助角色数。 int
scaleType App 服务计划的可用缩放配置。 string

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署 staticSites 资源类型:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Web/staticSites 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/staticSites@2020-10-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      branch = "string"
      buildProperties = {
        apiLocation = "string"
        appArtifactLocation = "string"
        appLocation = "string"
      }
      repositoryToken = "string"
      repositoryUrl = "string"
    }
    sku = {
      capabilities = [
        {
          name = "string"
          reason = "string"
          value = "string"
        }
      ]
      capacity = int
      family = "string"
      locations = [
        "string"
      ]
      name = "string"
      size = "string"
      skuCapacity = {
        default = int
        maximum = int
        minimum = int
        scaleType = "string"
      }
      tier = "string"
    }
    kind = "string"
  })
}

属性值

staticSites

名称 说明 Value
type 资源类型 “Microsoft.Web/staticSites@2020-10-01”
name 资源名称 字符串 (必需)
location 资源位置。 字符串 (必需)
parent_id 若要部署到资源组,请使用该资源组的 ID。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。
sku 可缩放资源的 SKU 说明。 SkuDescription
kind 资源类型。 string
properties 核心资源属性 StaticSite

StaticSite

名称 说明
branch 存储库中的目标分支。 字符串
buildProperties 生成要对存储库配置的属性。 StaticSiteBuildProperties
repositoryToken 用户的 github 存储库令牌。 这用于设置 Github Actions 工作流文件和 API 机密。 字符串
repositoryUrl 静态站点存储库的 URL。 字符串

StaticSiteBuildProperties

名称 说明
apiLocation 存储库中 API 代码的路径。 字符串
appArtifactLocation 生成后应用项目的路径。 string
appLocation 存储库中应用代码的路径。 字符串

SkuDescription

名称 说明
capabilities SKU 的功能,例如是否启用了流量管理器? Capability[]
容量 当前分配给资源的实例数。 int
family 资源 SKU 的系列代码。 字符串
locations SKU 的位置。 string[]
name 资源 SKU 的名称。 string
大小 资源 SKU 的大小说明符。 string
skuCapacity SKU 的最小、最大值和默认缩放值。 SkuCapacity
资源 SKU 的服务层。 字符串

功能

名称 说明
name SKU 功能的名称。 string
reason SKU 功能的原因。 string
value SKU 功能的值。 string

SkuCapacity

名称 说明
默认值 此App 服务计划 SKU 的默认辅助角色数。 int
最大值 此App 服务计划 SKU 的最大辅助角色数。 int
最小值 此App 服务计划 SKU 的最小辅助角色数。 int
scaleType App 服务计划的可用缩放配置。 字符串