Static Sites - Get Static Site Build

Dienst:

App Service

API-Version:

2024-11-01

Beschreibung für Ruft die Details eines statischen Websitebuilds ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
environmentName	path	True	string	Die Phasenwebsite-ID.
name	path	True	string	Name der statischen Website.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Name der Ressourcengruppe, zu der die Ressource gehört.
subscriptionId	path	True	string	die Azure-Abonnement-ID Dies ist eine GUID-formatierte Zeichenfolge (z. B. 0000000-0000-0000-0000-000000000000).
api-version	query	True	string	API-Version

Antworten

Name	Typ	Beschreibung
200 OK	StaticSiteBuildARMResource	OKAY.
Other Status Codes	DefaultErrorResponse	Fehlerantwort des App-Diensts.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get a static site build

Beispielanforderung

HTTP

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

Java

/**
 * 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

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_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

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/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

JavaScript

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

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/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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
BuildStatus	Der Status des statischen Websitebuilds.
DatabaseConnectionOverview	Übersicht über statische Websitedatenbankverbindung.
DefaultErrorResponse	Fehlerantwort des App-Diensts.
Details
Error	Fehlermodell.
StaticSiteBuildARMResource	Arm-Ressource für statische Websitebuild.
StaticSiteDatabaseConnectionConfigurationFileOverview	Konfigurationsdatei für Datenbankverbindung
StaticSiteLinkedBackend	Static Site Linked Back-End ARM-Ressource.
StaticSiteUserProvidedFunctionApp	Eine von einem statischen Websitebenutzer bereitgestellte Funktion.

BuildStatus

Enumeration

Der Status des statischen Websitebuilds.

Wert	Beschreibung
Deleting
Deploying
Detached
Failed
Ready
Uploading
WaitingForDeployment

DatabaseConnectionOverview

Objekt

Übersicht über statische Websitedatenbankverbindung.

Name	Typ	Beschreibung
configurationFiles	StaticSiteDatabaseConnectionConfigurationFileOverview[]	Eine Liste der Konfigurationsdateien, die dieser Datenbankverbindung zugeordnet sind.
connectionIdentity	string	Wenn vorhanden, wird die Identität in Verbindung mit der Verbindungszeichenfolge verwendet, um eine Verbindung mit der Datenbank herzustellen. Die Verwendung der vom System zugewiesenen verwalteten Identität wird mit der Zeichenfolge "SystemAssigned" angegeben, während die Verwendung einer vom Benutzer zugewiesenen verwalteten Identität mit der Ressourcen-ID der verwalteten Identitätsressource angegeben wird.
name	string	Wenn vorhanden, der Name dieser Datenbankverbindungsressource.
region	string	Der Bereich der Datenbankressource.
resourceId	string	Die Ressourcen-ID der Datenbank.

DefaultErrorResponse

Objekt

Fehlerantwort des App-Diensts.

Name	Typ	Beschreibung
error	Error	Fehlermodell.

Details

Objekt

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

Error

Objekt

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
details	Details[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen von Fehlern.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

StaticSiteBuildARMResource

Objekt

Arm-Ressource für statische Websitebuild.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
kind	string	Art der Ressource.
name	string	Ressourcenname.
properties.buildId	string	Ein Bezeichner für den statischen Websitebuild.
properties.createdTimeUtc	string (date-time)	Wann dieser Build erstellt wurde.
properties.databaseConnections	DatabaseConnectionOverview[]	Datenbankverbindungen für den statischen Websitebuild
properties.hostname	string	Der Hostname für einen statischen Websitebuild.
properties.lastUpdatedOn	string (date-time)	Wann dieser Build aktualisiert wurde.
properties.linkedBackends	StaticSiteLinkedBackend[]	Back-Ends, die mit dem statischen Seitenbuild verknüpft sind
properties.pullRequestTitle	string	Der Titel einer Pullanforderung, mit der ein statischer Websitebuild verknüpft ist.
properties.sourceBranch	string	Der Quellzweig.
properties.status	BuildStatus	Der Status des statischen Websitebuilds.
properties.userProvidedFunctionApps	StaticSiteUserProvidedFunctionApp[]	Vom Benutzer bereitgestellte Funktions-Apps, die beim statischen Websitebuild registriert sind
type	string	Ressourcentyp.

StaticSiteDatabaseConnectionConfigurationFileOverview

Objekt

Konfigurationsdatei für Datenbankverbindung

Name	Typ	Beschreibung
contents	string	Die Base64-Codierung des Dateiinhalts.
fileName	string	Der Name der Konfigurationsdatei.
type	string	Der Typ der Konfigurationsdatei.

StaticSiteLinkedBackend

Objekt

Static Site Linked Back-End ARM-Ressource.

Name	Typ	Beschreibung
backendResourceId	string	Die Ressourcen-ID des Back-End,das mit der statischen Website verknüpft ist
createdOn	string (date-time)	Das Datum und die Uhrzeit, zu dem das Back-End mit der statischen Website verknüpft wurde.
provisioningState	string	Der Bereitstellungsstatus des Verknüpfungsprozesses.
region	string	Der Bereich des Back-End-Bereichs, der mit der statischen Website verknüpft ist

StaticSiteUserProvidedFunctionApp

Objekt

Eine von einem statischen Websitebenutzer bereitgestellte Funktion.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
kind	string	Art der Ressource.
name	string	Ressourcenname.
properties.createdOn	string (date-time)	Das Datum und die Uhrzeit, zu dem die Funktions-App bei der statischen Website registriert wurde.
properties.functionAppRegion	string	Der Bereich der Funktions-App, die bei der statischen Website registriert ist
properties.functionAppResourceId	string	Die Ressourcen-ID der Funktions-App, die bei der statischen Website registriert ist
type	string	Ressourcentyp.