你当前正在访问 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=2022-03-01

URI 参数

Name In Required Type Description
resourceGroupName
path True
  • string

资源所属的资源组的名称。

Regex pattern: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True
  • string

Azure 订阅 ID。 这是 GUID 格式的字符串, (例如 00000000-0000-0000-0000-0000000000000) 。

api-version
query True
  • string

API 版本

响应

Name Type Description
200 OK

没问题。

Other Status Codes

App 服务错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Get static sites for a resource group

Sample Request

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites?api-version=2022-03-01

Sample Response

{
  "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
}

定义

ArmIdWrapper

ARM 资源 ID 的包装器

ArmPlan

Azure 资源管理器中的计划对象表示市场计划。

Capability

描述特定 SKU 允许的功能/功能。

DefaultErrorResponse

App 服务错误响应。

Details
EnterpriseGradeCdnStatus

指示向静态 Web 应用提供服务流量的企业级 CDN 的状态。

Error

错误模型。

ErrorEntity

从 API 返回的错误响应的正文。

ManagedServiceIdentity

托管服务标识。

ManagedServiceIdentityType

托管服务标识的类型。

PrivateLinkConnectionState

专用链接连接的状态

RemotePrivateEndpointConnection

远程专用终结点连接

ResponseMessageEnvelope[RemotePrivateEndpointConnection]

包含常见 Azure 资源管理器属性和资源提供程序特定内容的消息信封。

SkuCapacity

App 服务计划缩放选项的说明。

SkuDescription

可缩放资源的 SKU 的说明。

StagingEnvironmentPolicy

指示静态 Web 应用是否允许暂存环境的状态。

StaticSiteARMResource

静态站点 ARM 资源。

StaticSiteBuildProperties

生成静态站点的属性。

StaticSiteCollection

静态网站的集合。

StaticSiteLinkedBackend

静态站点链接后端 ARM 资源。

StaticSiteTemplateOptions

静态网站的模板选项。

StaticSiteUserProvidedFunctionApp

静态站点用户提供的函数。

userAssignedIdentity

用户分配的标识。

ArmIdWrapper

ARM 资源 ID 的包装器

Name Type Description
id
  • string

ArmPlan

Azure 资源管理器中的计划对象表示市场计划。

Name Type Description
name
  • string

名称。

product
  • string

产品。

promotionCode
  • string

促销代码。

publisher
  • string

发布服务器。

version
  • string

产品版本。

Capability

描述特定 SKU 允许的功能/功能。

Name Type Description
name
  • string

SKU 功能的名称。

reason
  • string

SKU 功能的原因。

value
  • string

SKU 功能的值。

DefaultErrorResponse

App 服务错误响应。

Name Type Description
error

错误模型。

Details

Name Type Description
code
  • string

用于以编程方式标识错误的标准化字符串。

message
  • string

详细的错误说明和调试信息。

target
  • string

详细的错误说明和调试信息。

EnterpriseGradeCdnStatus

指示向静态 Web 应用提供服务流量的企业级 CDN 的状态。

Name Type Description
Disabled
  • string
Disabling
  • string
Enabled
  • string
Enabling
  • string

Error

错误模型。

Name Type Description
code
  • string

用于以编程方式标识错误的标准化字符串。

details

详细错误。

innererror
  • string

调试错误的详细信息。

message
  • string

详细的错误说明和调试信息。

target
  • string

详细的错误说明和调试信息。

ErrorEntity

从 API 返回的错误响应的正文。

Name Type Description
code
  • string

基本错误代码。

details

错误详细信息。

extendedCode
  • string

错误类型。

innerErrors

内部错误。

message
  • string

错误的任何详细信息。

messageTemplate
  • string

消息模板。

parameters
  • string[]

模板的参数。

target
  • string

错误目标。

ManagedServiceIdentity

托管服务标识。

Name Type Description
principalId
  • string

托管服务标识的主体 ID。

tenantId
  • string

托管服务标识的租户。

type

托管服务标识的类型。

userAssignedIdentities

与资源关联的用户分配标识的列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

托管服务标识的类型。

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

PrivateLinkConnectionState

专用链接连接的状态

Name Type Description
actionsRequired
  • string

专用链接连接的 ActionsRequired

description
  • string

专用链接连接的说明

status
  • string

专用链接连接的状态

RemotePrivateEndpointConnection

远程专用终结点连接

Name Type Description
id
  • string

资源 ID。

kind
  • string

资源类型。

name
  • string

资源名称。

