你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Static Sites - Get Static Sites By Resource Group
获取指定资源组中的所有静态站点的说明。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites?api-version=2023-12-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
resource
|
path | True |
string |
资源所属的资源组的名称。 正则表达式模式: |
subscription
|
path | True |
string |
Azure 订阅 ID。 这是一个 GUID 格式的字符串, (例如 00000000-0000-0000-0000-0000000000000) 。 |
api-version
|
query | True |
string |
API 版本 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
没问题。 |
|
Other Status Codes |
App 服务错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
Get static sites for a resource group
示例请求
示例响应
{
"value": [
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0",
"name": "testStaticSite0",
"type": "Microsoft.Web/staticSites",
"location": "West US 2",
"properties": {
"defaultHostname": "happy-sea-15afae3e.azurestaticwebsites.net",
"repositoryUrl": "https://github.com/username/repo",
"branch": "demo",
"customDomains": [],
"privateEndpointConnections": [],
"contentDistributionEndpoint": "",
"keyVaultReferenceIdentity": "SystemAssigned",
"userProvidedFunctionApps": null,
"linkedBackends": [],
"stagingEnvironmentPolicy": "Enabled",
"allowConfigFileUpdates": true
},
"sku": {
"name": "Standard",
"tier": "Standard"
}
}
],
"nextLink": null
}
定义
名称 | 说明 |
---|---|
Arm |
ARM 资源 ID 的包装器 |
Arm |
Azure 资源管理器 中的计划对象表示市场计划。 |
Capability |
描述特定 SKU 允许的功能/功能。 |
Database |
静态站点数据库连接概述。 |
Default |
App 服务错误响应。 |
Details | |
Enterprise |
状态,指示向静态 Web 应用提供流量的企业级 CDN 的状态。 |
Error |
错误模型。 |
Error |
从 API 返回的错误响应的正文。 |
Managed |
托管服务标识。 |
Managed |
托管服务标识的类型。 |
Private |
专用链接连接的状态 |
Remote |
远程专用终结点连接 |
Response |
包含常见 Azure 资源管理器属性和资源提供程序特定内容的消息信封。 |
Sku |
App 服务计划缩放选项的说明。 |
Sku |
可缩放资源的 SKU 说明。 |
Staging |
指示静态 Web 应用是否允许过渡环境的状态。 |
Static |
静态站点 ARM 资源。 |
Static |
为静态站点生成属性。 |
Static |
静态网站的集合。 |
Static |
数据库连接配置文件 |
Static |
静态站点链接后端 ARM 资源。 |
Static |
静态站点的模板选项。 |
Static |
静态站点用户提供的函数。 |
user |
用户分配的标识。 |
ArmIdWrapper
ARM 资源 ID 的包装器
名称 | 类型 | 说明 |
---|---|---|
id |
string |
ArmPlan
Azure 资源管理器 中的计划对象表示市场计划。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
名称。 |
product |
string |
产品。 |
promotionCode |
string |
促销代码。 |
publisher |
string |
发布服务器。 |
version |
string |
产品版本。 |
Capability
描述特定 SKU 允许的功能/功能。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
SKU 功能的名称。 |
reason |
string |
SKU 功能的原因。 |
value |
string |
SKU 功能的值。 |
DatabaseConnectionOverview
静态站点数据库连接概述。
名称 | 类型 | 说明 |
---|---|---|
configurationFiles |
与此数据库连接关联的配置文件的列表。 |
|
connectionIdentity |
string |
如果存在,则标识与 连接字符串 一起使用以连接到数据库。 使用系统分配的托管标识以字符串“SystemAssigned”表示,而用户分配的托管标识的使用则用托管标识资源的资源 ID 指示。 |
name |
string |
如果存在,则为此数据库连接资源的名称。 |
region |
string |
数据库资源的区域。 |
resourceId |
string |
数据库的资源 ID。 |
DefaultErrorResponse
App 服务错误响应。
名称 | 类型 | 说明 |
---|---|---|
error |
错误模型。 |
Details
名称 | 类型 | 说明 |
---|---|---|
code |
string |
标准化字符串,用于以编程方式标识错误。 |
message |
string |
详细的错误说明和调试信息。 |
target |
string |
详细的错误说明和调试信息。 |
EnterpriseGradeCdnStatus
状态,指示向静态 Web 应用提供流量的企业级 CDN 的状态。
名称 | 类型 | 说明 |
---|---|---|
Disabled |
string |
|
Disabling |
string |
|
Enabled |
string |
|
Enabling |
string |
Error
错误模型。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
用于以编程方式识别错误的标准化字符串。 |
details |
Details[] |
详细错误。 |
innererror |
string |
调试错误的详细信息。 |
message |
string |
详细的错误说明和调试信息。 |
target |
string |
详细的错误说明和调试信息。 |
ErrorEntity
从 API 返回的错误响应的正文。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
基本错误代码。 |
details |
错误详细信息。 |
|
extendedCode |
string |
错误类型。 |
innerErrors |
内部错误。 |
|
message |
string |
错误的任何详细信息。 |
messageTemplate |
string |
消息模板。 |
parameters |
string[] |
模板的参数。 |
target |
string |
错误目标。 |
ManagedServiceIdentity
托管服务标识。
名称 | 类型 | 说明 |
---|---|---|
principalId |
string |
托管服务标识的主体 ID。 |
tenantId |
string |
托管服务标识的租户。 |
type |
托管服务标识的类型。 |
|
userAssignedIdentities |
<string,
user |
与资源关联的用户分配标识的列表。 用户标识字典密钥引用将是采用以下格式的 ARM 资源 ID:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} |
ManagedServiceIdentityType
托管服务标识的类型。
名称 | 类型 | 说明 |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
PrivateLinkConnectionState
专用链接连接的状态
名称 | 类型 | 说明 |
---|---|---|
actionsRequired |
string |
Actions要求专用链接连接 |
description |
string |
专用链接连接的说明 |
status |
string |
专用链接连接的状态 |
RemotePrivateEndpointConnection
远程专用终结点连接
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID。 |
kind |
string |
资源类型。 |
name |
string |
资源名称。 |
properties.ipAddresses |
string[] |
映射到远程专用终结点的专用 IP 地址 |
properties.privateEndpoint |
远程专用终结点连接的 PrivateEndpoint |
|
properties.privateLinkServiceConnectionState |
专用链接连接的状态 |
|
properties.provisioningState |
string |
|
type |
string |
资源类型。 |
ResponseMessageEnvelope[RemotePrivateEndpointConnection]
包含常见 Azure 资源管理器属性和资源提供程序特定内容的消息信封。
名称 | 类型 | 说明 |
---|---|---|
error |
Azure-AsyncOperation 错误信息。 |
|
id |
string |
资源 ID。通常仅针对 GET 请求的响应填充 ID。 调用方仅负责为 GET 请求传入此值。 例如:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} |
identity |
MSI 资源 |
|
location |
string |
地理区域资源属于,例如 SouthCentralUS、SouthEastAsia。 |
name |
string |
资源的名称。 |
plan |
Azure 资源管理器计划。 |
|
properties |
特定于资源的属性。 |
|
sku |
资源的 SKU 说明。 |
|
status |
string |
Azure-AsyncOperation 状态信息。 |
tags |
object |
与资源关联的标记。 |
type |
string |
资源类型,例如“Microsoft.Web/sites”。 |
zones |
string[] |
承载服务的逻辑可用性区域 |
SkuCapacity
App 服务计划缩放选项的说明。
名称 | 类型 | 说明 |
---|---|---|
default |
integer |
此App 服务计划 SKU 的默认辅助角色数。 |
elasticMaximum |
integer |
此App 服务计划 SKU 的最大弹性辅助角色数。 |
maximum |
integer |
此App 服务计划 SKU 的最大辅助角色数。 |
minimum |
integer |
此App 服务计划 SKU 的最小辅助角色数。 |
scaleType |
string |
App 服务计划的可用缩放配置。 |
SkuDescription
可缩放资源的 SKU 说明。
名称 | 类型 | 说明 |
---|---|---|
capabilities |
SKU 的功能,例如是否启用了流量管理器? |
|
capacity |
integer |
当前分配给资源的实例数。 |
family |
string |
资源 SKU 的系列代码。 |
locations |
string[] |
SKU 的位置。 |
name |
string |
资源 SKU 的名称。 |
size |
string |
资源 SKU 的大小说明符。 |
skuCapacity |
SKU 的最小、最大值和默认缩放值。 |
|
tier |
string |
资源 SKU 的服务层。 |
StagingEnvironmentPolicy
指示静态 Web 应用是否允许过渡环境的状态。
名称 | 类型 | 说明 |
---|---|---|
Disabled |
string |
|
Enabled |
string |
StaticSiteARMResource
静态站点 ARM 资源。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID。 |
identity |
托管服务标识。 |
|
kind |
string |
资源类型。 |
location |
string |
资源位置。 |
name |
string |
资源名称。 |
properties.allowConfigFileUpdates |
boolean |
|
properties.branch |
string |
存储库中的目标分支。 |
properties.buildProperties |
生成要对存储库进行配置的属性。 |
|
properties.contentDistributionEndpoint |
string |
静态站点的内容分发终结点。 |
properties.customDomains |
string[] |
与此静态站点关联的自定义域。 |
properties.databaseConnections |
静态站点的数据库连接 |
|
properties.defaultHostname |
string |
静态站点的默认自动生成的主机名。 |
properties.enterpriseGradeCdnStatus |
状态,指示向静态 Web 应用提供流量的企业级 CDN 的状态。 |
|
properties.keyVaultReferenceIdentity |
string |
用于密钥保管库参考身份验证的标识。 |
properties.linkedBackends |
链接到静态端的后端 |
|
properties.privateEndpointConnections |
专用终结点连接 |
|
properties.provider |
string |
将最后一个部署提交到静态站点的主环境的提供程序。 |
properties.publicNetworkAccess |
string |
指示静态 Web 应用是否允许公共流量的状态。 允许的值:“Enabled”、“Disabled”或空字符串。 |
properties.repositoryToken |
string |
用户的 github 存储库令牌。 这用于设置 Github Actions 工作流文件和 API 机密。 |
properties.repositoryUrl |
string |
静态站点存储库的 URL。 |
properties.stagingEnvironmentPolicy |
指示静态 Web 应用是否允许过渡环境的状态。 |
|
properties.templateProperties |
用于生成新存储库的模板选项。 |
|
properties.userProvidedFunctionApps |
向静态站点注册的用户提供的函数应用 |
|
sku |
可缩放资源的 SKU 说明。 |
|
tags |
object |
资源标记。 |
type |
string |
资源类型。 |
StaticSiteBuildProperties
为静态站点生成属性。
名称 | 类型 | 说明 |
---|---|---|
apiBuildCommand |
string |
在部署 Azure Functions API 应用程序期间运行的自定义命令。 |
apiLocation |
string |
存储库中 API 代码的路径。 |
appArtifactLocation |
string |
已弃用:生成后应用项目的路径 (弃用,改用 OutputLocation) |
appBuildCommand |
string |
在部署静态内容应用程序期间运行的自定义命令。 |
appLocation |
string |
存储库中应用代码的路径。 |
githubActionSecretNameOverride |
string |
Github 操作机密名称替代。 |
outputLocation |
string |
生成后应用的输出路径。 |
skipGithubActionWorkflowGeneration |
boolean |
跳过 Github 操作工作流生成。 |
StaticSiteCollection
静态网站的集合。
名称 | 类型 | 说明 |
---|---|---|
nextLink |
string |
指向下一页资源的链接。 |
value |
资源的集合。 |
StaticSiteDatabaseConnectionConfigurationFileOverview
数据库连接配置文件
名称 | 类型 | 说明 |
---|---|---|
contents |
string |
文件内容的 Base64 编码。 |
fileName |
string |
配置文件的名称。 |
type |
string |
配置文件的类型。 |
StaticSiteLinkedBackend
静态站点链接后端 ARM 资源。
名称 | 类型 | 说明 |
---|---|---|
backendResourceId |
string |
链接到静态站点的后端的资源 ID |
createdOn |
string |
后端链接到静态站点的日期和时间。 |
provisioningState |
string |
链接过程的预配状态。 |
region |
string |
链接到静态站点的后端区域 |
StaticSiteTemplateOptions
静态站点的模板选项。
名称 | 类型 | 说明 |
---|---|---|
description |
string |
新生成的存储库的说明。 |
isPrivate |
boolean |
新生成的存储库是否为专用存储库。 默认为 false (即公共) 。 |
owner |
string |
新生成的存储库的所有者。 |
repositoryName |
string |
新生成的存储库的名称。 |
templateRepositoryUrl |
string |
模板存储库的 URL。 新生成的存储库将基于此存储库。 |
StaticSiteUserProvidedFunctionApp
静态站点用户提供的函数。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID。 |
kind |
string |
资源类型。 |
name |
string |
资源名称。 |
properties.createdOn |
string |
向静态站点注册函数应用的日期和时间。 |
properties.functionAppRegion |
string |
向静态站点注册的函数应用的区域 |
properties.functionAppResourceId |
string |
向静态站点注册的函数应用的资源 ID |
type |
string |
资源类型。 |
userAssignedIdentity
用户分配的标识。
名称 | 类型 | 说明 |
---|---|---|
clientId |
string |
用户分配标识的客户端 ID |
principalId |
string |
用户分配标识的主体 ID |