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

Microsoft.Web staticSites

项目
10/26/2024

Bicep 资源定义

可以使用目标操作部署 staticSites 资源类型：

资源组 - 请参阅资源组部署命令

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

资源格式

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

resource symbolicname 'Microsoft.Web/staticSites@2024-04-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    allowConfigFileUpdates: bool
    branch: 'string'
    buildProperties: {
      apiBuildCommand: 'string'
      apiLocation: 'string'
      appArtifactLocation: 'string'
      appBuildCommand: 'string'
      appLocation: 'string'
      githubActionSecretNameOverride: 'string'
      outputLocation: 'string'
      skipGithubActionWorkflowGeneration: bool
    }
    enterpriseGradeCdnStatus: 'string'
    provider: 'string'
    publicNetworkAccess: 'string'
    repositoryToken: 'string'
    repositoryUrl: 'string'
    stagingEnvironmentPolicy: 'string'
    templateProperties: {
      description: 'string'
      isPrivate: bool
      owner: 'string'
      repositoryName: 'string'
      templateRepositoryUrl: 'string'
    }
  }
  sku: {
    capabilities: [
      {
        name: 'string'
        reason: 'string'
        value: 'string'
      }
    ]
    capacity: int
    family: 'string'
    locations: [
      'string'
    ]
    name: 'string'
    size: 'string'
    skuCapacity: {
      default: int
      elasticMaximum: int
      maximum: int
      minimum: int
      scaleType: 'string'
    }
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

能力

名字	描述	价值
名字	SKU 功能的名称。	字符串
原因	SKU 功能的原因。	字符串
价值	SKU 功能的值。	字符串

ManagedServiceIdentity

名字	描述	价值
类型	托管服务标识的类型。	“None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”
userAssignedIdentities	与资源关联的用户分配标识的列表。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名字	描述	价值

Microsoft.Web/staticSites

名字	描述	价值
身份	托管服务标识。	ManagedServiceIdentity
类	资源类型。如果资源是应用，可以参考 https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference 了解类型支持的详细信息值。	字符串
位置	资源位置。	string （必需）
名字	资源名称	string （必需）
性能	核心资源属性	StaticSite
sku	可缩放资源的 SKU 说明。	SkuDescription
标签	资源标记	标记名称和值的字典。请参阅模板中的标记

ResourceTags

名字	描述	价值

SkuCapacity

名字	描述	价值
违约	此应用服务计划 SKU 的默认辅助角色数。	int
elasticMaximum	此应用服务计划 SKU 的最大弹性辅助角色数。	int
最大	此应用服务计划 SKU 的最大辅助角色数。	int
最低	此应用服务计划 SKU 的最小辅助角色数。	int
scaleType	应用服务计划的可用缩放配置。	字符串

SkuDescription

名字	描述	价值
能力	SKU 的功能，例如是否启用了流量管理器？	功能[]
能力	分配给资源的当前实例数。	int
家庭	资源 SKU 的家庭代码。	字符串
地点	SKU 的位置。	string[]
名字	资源 SKU 的名称。	字符串
大小	资源 SKU 的大小说明符。	字符串
skuCapacity	SKU 的最小、最大值和默认缩放值。	SkuCapacity
层	资源 SKU 的服务层。	字符串

StaticSite

名字	描述	价值
allowConfigFileUpdates	如果此静态 Web 应用锁定配置文件，<代码>false</code>;否则，<代码>true</code>。	bool
分支	存储库中的目标分支。	字符串
buildProperties	生成要在存储库上配置的属性。	StaticSiteBuildProperties
enterpriseGradeCdnStatus	指示为流向静态 Web 应用的流量提供服务的企业级 CDN 的状态。	“Disabled” “禁用” “Enabled” “启用”
供应商	将上次部署提交到静态站点主环境的提供程序。	字符串
publicNetworkAccess	指示是否允许对静态 Web 应用使用公共流量的状态。允许的值：“Enabled”、“Disabled”或空字符串。	字符串
repositoryToken	用户的 github 存储库令牌。这用于设置 Github Actions 工作流文件和 API 机密。	字符串
repositoryUrl	静态站点存储库的 URL。	字符串
stagingEnvironmentPolicy	指示是允许还是不允许静态 Web 应用暂存环境的状态。	“Disabled” “Enabled”
templateProperties	用于生成新存储库的模板选项。	StaticSiteTemplateOptions

StaticSiteBuildProperties

名字	描述	价值
apiBuildCommand	在部署 Azure Functions API 应用程序期间运行的自定义命令。	字符串
apiLocation	存储库中 API 代码的路径。	字符串
appArtifactLocation	已弃用：生成后应用项目的路径（弃用为 OutputLocation）	字符串
appBuildCommand	在部署静态内容应用程序期间运行的自定义命令。	字符串
appLocation	存储库中应用代码的路径。	字符串
githubActionSecretNameOverride	Github Action 机密名称重写。	字符串
outputLocation	生成后应用的输出路径。	字符串
skipGithubActionWorkflowGeneration	跳过 Github Action 工作流生成。	bool

StaticSiteTemplateOptions

名字	描述	价值
描述	新生成的存储库的说明。	字符串
isPrivate	新生成的存储库是否为专用存储库。默认为 false（即公共）。	bool
所有者	新生成的存储库的所有者。	字符串
repositoryName	新生成的存储库的名称。	字符串
templateRepositoryUrl	模板存储库的 URL。新生成的存储库将基于此存储库。	字符串

UserAssignedIdentity

名字	描述	价值

ARM 模板资源定义

可以使用目标操作部署 staticSites 资源类型：

资源组 - 请参阅资源组部署命令

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

资源格式

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

{
  "type": "Microsoft.Web/staticSites",
  "apiVersion": "2024-04-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "allowConfigFileUpdates": "bool",
    "branch": "string",
    "buildProperties": {
      "apiBuildCommand": "string",
      "apiLocation": "string",
      "appArtifactLocation": "string",
      "appBuildCommand": "string",
      "appLocation": "string",
      "githubActionSecretNameOverride": "string",
      "outputLocation": "string",
      "skipGithubActionWorkflowGeneration": "bool"
    },
    "enterpriseGradeCdnStatus": "string",
    "provider": "string",
    "publicNetworkAccess": "string",
    "repositoryToken": "string",
    "repositoryUrl": "string",
    "stagingEnvironmentPolicy": "string",
    "templateProperties": {
      "description": "string",
      "isPrivate": "bool",
      "owner": "string",
      "repositoryName": "string",
      "templateRepositoryUrl": "string"
    }
  },
  "sku": {
    "capabilities": [
      {
        "name": "string",
        "reason": "string",
        "value": "string"
      }
    ],
    "capacity": "int",
    "family": "string",
    "locations": [ "string" ],
    "name": "string",
    "size": "string",
    "skuCapacity": {
      "default": "int",
      "elasticMaximum": "int",
      "maximum": "int",
      "minimum": "int",
      "scaleType": "string"
    },
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

能力

名字	描述	价值
名字	SKU 功能的名称。	字符串
原因	SKU 功能的原因。	字符串
价值	SKU 功能的值。	字符串

ManagedServiceIdentity

名字	描述	价值
类型	托管服务标识的类型。	“None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”
userAssignedIdentities	与资源关联的用户分配标识的列表。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名字	描述	价值

Microsoft.Web/staticSites

名字	描述	价值
apiVersion	API 版本	'2024-04-01'
身份	托管服务标识。	ManagedServiceIdentity
类	资源类型。如果资源是应用，可以参考 https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference 了解类型支持的详细信息值。	字符串
位置	资源位置。	string （必需）
名字	资源名称	string （必需）
性能	核心资源属性	StaticSite
sku	可缩放资源的 SKU 说明。	SkuDescription
标签	资源标记	标记名称和值的字典。请参阅模板中的标记
类型	资源类型	“Microsoft.Web/staticSites”

ResourceTags

名字	描述	价值

SkuCapacity

名字	描述	价值
违约	此应用服务计划 SKU 的默认辅助角色数。	int
elasticMaximum	此应用服务计划 SKU 的最大弹性辅助角色数。	int
最大	此应用服务计划 SKU 的最大辅助角色数。	int
最低	此应用服务计划 SKU 的最小辅助角色数。	int
scaleType	应用服务计划的可用缩放配置。	字符串

SkuDescription

名字	描述	价值
能力	SKU 的功能，例如是否启用了流量管理器？	功能[]
能力	分配给资源的当前实例数。	int
家庭	资源 SKU 的家庭代码。	字符串
地点	SKU 的位置。	string[]
名字	资源 SKU 的名称。	字符串
大小	资源 SKU 的大小说明符。	字符串
skuCapacity	SKU 的最小、最大值和默认缩放值。	SkuCapacity
层	资源 SKU 的服务层。	字符串

StaticSite

名字	描述	价值
allowConfigFileUpdates	如果此静态 Web 应用锁定配置文件，<代码>false</code>;否则，<代码>true</code>。	bool
分支	存储库中的目标分支。	字符串
buildProperties	生成要在存储库上配置的属性。	StaticSiteBuildProperties
enterpriseGradeCdnStatus	指示为流向静态 Web 应用的流量提供服务的企业级 CDN 的状态。	“Disabled” “禁用” “Enabled” “启用”
供应商	将上次部署提交到静态站点主环境的提供程序。	字符串
publicNetworkAccess	指示是否允许对静态 Web 应用使用公共流量的状态。允许的值：“Enabled”、“Disabled”或空字符串。	字符串
repositoryToken	用户的 github 存储库令牌。这用于设置 Github Actions 工作流文件和 API 机密。	字符串
repositoryUrl	静态站点存储库的 URL。	字符串
stagingEnvironmentPolicy	指示是允许还是不允许静态 Web 应用暂存环境的状态。	“Disabled” “Enabled”
templateProperties	用于生成新存储库的模板选项。	StaticSiteTemplateOptions

StaticSiteBuildProperties

名字	描述	价值
apiBuildCommand	在部署 Azure Functions API 应用程序期间运行的自定义命令。	字符串
apiLocation	存储库中 API 代码的路径。	字符串
appArtifactLocation	已弃用：生成后应用项目的路径（弃用为 OutputLocation）	字符串
appBuildCommand	在部署静态内容应用程序期间运行的自定义命令。	字符串
appLocation	存储库中应用代码的路径。	字符串
githubActionSecretNameOverride	Github Action 机密名称重写。	字符串
outputLocation	生成后应用的输出路径。	字符串
skipGithubActionWorkflowGeneration	跳过 Github Action 工作流生成。	bool

StaticSiteTemplateOptions

名字	描述	价值
描述	新生成的存储库的说明。	字符串
isPrivate	新生成的存储库是否为专用存储库。默认为 false（即公共）。	bool
所有者	新生成的存储库的所有者。	字符串
repositoryName	新生成的存储库的名称。	字符串
templateRepositoryUrl	模板存储库的 URL。新生成的存储库将基于此存储库。	字符串

UserAssignedIdentity

名字	描述	价值

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 staticSites 资源类型：

资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/staticSites@2024-04-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  kind = "string"
  location = "string"
  body = jsonencode({
    properties = {
      allowConfigFileUpdates = bool
      branch = "string"
      buildProperties = {
        apiBuildCommand = "string"
        apiLocation = "string"
        appArtifactLocation = "string"
        appBuildCommand = "string"
        appLocation = "string"
        githubActionSecretNameOverride = "string"
        outputLocation = "string"
        skipGithubActionWorkflowGeneration = bool
      }
      enterpriseGradeCdnStatus = "string"
      provider = "string"
      publicNetworkAccess = "string"
      repositoryToken = "string"
      repositoryUrl = "string"
      stagingEnvironmentPolicy = "string"
      templateProperties = {
        description = "string"
        isPrivate = bool
        owner = "string"
        repositoryName = "string"
        templateRepositoryUrl = "string"
      }
    }
  })
  sku = {
    capabilities = [
      {
        name = "string"
        reason = "string"
        value = "string"
      }
    ]
    capacity = int
    family = "string"
    locations = [
      "string"
    ]
    name = "string"
    size = "string"
    skuCapacity = {
      default = int
      elasticMaximum = int
      maximum = int
      minimum = int
      scaleType = "string"
    }
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
}

属性值

能力

名字	描述	价值
名字	SKU 功能的名称。	字符串
原因	SKU 功能的原因。	字符串
价值	SKU 功能的值。	字符串

ManagedServiceIdentity

名字	描述	价值
类型	托管服务标识的类型。	“None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”
userAssignedIdentities	与资源关联的用户分配标识的列表。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名字	描述	价值

Microsoft.Web/staticSites

名字	描述	价值
身份	托管服务标识。	ManagedServiceIdentity
类	资源类型。如果资源是应用，可以参考 https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference 了解类型支持的详细信息值。	字符串
位置	资源位置。	string （必需）
名字	资源名称	string （必需）
性能	核心资源属性	StaticSite
sku	可缩放资源的 SKU 说明。	SkuDescription
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.Web/staticSites@2024-04-01”

ResourceTags

名字	描述	价值

SkuCapacity

名字	描述	价值
违约	此应用服务计划 SKU 的默认辅助角色数。	int
elasticMaximum	此应用服务计划 SKU 的最大弹性辅助角色数。	int
最大	此应用服务计划 SKU 的最大辅助角色数。	int
最低	此应用服务计划 SKU 的最小辅助角色数。	int
scaleType	应用服务计划的可用缩放配置。	字符串

SkuDescription

名字	描述	价值
能力	SKU 的功能，例如是否启用了流量管理器？	功能[]
能力	分配给资源的当前实例数。	int
家庭	资源 SKU 的家庭代码。	字符串
地点	SKU 的位置。	string[]
名字	资源 SKU 的名称。	字符串
大小	资源 SKU 的大小说明符。	字符串
skuCapacity	SKU 的最小、最大值和默认缩放值。	SkuCapacity
层	资源 SKU 的服务层。	字符串

StaticSite

名字	描述	价值
allowConfigFileUpdates	如果此静态 Web 应用锁定配置文件，<代码>false</code>;否则，<代码>true</code>。	bool
分支	存储库中的目标分支。	字符串
buildProperties	生成要在存储库上配置的属性。	StaticSiteBuildProperties
enterpriseGradeCdnStatus	指示为流向静态 Web 应用的流量提供服务的企业级 CDN 的状态。	“Disabled” “禁用” “Enabled” “启用”
供应商	将上次部署提交到静态站点主环境的提供程序。	字符串
publicNetworkAccess	指示是否允许对静态 Web 应用使用公共流量的状态。允许的值：“Enabled”、“Disabled”或空字符串。	字符串
repositoryToken	用户的 github 存储库令牌。这用于设置 Github Actions 工作流文件和 API 机密。	字符串
repositoryUrl	静态站点存储库的 URL。	字符串
stagingEnvironmentPolicy	指示是允许还是不允许静态 Web 应用暂存环境的状态。	“Disabled” “Enabled”
templateProperties	用于生成新存储库的模板选项。	StaticSiteTemplateOptions

StaticSiteBuildProperties

名字	描述	价值
apiBuildCommand	在部署 Azure Functions API 应用程序期间运行的自定义命令。	字符串
apiLocation	存储库中 API 代码的路径。	字符串
appArtifactLocation	已弃用：生成后应用项目的路径（弃用为 OutputLocation）	字符串
appBuildCommand	在部署静态内容应用程序期间运行的自定义命令。	字符串
appLocation	存储库中应用代码的路径。	字符串
githubActionSecretNameOverride	Github Action 机密名称重写。	字符串
outputLocation	生成后应用的输出路径。	字符串
skipGithubActionWorkflowGeneration	跳过 Github Action 工作流生成。	bool

StaticSiteTemplateOptions

名字	描述	价值
描述	新生成的存储库的说明。	字符串
isPrivate	新生成的存储库是否为专用存储库。默认为 false（即公共）。	bool
所有者	新生成的存储库的所有者。	字符串
repositoryName	新生成的存储库的名称。	字符串
templateRepositoryUrl	模板存储库的 URL。新生成的存储库将基于此存储库。	字符串

UserAssignedIdentity

名字	描述	价值

通过

Microsoft.Web staticSites

Bicep 资源定义

资源格式

属性值

能力

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.Web/staticSites

ResourceTags

SkuCapacity

SkuDescription

StaticSite

StaticSiteBuildProperties

StaticSiteTemplateOptions

UserAssignedIdentity

ARM 模板资源定义

资源格式

属性值

能力

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.Web/staticSites

ResourceTags

SkuCapacity

SkuDescription

StaticSite

StaticSiteBuildProperties

StaticSiteTemplateOptions

UserAssignedIdentity

Terraform （AzAPI 提供程序）资源定义

资源格式

属性值

能力

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.Web/staticSites

ResourceTags

SkuCapacity

SkuDescription

StaticSite

StaticSiteBuildProperties

StaticSiteTemplateOptions

UserAssignedIdentity

反馈

其他资源