properties.ipAddresses
  • string[]

映射到远程专用终结点的专用 IPAddresses

properties.privateEndpoint

远程专用终结点连接的 PrivateEndpoint

properties.privateLinkServiceConnectionState

专用链接连接的状态

properties.provisioningState
  • string
type
  • string

资源类型。

ResponseMessageEnvelope[RemotePrivateEndpointConnection]

包含常见 Azure 资源管理器属性和资源提供程序特定内容的消息信封。

Name Type Description
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 服务计划缩放选项的说明。

Name Type Description
default
  • integer

此App 服务计划 SKU 的默认辅助角色数。

elasticMaximum
  • integer

此App 服务计划 SKU 的最大弹性辅助角色数。

maximum
  • integer

此App 服务计划 SKU 的最大辅助角色数。

minimum
  • integer

此App 服务计划 SKU 的最小辅助角色数。

scaleType
  • string

App 服务计划的可用缩放配置。

SkuDescription

可缩放资源的 SKU 的说明。

Name Type Description
capabilities

SKU 的功能,例如是否启用了流量管理器?

capacity
  • integer

分配给资源的当前实例数。

family
  • string

资源 SKU 的系列代码。

locations
  • string[]

SKU 的位置。

name
  • string

资源 SKU 的名称。

size
  • string

资源 SKU 的大小说明符。

skuCapacity

SKU 的最小值、最大值和默认缩放值。

tier
  • string

资源 SKU 的服务层。

StagingEnvironmentPolicy

指示静态 Web 应用是否允许暂存环境的状态。

Name Type Description
Disabled
  • string
Enabled
  • string

StaticSiteARMResource

静态站点 ARM 资源。

Name Type Description
id
  • string

资源 ID。

identity

托管服务标识。

kind
  • string

资源类型。

location
  • string

资源位置。

name
  • string

资源名称。

properties.allowConfigFileUpdates
  • boolean

false 如果此静态 Web 应用锁定了配置文件,则为否则,为 true.

properties.branch
  • string

存储库中的目标分支。

properties.buildProperties

生成要在存储库上配置的属性。

properties.contentDistributionEndpoint
  • string

静态站点的内容分发终结点。

properties.customDomains
  • string[]

与此静态站点关联的自定义域。

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

生成静态站点的属性。

Name Type Description
apiBuildCommand
  • string

在部署 Azure Functions API 应用程序期间运行的自定义命令。

apiLocation
  • string

存储库中 API 代码的路径。

appArtifactLocation
  • string

已弃用:生成后应用项目的路径 (弃用,转而支持 OutputLocation)

appBuildCommand
  • string

在部署静态内容应用程序期间运行的自定义命令。

appLocation
  • string

存储库中应用代码的路径。

githubActionSecretNameOverride
  • string

Github Action 机密名称替代。

outputLocation
  • string

生成后应用的输出路径。

skipGithubActionWorkflowGeneration
  • boolean

跳过 Github Action 工作流生成。

StaticSiteCollection

静态网站的集合。

Name Type Description
nextLink
  • string

链接到下一页的资源。

value

资源集合。

StaticSiteLinkedBackend

静态站点链接后端 ARM 资源。

Name Type Description
backendResourceId
  • string

链接到静态站点的后端的资源 ID

createdOn
  • string

后端链接到静态站点的日期和时间。

provisioningState
  • string

链接进程的预配状态。

region
  • string

链接到静态站点的后端区域

StaticSiteTemplateOptions

静态网站的模板选项。

Name Type Description
description
  • string

新生成的存储库的说明。

isPrivate
  • boolean

新生成的存储库是否为专用存储库。 默认为 false (,即公共) 。

owner
  • string

新生成的存储库的所有者。

repositoryName
  • string

新生成的存储库的名称。

templateRepositoryUrl
  • string

模板存储库的 URL。 新生成的存储库将基于此存储库。

StaticSiteUserProvidedFunctionApp

静态站点用户提供的函数。

Name Type Description
id
  • string

资源 ID。

kind
  • string

资源类型。

name
  • string

资源名称。

properties.createdOn
  • string

函数应用注册到静态站点的日期和时间。

properties.functionAppRegion
  • string

向静态站点注册的函数应用的区域

properties.functionAppResourceId
  • string

向静态站点注册的函数应用的资源 ID

type
  • string

资源类型。

userAssignedIdentity

用户分配的标识。

Name Type Description
clientId
  • string

用户分配标识的客户端 ID

principalId
  • string

用户分配标识的主体 ID