你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.Web staticSites 2022-03-01
Bicep 资源定义
可以使用面向以下操作部署 staticSites 资源类型:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Web/staticSites 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Web/staticSites@2022-03-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
elasticMaximum: int
maximum: int
minimum: int
scaleType: 'string'
}
tier: 'string'
}
kind: 'string'
identity: {
type: 'string'
userAssignedIdentities: {}
}
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'
}
}
}
属性值
staticSites
名称 | 说明 | 值 |
---|---|---|
name | 资源名称 | 字符串 (必需) |
location | 资源位置。 | 字符串 (必需) |
标记 | 资源标记。 | 标记名称和值的字典。 请参阅 模板中的标记 |
sku | 可缩放资源的 SKU 说明。 | SkuDescription |
kind | 资源类型。 | string |
标识 | 托管服务标识。 | ManagedServiceIdentity |
properties | 核心资源属性 | StaticSite |
ManagedServiceIdentity
名称 | 说明 | Value |
---|---|---|
type | 托管服务标识的类型。 | “None” “SystemAssigned” “SystemAssigned, UserAssigned” “UserAssigned” |
userAssignedIdentities | 与资源关联的用户分配标识的列表。 用户标识字典密钥引用将是 ARM 资源 ID,格式为:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} | 对象 (object) |
StaticSite
名称 | 说明 | 值 |
---|---|---|
allowConfigFileUpdates | false 如果为此静态 Web 应用锁定了配置文件,则为 ;否则为 true 。 |
bool |
branch | 存储库中的目标分支。 | 字符串 |
buildProperties | 生成要对存储库配置的属性。 | StaticSiteBuildProperties |
enterpriseGradeCdnStatus | 状态,指示向静态 Web 应用提供流量的企业级 CDN 的状态。 | 'Disabled' '正在禁用' 'Enabled' “启用” |
provider | 将上次部署提交到静态站点主环境的提供程序。 | 字符串 |
publicNetworkAccess | 指示静态 Web 应用是否允许公共流量的状态。 允许的值:“Enabled”、“Disabled”或空字符串。 | 字符串 |
repositoryToken | 用户的 github 存储库令牌。 这用于设置 Github Actions 工作流文件和 API 机密。 | 字符串 |
repositoryUrl | 静态站点存储库的 URL。 | 字符串 |
stagingEnvironmentPolicy | 指示静态 Web 应用是否允许过渡环境的状态。 | 'Disabled' 'Enabled' |
templateProperties | 用于生成新存储库的模板选项。 | StaticSiteTemplateOptions |
StaticSiteBuildProperties
名称 | 说明 | 值 |
---|---|---|
apiBuildCommand | 在部署 Azure Functions API 应用程序期间运行的自定义命令。 | string |
apiLocation | 存储库中 API 代码的路径。 | 字符串 |
appArtifactLocation | 已弃用:生成后应用项目的路径 (弃用,改用 OutputLocation) | 字符串 |
appBuildCommand | 在部署静态内容应用程序期间运行的自定义命令。 | 字符串 |
appLocation | 存储库中应用代码的路径。 | 字符串 |
githubActionSecretNameOverride | Github 操作机密名称替代。 | 字符串 |
outputLocation | 生成后应用的输出路径。 | 字符串 |
skipGithubActionWorkflowGeneration | 跳过 Github 操作工作流生成。 | bool |
StaticSiteTemplateOptions
名称 | 说明 | 值 |
---|---|---|
description | 新生成的存储库的说明。 | 字符串 |
isPrivate | 新生成的存储库是否为专用存储库。 默认为 false (即公共) 。 | bool |
owner | 新生成的存储库的所有者。 | 字符串 |
repositoryName | 新生成的存储库的名称。 | 字符串 |
templateRepositoryUrl | 模板存储库的 URL。 新生成的存储库将基于此存储库。 | 字符串 |
SkuDescription
名称 | 说明 | 值 |
---|---|---|
capabilities | SKU 的功能,例如是否启用了流量管理器? | Capability[] |
容量 | 当前分配给资源的实例数。 | int |
family | 资源 SKU 的系列代码。 | string |
locations | SKU 的位置。 | string[] |
name | 资源 SKU 的名称。 | string |
大小 | 资源 SKU 的大小说明符。 | 字符串 |
skuCapacity | SKU 的最小、最大值和默认缩放值。 | SkuCapacity |
层 | 资源 SKU 的服务层。 | 字符串 |
功能
名称 | 说明 | 值 |
---|---|---|
name | SKU 功能的名称。 | string |
reason | SKU 功能的原因。 | string |
value | SKU 功能的值。 | 字符串 |
SkuCapacity
名称 | 说明 | 值 |
---|---|---|
默认值 | 此App 服务计划 SKU 的默认辅助角色数。 | int |
elasticMaximum | 此App 服务计划 SKU 的最大弹性辅助角色数。 | int |
最大值 | 此App 服务计划 SKU 的最大辅助角色数。 | int |
最小值 | 此App 服务计划 SKU 的最小辅助角色数。 | int |
scaleType | App 服务计划的可用缩放配置。 | 字符串 |
ARM 模板资源定义
staticSites 资源类型可以使用面向以下对象的操作进行部署:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Web/staticSites 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.Web/staticSites",
"apiVersion": "2022-03-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",
"elasticMaximum": "int",
"maximum": "int",
"minimum": "int",
"scaleType": "string"
},
"tier": "string"
},
"kind": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {}
},
"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"
}
}
}
属性值
staticSites
名称 | 说明 | Value |
---|---|---|
type | 资源类型 | “Microsoft.Web/staticSites” |
apiVersion | 资源 API 版本 | '2022-03-01' |
name | 资源名称 | 字符串 (必需) |
location | 资源位置。 | 字符串 (必需) |
标记 | 资源标记。 | 标记名称和值的字典。 请参阅 模板中的标记 |
sku | 可缩放资源的 SKU 说明。 | SkuDescription |
kind | 资源类型。 | 字符串 |
标识 | 托管服务标识。 | ManagedServiceIdentity |
properties | 核心资源属性 | StaticSite |
ManagedServiceIdentity
名称 | 说明 | Value |
---|---|---|
type | 托管服务标识的类型。 | “None” “SystemAssigned” “SystemAssigned,UserAssigned” “UserAssigned” |
userAssignedIdentities | 与资源关联的用户分配标识的列表。 用户标识字典密钥引用将是采用以下格式的 ARM 资源 ID:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} | 对象 (object) |
StaticSite
名称 | 说明 | 值 |
---|---|---|
allowConfigFileUpdates | false 如果为此静态 Web 应用锁定了配置文件,则为 ;否则为 true 。 |
bool |
branch | 存储库中的目标分支。 | string |
buildProperties | 生成要对存储库进行配置的属性。 | StaticSiteBuildProperties |
enterpriseGradeCdnStatus | 状态,指示向静态 Web 应用提供流量的企业级 CDN 的状态。 | “Disabled” “正在禁用” “已启用” “启用” |
provider | 将最后一个部署提交到静态站点的主环境的提供程序。 | string |
publicNetworkAccess | 指示静态 Web 应用是否允许公共流量的状态。 允许的值:“Enabled”、“Disabled”或空字符串。 | string |
repositoryToken | 用户的 github 存储库令牌。 这用于设置 Github Actions 工作流文件和 API 机密。 | 字符串 |
repositoryUrl | 静态站点存储库的 URL。 | 字符串 |
stagingEnvironmentPolicy | 指示静态 Web 应用是否允许过渡环境的状态。 | “Disabled” “已启用” |
templateProperties | 用于生成新存储库的模板选项。 | StaticSiteTemplateOptions |
StaticSiteBuildProperties
名称 | 说明 | 值 |
---|---|---|
apiBuildCommand | 在部署 Azure Functions API 应用程序期间运行的自定义命令。 | string |
apiLocation | 存储库中 API 代码的路径。 | 字符串 |
appArtifactLocation | 已弃用:生成后应用项目的路径 (弃用,改用 OutputLocation) | 字符串 |
appBuildCommand | 在部署静态内容应用程序期间运行的自定义命令。 | 字符串 |
appLocation | 存储库中应用代码的路径。 | 字符串 |
githubActionSecretNameOverride | Github 操作机密名称替代。 | 字符串 |
outputLocation | 生成后应用的输出路径。 | 字符串 |
skipGithubActionWorkflowGeneration | 跳过 Github 操作工作流生成。 | bool |
StaticSiteTemplateOptions
名称 | 说明 | 值 |
---|---|---|
description | 新生成的存储库的说明。 | string |
isPrivate | 新生成的存储库是否为专用存储库。 默认为 false (即公共) 。 | bool |
owner | 新生成的存储库的所有者。 | string |
repositoryName | 新生成的存储库的名称。 | 字符串 |
templateRepositoryUrl | 模板存储库的 URL。 新生成的存储库将基于此存储库。 | 字符串 |
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 功能的值。 | 字符串 |
SkuCapacity
名称 | 说明 | 值 |
---|---|---|
默认值 | 此App 服务计划 SKU 的默认辅助角色数。 | int |
elasticMaximum | 此App 服务计划 SKU 的最大弹性辅助角色数。 | int |
最大值 | 此App 服务计划 SKU 的最大辅助角色数。 | int |
最小值 | 此App 服务计划 SKU 的最小辅助角色数。 | int |
scaleType | App 服务计划的可用缩放配置。 | 字符串 |
Terraform (AzAPI 提供程序) 资源定义
staticSites 资源类型可以使用面向以下对象的操作进行部署:
- 资源组
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Web/staticSites 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Web/staticSites@2022-03-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
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"
}
kind = "string"
})
}
属性值
staticSites
名称 | 说明 | Value |
---|---|---|
type | 资源类型 | “Microsoft.Web/staticSites@2022-03-01” |
name | 资源名称 | 字符串 (必需) |
location | 资源位置。 | 字符串 (必需) |
parent_id | 若要部署到资源组,请使用该资源组的 ID。 | 字符串 (必需) |
标记 | 资源标记。 | 标记名称和值的字典。 |
sku | 可缩放资源的 SKU 说明。 | SkuDescription |
kind | 资源类型。 | string |
标识 | 托管服务标识。 | ManagedServiceIdentity |
properties | 核心资源属性 | StaticSite |
ManagedServiceIdentity
名称 | 说明 | Value |
---|---|---|
type | 托管服务标识的类型。 | “SystemAssigned” “SystemAssigned,UserAssigned” “UserAssigned” |
identity_ids | 与资源关联的用户分配标识的列表。 用户标识字典密钥引用将是采用以下格式的 ARM 资源 ID:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} | 用户标识 ID 数组。 |
StaticSite
名称 | 说明 | 值 |
---|---|---|
allowConfigFileUpdates | false 如果为此静态 Web 应用锁定了配置文件,则为 ;否则为 true 。 |
bool |
branch | 存储库中的目标分支。 | 字符串 |
buildProperties | 生成要对存储库进行配置的属性。 | StaticSiteBuildProperties |
enterpriseGradeCdnStatus | 状态,指示向静态 Web 应用提供流量的企业级 CDN 的状态。 | “Disabled” “禁用” “已启用” “启用” |
provider | 将最后一个部署提交到静态站点的主环境的提供程序。 | 字符串 |
publicNetworkAccess | 指示静态 Web 应用是否允许公共流量的状态。 允许的值:“Enabled”、“Disabled”或空字符串。 | 字符串 |
repositoryToken | 用户的 github 存储库令牌。 这用于设置 Github Actions 工作流文件和 API 机密。 | 字符串 |
repositoryUrl | 静态站点存储库的 URL。 | string |
stagingEnvironmentPolicy | 指示静态 Web 应用是否允许过渡环境的状态。 | “Disabled” “已启用” |
templateProperties | 用于生成新存储库的模板选项。 | StaticSiteTemplateOptions |
StaticSiteBuildProperties
名称 | 说明 | 值 |
---|---|---|
apiBuildCommand | 在部署 Azure Functions API 应用程序期间运行的自定义命令。 | string |
apiLocation | 存储库中 API 代码的路径。 | 字符串 |
appArtifactLocation | 已弃用:生成后应用项目的路径 (弃用,改用 OutputLocation) | 字符串 |
appBuildCommand | 在部署静态内容应用程序期间运行的自定义命令。 | 字符串 |
appLocation | 存储库中应用代码的路径。 | 字符串 |
githubActionSecretNameOverride | Github 操作机密名称替代。 | 字符串 |
outputLocation | 生成后应用的输出路径。 | 字符串 |
skipGithubActionWorkflowGeneration | 跳过 Github 操作工作流生成。 | bool |
StaticSiteTemplateOptions
名称 | 说明 | 值 |
---|---|---|
description | 新生成的存储库的说明。 | string |
isPrivate | 新生成的存储库是否为专用存储库。 默认为 false (即公共) 。 | bool |
owner | 新生成的存储库的所有者。 | 字符串 |
repositoryName | 新生成的存储库的名称。 | 字符串 |
templateRepositoryUrl | 模板存储库的 URL。 新生成的存储库将基于此存储库。 | 字符串 |
SkuDescription
名称 | 说明 | 值 |
---|---|---|
capabilities | SKU 的功能,例如是否启用了流量管理器? | Capability[] |
容量 | 当前分配给资源的实例数。 | int |
family | 资源 SKU 的系列代码。 | 字符串 |
locations | SKU 的位置。 | string[] |
name | 资源 SKU 的名称。 | string |
大小 | 资源 SKU 的大小说明符。 | 字符串 |
skuCapacity | SKU 的最小、最大值和默认缩放值。 | SkuCapacity |
层 | 资源 SKU 的服务层。 | 字符串 |
功能
名称 | 说明 | 值 |
---|---|---|
name | SKU 功能的名称。 | string |
reason | SKU 功能的原因。 | string |
value | SKU 功能的值。 | 字符串 |
SkuCapacity
名称 | 说明 | 值 |
---|---|---|
默认值 | 此App 服务计划 SKU 的默认辅助角色数。 | int |
elasticMaximum | 此App 服务计划 SKU 的最大弹性辅助角色数。 | int |
最大值 | 此App 服务计划 SKU 的最大辅助角色数。 | int |
最小值 | 此App 服务计划 SKU 的最小辅助角色数。 | int |
scaleType | App 服务计划的可用缩放配置。 | 字符串 |
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