Static Sites - Get Static Site Custom Domain

服务:

App Service

API 版本:

2025-03-01

获取特定静态站点的现有自定义域的说明。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}?api-version=2025-03-01

URI 参数

名称	在	必需	类型	说明
domainName	path	True	string	自定义域名。
name	path	True	string	要在其中搜索的静态站点资源的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	资源所属的资源组的名称。
subscriptionId	path	True	string	Azure 订阅 ID。 这是 GUID 格式的字符串（例如 000000000-0000-0000-0000-00000000000000）。
api-version	query	True	string	API 版本

响应

名称	类型	说明
200 OK	StaticSiteCustomDomainOverviewARMResource	好的
Other Status Codes	DefaultErrorResponse	应用服务错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Get custom domain for a static site

示例请求

HTTP

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python get_static_site_custom_domain.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.static_sites.get_static_site_custom_domain(
        resource_group_name="rg",
        name="testStaticSite0",
        domain_name="custom.domain.net",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/GetStaticSiteCustomDomain.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9f4cb2884f1948b879ecfb3f410e8cbc8805c213/specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/GetStaticSiteCustomDomain.json
func ExampleStaticSitesClient_GetStaticSiteCustomDomain() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewStaticSitesClient().GetStaticSiteCustomDomain(ctx, "rg", "testStaticSite0", "custom.domain.net", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.StaticSiteCustomDomainOverviewARMResource = armappservice.StaticSiteCustomDomainOverviewARMResource{
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSitesBuilds/testStaticSite0/customDomains/custom.domain.net"),
	// 	Properties: &armappservice.StaticSiteCustomDomainOverviewARMResourceProperties{
	// 		CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-04T17:33:11.641Z"); return t}()),
	// 		DomainName: to.Ptr("custom.domain.net"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Description for Gets an existing custom domain for a particular static site.
 *
 * @summary Description for Gets an existing custom domain for a particular static site.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/GetStaticSiteCustomDomain.json
 */
async function getCustomDomainForAStaticSite() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "rg";
  const name = "testStaticSite0";
  const domainName = "custom.domain.net";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.staticSites.getStaticSiteCustomDomain(
    resourceGroupName,
    name,
    domainName,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:

200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSitesBuilds/testStaticSite0/customDomains/custom.domain.net",
  "properties": {
    "domainName": "custom.domain.net",
    "createdOn": "2020-03-04T17:33:11.641Z"
  }
}

定义

名称	说明
CustomDomainStatus	自定义域的状态
DefaultErrorResponse	应用服务错误响应。
Details
Error	错误模型。
StaticSiteCustomDomainOverviewARMResource	静态站点自定义域概述 ARM 资源。

CustomDomainStatus

枚举

自定义域的状态

值	说明
RetrievingValidationToken
Validating
Adding
Ready
Failed
Deleting
Unhealthy

DefaultErrorResponse

对象

应用服务错误响应。

名称	类型	说明
error	Error	错误模型。

Details

对象

名称	类型	说明
code	string	标准化字符串，以编程方式识别错误。
message	string	详细的错误描述和调试信息。
target	string	详细的错误描述和调试信息。

Error

对象

错误模型。

名称	类型	说明
code	string	标准化字符串，以编程方式识别错误。
details	Details[]	详细错误。
innererror	string	调试错误的更多信息。
message	string	详细的错误描述和调试信息。
target	string	详细的错误描述和调试信息。

StaticSiteCustomDomainOverviewARMResource

对象

静态站点自定义域概述 ARM 资源。

名称	类型	说明
id	string	资源 ID。
kind	string	资源类型。
name	string	资源名称。
properties.createdOn	string (date-time)	为静态站点创建自定义域的日期和时间。
properties.domainName	string	静态站点自定义域的域名。
properties.errorMessage	string
properties.status	CustomDomainStatus	自定义域的状态
properties.validationToken	string	TXT 记录验证令牌
type	string	资源类型。