Static Sites - Get Static Site Build

Usługa:: App Service

Wersja interfejsu API:: 2024-11-01

Opis pobierania szczegółów kompilacji witryny statycznej.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
environmentName	path	True	string	Identyfikator witryny etapu.
name	path	True	string	Nazwa witryny statycznej.
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	StaticSiteBuildARMResource	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 a static site build

Przykładowe żądanie

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


/**
 * Samples for StaticSites GetStaticSiteBuild.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/GetStaticSiteBuild.json
     */
    /**
     * Sample code: Get a static site build.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAStaticSiteBuild(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getStaticSites().getStaticSiteBuildWithResponse("rg",
            "testStaticSite0", "12", 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

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_build.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_build(
        resource_group_name="rg",
        name="testStaticSite0",
        environment_name="12",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/GetStaticSiteBuild.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

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/GetStaticSiteBuild.json
func ExampleStaticSitesClient_GetStaticSiteBuild() {
	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().GetStaticSiteBuild(ctx, "rg", "testStaticSite0", "12", 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.StaticSiteBuildARMResource = armappservice.StaticSiteBuildARMResource{
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/12"),
	// 	Properties: &armappservice.StaticSiteBuildARMResourceProperties{
	// 		BuildID: to.Ptr("12"),
	// 		CreatedTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-04T17:33:11.641Z"); return t}()),
	// 		Hostname: to.Ptr("happy-sea-15afae3e-12.westus2.azurestaticwebsites.net"),
	// 		LastUpdatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-04T17:33:11.641Z"); return t}()),
	// 		LinkedBackends: []*armappservice.StaticSiteLinkedBackend{
	// 			{
	// 				BackendResourceID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.ApiManagement/service/apimService0"),
	// 				CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-26T20:57:24.805Z"); return t}()),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 		}},
	// 		PullRequestTitle: to.Ptr("Update README.md"),
	// 		SourceBranch: to.Ptr("pr-branch"),
	// 		Status: to.Ptr(armappservice.BuildStatusUploading),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Description for Gets the details of a static site build.
 *
 * @summary Description for Gets the details of a static site build.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/GetStaticSiteBuild.json
 */
async function getAStaticSiteBuild() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "rg";
  const name = "testStaticSite0";
  const environmentName = "12";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.staticSites.getStaticSiteBuild(
    resourceGroupName,
    name,
    environmentName,
  );
  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

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/GetStaticSiteBuild.json
// this example is just showing the usage of "StaticSites_GetStaticSiteBuild" 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 StaticSiteBuildResource created on azure
// for more information of creating StaticSiteBuildResource, please refer to the document of StaticSiteBuildResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "rg";
string name = "testStaticSite0";
string environmentName = "12";
ResourceIdentifier staticSiteBuildResourceId = StaticSiteBuildResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name, environmentName);
StaticSiteBuildResource staticSiteBuild = client.GetStaticSiteBuildResource(staticSiteBuildResourceId);

// invoke the operation
StaticSiteBuildResource result = await staticSiteBuild.GetAsync();

// 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
StaticSiteBuildData 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/staticSites/testStaticSite0/builds/12",
  "properties": {
    "buildId": "12",
    "sourceBranch": "pr-branch",
    "pullRequestTitle": "Update README.md",
    "hostname": "happy-sea-15afae3e-12.westus2.azurestaticwebsites.net",
    "createdTimeUtc": "2020-03-04T17:33:11.641Z",
    "lastUpdatedOn": "2020-03-04T17:33:11.641Z",
    "status": "Uploading",
    "userProvidedFunctionApps": null,
    "linkedBackends": [
      {
        "backendResourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.ApiManagement/service/apimService0",
        "region": null,
        "createdOn": "2022-03-27T04:57:24.8058474",
        "provisioningState": "Succeeded"
      }
    ]
  }
}

Definicje

