Static Sites - Get Linked Backends For Build

Servicio:

App Service

Versión de la API:

2024-11-01

Devuelve los detalles de todos los back-end vinculados a una compilación de sitio estático.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
environmentName	path	True	string	Identificador del sitio de fase
name	path	True	string	Nombre del sitio estático
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nombre del grupo de recursos al que pertenece el recurso.
subscriptionId	path	True	string	Su identificador de suscripción de Azure. Se trata de una cadena con formato GUID (por ejemplo, 000000000-00000-0000-0000-00000000000000).
api-version	query	True	string	Versión de la API

Respuestas

Nombre	Tipo	Description
200 OK	StaticSiteLinkedBackendsCollection	De acuerdo
Other Status Codes	DefaultErrorResponse	Respuesta de error de App Service.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Get details of the linked backends registered with a static site build.

Solicitud de ejemplo

HTTP

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

dotnet

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

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/GetLinkedBackendsForStaticSiteBuild.json
// this example is just showing the usage of "StaticSites_GetLinkedBackendsForBuild" 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 = "default";
ResourceIdentifier staticSiteBuildResourceId = StaticSiteBuildResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name, environmentName);
StaticSiteBuildResource staticSiteBuild = client.GetStaticSiteBuildResource(staticSiteBuildResourceId);

// get the collection of this StaticSiteBuildLinkedBackendResource
StaticSiteBuildLinkedBackendCollection collection = staticSiteBuild.GetStaticSiteBuildLinkedBackends();

// invoke the operation and iterate over the result
await foreach (StaticSiteBuildLinkedBackendResource item in collection.GetAllAsync())
{
    // the variable item 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
    StaticSiteLinkedBackendData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Respuesta de muestra

status code:

200

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/linkedBackends/testBackend",
      "name": "testBackend",
      "type": "Microsoft.Web/staticSites/builds/linkedBackends",
      "properties": {
        "backendResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/functionRG/providers/Microsoft.Web/sites/testBackend",
        "region": "West US 2",
        "createdOn": "2020-03-04T17:33:11.641Z",
        "provisioningState": "Succeeded"
      }
    }
  ],
  "nextLink": null
}

Definiciones

Nombre	Description
DefaultErrorResponse	Respuesta de error de App Service.
Details
Error	Modelo de error.
StaticSiteLinkedBackendARMResource	Recurso arm de back-end vinculado de sitio estático.
StaticSiteLinkedBackendsCollection	Colección de back-end vinculados a sitios estáticos.

DefaultErrorResponse

Object

Respuesta de error de App Service.

Nombre	Tipo	Description
error	Error	Modelo de error.

Details

Object

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar mediante programación el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

Error

Object

Modelo de error.

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar mediante programación el error.
details	Details[]	Errores detallados.
innererror	string	Más información para depurar el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

StaticSiteLinkedBackendARMResource

Object

Recurso arm de back-end vinculado de sitio estático.

Nombre	Tipo	Description
id	string	Identificador de recurso.
kind	string	Tipo de recurso.
name	string	Nombre del recurso.
properties.backendResourceId	string	Identificador de recurso del back-end vinculado al sitio estático
properties.createdOn	string (date-time)	Fecha y hora en la que el back-end estaba vinculado al sitio estático.
properties.provisioningState	string	Estado de aprovisionamiento del proceso de vinculación.
properties.region	string	Región del back-end vinculado al sitio estático
type	string	Tipo de recurso.

StaticSiteLinkedBackendsCollection

Object

Colección de back-end vinculados a sitios estáticos.

Nombre	Tipo	Description
nextLink	string	Vínculo a la página siguiente de recursos.
value	StaticSiteLinkedBackendARMResource[]	Colección de recursos.