Static Sites - Get Static Site Custom Domain

Usługa:

App Service

Wersja interfejsu API:

2024-11-01

Opis pobiera istniejącą domenę niestandardową dla określonej witryny statycznej.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
domainName	path	True	string	Nazwa domeny niestandardowej.
name	path	True	string	Nazwa zasobu witryny statycznej do wyszukania.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nazwa grupy zasobów, do której należy zasób.
subscriptionId	path	True	string	Twój identyfikator subskrypcji Azure. Jest to ciąg w formacie GUID (np. 0000000000-0000-0000-0000-0000000000000).
api-version	query	True	string	Wersja interfejsu API

Odpowiedzi

Nazwa	Typ	Opis
200 OK	StaticSiteCustomDomainOverviewARMResource	OK
Other Status Codes	DefaultErrorResponse	Odpowiedź na błąd usługi App Service.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Get custom domain for a static site

Przykładowe żądanie

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=2024-11-01

Java

/**
 * Samples for StaticSites GetStaticSiteCustomDomain.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/GetStaticSiteCustomDomain.json
     */
    /**
     * Sample code: Get custom domain for a static site.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getCustomDomainForAStaticSite(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getStaticSites().getStaticSiteCustomDomainWithResponse("rg",
            "testStaticSite0", "custom.domain.net", com.azure.core.util.Context.NONE);
    }
}

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

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/stable/2024-11-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/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.Web/stable/2024-11-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/stable/2024-11-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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/GetStaticSiteCustomDomain.json
// this example is just showing the usage of "StaticSites_GetStaticSiteCustomDomain" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this StaticSiteResource created on azure
// for more information of creating StaticSiteResource, please refer to the document of StaticSiteResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "rg";
string name = "testStaticSite0";
ResourceIdentifier staticSiteResourceId = StaticSiteResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
StaticSiteResource staticSite = client.GetStaticSiteResource(staticSiteResourceId);

// get the collection of this StaticSiteCustomDomainOverviewResource
StaticSiteCustomDomainOverviewCollection collection = staticSite.GetStaticSiteCustomDomainOverviews();

// invoke the operation
string domainName = "custom.domain.net";
NullableResponse<StaticSiteCustomDomainOverviewResource> response = await collection.GetIfExistsAsync(domainName);
StaticSiteCustomDomainOverviewResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    StaticSiteCustomDomainOverviewData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
CustomDomainStatus	Stan domeny niestandardowej
DefaultErrorResponse	Odpowiedź na błąd usługi App Service.
Details
Error	Model błędu.
StaticSiteCustomDomainOverviewARMResource	Zasób usługi ARM — domena niestandardowa witryny statycznej — omówienie.

CustomDomainStatus

Wyliczanie

Stan domeny niestandardowej

Wartość	Opis
Adding
Deleting
Failed
Ready
RetrievingValidationToken
Unhealthy
Validating

DefaultErrorResponse

Objekt

Odpowiedź na błąd usługi App Service.

Nazwa	Typ	Opis
error	Error	Model błędu.

Details

Objekt

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg do programowego identyfikowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

Error

Objekt

Model błędu.

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg do programowego identyfikowania błędu.
details	Details[]	Szczegółowe błędy.
innererror	string	Więcej informacji na temat debugowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

StaticSiteCustomDomainOverviewARMResource

Objekt

Zasób usługi ARM — domena niestandardowa witryny statycznej — omówienie.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
kind	string	Rodzaj zasobu.
name	string	Nazwa zasobu.
properties.createdOn	string (date-time)	Data i godzina utworzenia domeny niestandardowej dla witryny statycznej.
properties.domainName	string	Nazwa domeny domeny niestandardowej witryny statycznej.
properties.errorMessage	string
properties.status	CustomDomainStatus	Stan domeny niestandardowej
properties.validationToken	string	Token weryfikacji rekordu TXT
type	string	Typ zasobu.