Static Sites - Get Database Connections With Details

Layanan:

App Service

Versi API:

2025-03-01

Mengembalikan detail koneksi database untuk situs statis

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/showDatabaseConnections?api-version=2025-03-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
name	path	True	string	Nama situs statis
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nama grup sumber daya tempat sumber daya berada.
subscriptionId	path	True	string	ID langganan Azure Anda. Ini adalah string berformat GUID (misalnya 000000000-0000-0000-0000-000000000000).
api-version	query	True	string	Versi API

Respons

Nama	Jenis	Deskripsi
200 OK	DatabaseConnectionCollection	OK
Other Status Codes	DefaultErrorResponse	Respons kesalahan App Service.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

List full details of database connections for the static site.

Permintaan sampel

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/showDatabaseConnections?api-version=2025-03-01

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_database_connections_with_details.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_database_connections_with_details(
        resource_group_name="rg",
        name="testStaticSite0",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/GetStaticSiteDatabaseConnectionsWithDetails.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/9f4cb2884f1948b879ecfb3f410e8cbc8805c213/specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/GetStaticSiteDatabaseConnectionsWithDetails.json
func ExampleStaticSitesClient_NewGetDatabaseConnectionsWithDetailsPager() {
	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)
	}
	pager := clientFactory.NewStaticSitesClient().NewGetDatabaseConnectionsWithDetailsPager("rg", "testStaticSite0", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DatabaseConnectionCollection = armappservice.DatabaseConnectionCollection{
		// 	Value: []*armappservice.DatabaseConnection{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.Web/staticSites/databaseConnections"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/databaseConnections/default"),
		// 			Properties: &armappservice.DatabaseConnectionProperties{
		// 				ConfigurationFiles: []*armappservice.StaticSiteDatabaseConnectionConfigurationFileOverview{
		// 					{
		// 						Type: to.Ptr("configuration"),
		// 						Contents: to.Ptr("base64encodeddatabaseconfiguration"),
		// 						FileName: to.Ptr("staticwebapp.database.config.json"),
		// 					},
		// 					{
		// 						Type: to.Ptr("graphqlschema"),
		// 						Contents: to.Ptr("base64encodeddatabasegraphqlschema"),
		// 						FileName: to.Ptr("staticwebapp.database.schema.gql"),
		// 				}},
		// 				ConnectionIdentity: to.Ptr("SystemAssigned"),
		// 				ConnectionString: to.Ptr("AccountEndpoint=https://exampleDatabaseName.documents.azure.com:443/;Database=mydb;"),
		// 				Region: to.Ptr("West US 2"),
		// 				ResourceID: to.Ptr("/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName"),
		// 			},
		// 	}},
		// }
	}
}

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 Returns details of database connections for a static site
 *
 * @summary Returns details of database connections for a static site
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/GetStaticSiteDatabaseConnectionsWithDetails.json
 */
async function listFullDetailsOfDatabaseConnectionsForTheStaticSite() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "rg";
  const name = "testStaticSite0";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.staticSites.listDatabaseConnectionsWithDetails(
    resourceGroupName,
    name,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

Respon sampel

Kode status:

200

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/databaseConnections/default",
      "name": "default",
      "type": "Microsoft.Web/staticSites/databaseConnections",
      "properties": {
        "resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName",
        "connectionIdentity": "SystemAssigned",
        "connectionString": "AccountEndpoint=https://exampleDatabaseName.documents.azure.com:443/;Database=mydb;",
        "region": "West US 2",
        "configurationFiles": [
          {
            "fileName": "staticwebapp.database.config.json",
            "contents": "base64encodeddatabaseconfiguration",
            "type": "configuration"
          },
          {
            "fileName": "staticwebapp.database.schema.gql",
            "contents": "base64encodeddatabasegraphqlschema",
            "type": "graphqlschema"
          }
        ]
      }
    }
  ],
  "nextLink": null
}

Definisi

Nama	Deskripsi
DatabaseConnection	Sumber daya Koneksi Database Situs Statis.
DatabaseConnectionCollection	Kumpulan koneksi database situs statis.
DefaultErrorResponse	Respons kesalahan App Service.
Details
Error	Model kesalahan.
StaticSiteDatabaseConnectionConfigurationFileOverview	File konfigurasi koneksi database

DatabaseConnection

Objek

Sumber daya Koneksi Database Situs Statis.

Nama	Jenis	Deskripsi
id	string	Id Sumber Daya.
kind	string	Jenis sumber daya.
name	string	Nama Sumber Daya.
properties.configurationFiles	StaticSiteDatabaseConnectionConfigurationFileOverview[]	Daftar file konfigurasi yang terkait dengan koneksi database ini.
properties.connectionIdentity	string	Jika ada, identitas digunakan bersama dengan string koneksi untuk menyambungkan ke database. Penggunaan identitas terkelola yang ditetapkan sistem ditunjukkan dengan string 'SystemAssigned', sementara penggunaan identitas terkelola yang ditetapkan pengguna ditunjukkan dengan id sumber daya sumber daya sumber daya identitas terkelola.
properties.connectionString	string	String koneksi yang digunakan untuk menyambungkan ke database.
properties.region	string	Wilayah sumber daya database.
properties.resourceId	string	Id sumber daya database.
type	string	Jenis sumber daya.

DatabaseConnectionCollection

Objek

Kumpulan koneksi database situs statis.

Nama	Jenis	Deskripsi
nextLink	string	Tautkan ke halaman sumber daya berikutnya.
value	DatabaseConnection[]	Koleksi sumber daya.

DefaultErrorResponse

Objek

Respons kesalahan App Service.

Nama	Jenis	Deskripsi
error	Error	Model kesalahan.

Details

Objek

Nama	Jenis	Deskripsi
code	string	String standar untuk mengidentifikasi kesalahan secara terprogram.
message	string	Deskripsi kesalahan terperinci dan informasi debugging.
target	string	Deskripsi kesalahan terperinci dan informasi debugging.

Error

Objek

Model kesalahan.

Nama	Jenis	Deskripsi
code	string	String standar untuk mengidentifikasi kesalahan secara terprogram.
details	Details[]	Kesalahan terperinci.
innererror	string	Informasi selengkapnya untuk men-debug kesalahan.
message	string	Deskripsi kesalahan terperinci dan informasi debugging.
target	string	Deskripsi kesalahan terperinci dan informasi debugging.

StaticSiteDatabaseConnectionConfigurationFileOverview

Objek

File konfigurasi koneksi database

Nama	Jenis	Deskripsi
contents	string	Pengkodean Base64 dari konten file.
fileName	string	Nama file konfigurasi.
type	string	Jenis file konfigurasi.