Static Sites - Get Linked Backends For Build

Szolgáltatás:

App Service

API-verzió:

2024-11-01

A statikus webhely buildeléséhez csatolt összes háttérrendszer adatait adja vissza

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
environmentName	path	True	string	A szakaszwebhely azonosítója
name	path	True	string	A statikus hely neve
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Annak az erőforráscsoportnak a neve, amelyhez az erőforrás tartozik.
subscriptionId	path	True	string	Az Ön Azure előfizetési azonosítója. Ez egy GUID formátumú sztring (például 000000000-0000-0000-0000-0000000000).
api-version	query	True	string	API-verzió

Válaszok

Name	Típus	Description
200 OK	StaticSiteLinkedBackendsCollection	OKÉ
Other Status Codes	DefaultErrorResponse	App Service-hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

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

Mintakérelem

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

Mintaválasz

Állapotkód:

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
}

Definíciók

Name	Description
DefaultErrorResponse	App Service-hibaválasz.
Details
Error	Hibamodell.
StaticSiteLinkedBackendARMResource	Statikus helyhez társított háttér ARM-erőforrás.
StaticSiteLinkedBackendsCollection	Statikus helyhez csatolt háttérrendszerek gyűjteménye.

DefaultErrorResponse

Objektum

App Service-hibaválasz.

Name	Típus	Description
error	Error	Hibamodell.

Details

Objektum

Name	Típus	Description
code	string	Szabványosított sztring a hiba programozott azonosításához.
message	string	Részletes hibaleírás és hibakeresési információk.
target	string	Részletes hibaleírás és hibakeresési információk.

Error

Objektum

Hibamodell.

Name	Típus	Description
code	string	Szabványosított sztring a hiba programozott azonosításához.
details	Details[]	Részletes hibák.
innererror	string	További információ a hibakereséshez.
message	string	Részletes hibaleírás és hibakeresési információk.
target	string	Részletes hibaleírás és hibakeresési információk.

StaticSiteLinkedBackendARMResource

Objektum

Statikus helyhez társított háttér ARM-erőforrás.

Name	Típus	Description
id	string	Erőforrás-azonosító.
kind	string	Erőforrás típusa.
name	string	Erőforrás neve.
properties.backendResourceId	string	A statikus helyhez csatolt háttérrendszer erőforrás-azonosítója
properties.createdOn	string (date-time)	A háttérrendszer statikus helyhez való csatolásának dátuma és időpontja.
properties.provisioningState	string	A csatolási folyamat kiépítési állapota.
properties.region	string	A statikus helyhez csatolt háttérrendszer régiója
type	string	Erőforrás típusa.

StaticSiteLinkedBackendsCollection

Objektum

Statikus helyhez csatolt háttérrendszerek gyűjteménye.

Name	Típus	Description
nextLink	string	Hivatkozás az erőforrások következő oldalára.
value	StaticSiteLinkedBackendARMResource[]	Erőforrások gyűjteménye.