Nazwa	Opis
BuildStatus	Stan kompilacji witryny statycznej.
DatabaseConnectionOverview	Omówienie połączenia z bazą danych lokacji statycznej.
DefaultErrorResponse	Odpowiedź na błąd usługi App Service.
Details
Error	Model błędu.
StaticSiteBuildARMResource	Zasób usługi ARM kompilacji witryny statycznej.
StaticSiteDatabaseConnectionConfigurationFileOverview	Plik konfiguracji połączenia z bazą danych
StaticSiteLinkedBackend	Zasób usługi ARM połączonej lokacji statycznej.
StaticSiteUserProvidedFunctionApp	Funkcja udostępniona przez użytkownika witryny statycznej.

BuildStatus

Wyliczanie

Stan kompilacji witryny statycznej.

Wartość	Opis
Deleting
Deploying
Detached
Failed
Ready
Uploading
WaitingForDeployment

DatabaseConnectionOverview

Objekt

Omówienie połączenia z bazą danych lokacji statycznej.

Nazwa	Typ	Opis
configurationFiles	StaticSiteDatabaseConnectionConfigurationFileOverview[]	Lista plików konfiguracji skojarzonych z tym połączeniem bazy danych.
connectionIdentity	string	Jeśli istnieje, tożsamość jest używana w połączeniu z parametrami połączenia w celu nawiązania połączenia z bazą danych. Użycie tożsamości zarządzanej przypisanej przez system jest wskazywane za pomocą ciągu "SystemAssigned", podczas gdy użycie tożsamości zarządzanej przypisanej przez użytkownika jest wskazywane przy użyciu identyfikatora zasobu tożsamości zarządzanej.
name	string	Jeśli istnieje, nazwa tego zasobu połączenia z bazą danych.
region	string	Region zasobu bazy danych.
resourceId	string	Identyfikator zasobu bazy danych.

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.

StaticSiteBuildARMResource

Objekt

Zasób usługi ARM kompilacji witryny statycznej.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
kind	string	Rodzaj zasobu.
name	string	Nazwa zasobu.
properties.buildId	string	Identyfikator kompilacji witryny statycznej.
properties.createdTimeUtc	string (date-time)	Po utworzeniu tej kompilacji.
properties.databaseConnections	DatabaseConnectionOverview[]	Połączenia bazy danych dla kompilacji lokacji statycznej
properties.hostname	string	Nazwa hosta kompilacji witryny statycznej.
properties.lastUpdatedOn	string (date-time)	Po zaktualizowaniu tej kompilacji.
properties.linkedBackends	StaticSiteLinkedBackend[]	Zaplecza połączone z kompilacją po stronie statycznej
properties.pullRequestTitle	string	Tytuł żądania ściągnięcia, z którego jest powiązana kompilacja witryny statycznej.
properties.sourceBranch	string	Gałąź źródłowa.
properties.status	BuildStatus	Stan kompilacji witryny statycznej.
properties.userProvidedFunctionApps	StaticSiteUserProvidedFunctionApp[]	Aplikacje funkcji udostępnione przez użytkownika zarejestrowane w kompilacji witryny statycznej
type	string	Typ zasobu.

StaticSiteDatabaseConnectionConfigurationFileOverview

Objekt

Plik konfiguracji połączenia z bazą danych

Nazwa	Typ	Opis
contents	string	Kodowanie base64 zawartości pliku.
fileName	string	Nazwa pliku konfiguracji.
type	string	Typ pliku konfiguracji.

StaticSiteLinkedBackend

Objekt

Zasób usługi ARM połączonej lokacji statycznej.

Nazwa	Typ	Opis
backendResourceId	string	Identyfikator zasobu zaplecza połączonego z witryną statyczną
createdOn	string (date-time)	Data i godzina, w której zaplecze zostało połączone z witryną statyczną.
provisioningState	string	Stan aprowizacji procesu łączenia.
region	string	Region zaplecza połączonego z witryną statyczną

StaticSiteUserProvidedFunctionApp

Objekt

Funkcja udostępniona przez użytkownika witryny statycznej.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
kind	string	Rodzaj zasobu.
name	string	Nazwa zasobu.
properties.createdOn	string (date-time)	Data i godzina zarejestrowania aplikacji funkcji w witrynie statycznej.
properties.functionAppRegion	string	Region aplikacji funkcji zarejestrowany w witrynie statycznej
properties.functionAppResourceId	string	Identyfikator zasobu aplikacji funkcji zarejestrowanej w witrynie statycznej
type	string	Typ zasobu.