Static Sites - Update Database Connection

Szolgáltatás:

App Service

API-verzió:

2024-04-01

A statikus hely adatbázis-kapcsolatának létrehozása vagy frissítése

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}?api-version=2024-04-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
databaseConnectionName	path	True	string pattern: ^[a-zA-Z0-9]+$	Az adatbázis-kapcsolat neve.
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 Azure-előfizetés azonosítója. Ez egy GUID formátumú sztring (például 000000000-0000-0000-0000-0000000000).
api-version	query	True	string	API-verzió

Kérelem törzse

Name	Típus	Description
properties.connectionIdentity	string	Ha jelen van, az identitást a kapcsolati sztringgel együtt használja a rendszer az adatbázishoz való csatlakozáshoz. A rendszer által hozzárendelt felügyelt identitás használatát a "SystemAssigned" sztring jelzi, míg a felhasználó által hozzárendelt felügyelt identitás használata a felügyelt identitás erőforrás-azonosítójával van megjelölve.
properties.connectionString	string	Az adatbázishoz való csatlakozáshoz használandó kapcsolati sztring.
properties.region	string	Az adatbázis-erőforrás régiója.
properties.resourceId	string	Az adatbázis erőforrás-azonosítója.

Válaszok

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

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Patch a database connection for a static site

Mintakérelem

HTTP

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

{
  "properties": {}
}

Java

import com.azure.resourcemanager.appservice.models.DatabaseConnectionPatchRequest;

/**
 * Samples for StaticSites UpdateDatabaseConnection.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchStaticSiteDatabaseConnection.
     * json
     */
    /**
     * Sample code: Patch a database connection for a static site.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void patchADatabaseConnectionForAStaticSite(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getStaticSites().updateDatabaseConnectionWithResponse("rg",
            "testStaticSite0", "default", new DatabaseConnectionPatchRequest(), 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 patch_static_site_database_connection.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.update_database_connection(
        resource_group_name="rg",
        name="testStaticSite0",
        database_connection_name="default",
        database_connection_request_envelope={"properties": {}},
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchStaticSiteDatabaseConnection.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/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchStaticSiteDatabaseConnection.json
func ExampleStaticSitesClient_UpdateDatabaseConnection() {
	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().UpdateDatabaseConnection(ctx, "rg", "testStaticSite0", "default", armappservice.DatabaseConnectionPatchRequest{
		Properties: &armappservice.DatabaseConnectionPatchRequestProperties{},
	}, 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.DatabaseConnection = 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{
	// 		ConnectionIdentity: to.Ptr("SystemAssigned"),
	// 		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 Description for Create or update a database connection for a static site
 *
 * @summary Description for Create or update a database connection for a static site
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchStaticSiteDatabaseConnection.json
 */
async function patchADatabaseConnectionForAStaticSite() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "rg";
  const name = "testStaticSite0";
  const databaseConnectionName = "default";
  const databaseConnectionRequestEnvelope = {};
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.staticSites.updateDatabaseConnection(
    resourceGroupName,
    name,
    databaseConnectionName,
    databaseConnectionRequestEnvelope,
  );
  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-04-01/examples/PatchStaticSiteDatabaseConnection.json
// this example is just showing the usage of "StaticSites_UpdateDatabaseConnection" 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 StaticSiteDatabaseConnectionResource created on azure
// for more information of creating StaticSiteDatabaseConnectionResource, please refer to the document of StaticSiteDatabaseConnectionResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "rg";
string name = "testStaticSite0";
string databaseConnectionName = "default";
ResourceIdentifier staticSiteDatabaseConnectionResourceId = StaticSiteDatabaseConnectionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name, databaseConnectionName);
StaticSiteDatabaseConnectionResource staticSiteDatabaseConnection = client.GetStaticSiteDatabaseConnectionResource(staticSiteDatabaseConnectionResourceId);

// invoke the operation
StaticSiteDatabaseConnectionPatchContent content = new StaticSiteDatabaseConnectionPatchContent();
StaticSiteDatabaseConnectionResource result = await staticSiteDatabaseConnection.UpdateAsync(content);

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

Mintaválasz

Állapotkód:

200

{
  "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",
    "region": "West US 2"
  }
}

Definíciók

Name	Description
DatabaseConnection	Statikus helyadatbázis-kapcsolati erőforrás.
DatabaseConnectionPatchRequest	Statikus helyadatbázis kapcsolatkérési tulajdonságai erőforrás javításkor
DefaultErrorResponse	App Service-hibaválasz.
Details
Error	Hibamodell.
StaticSiteDatabaseConnectionConfigurationFileOverview	Adatbázis-kapcsolat konfigurációs fájlja

DatabaseConnection

Objektum

Statikus helyadatbázis-kapcsolati 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.configurationFiles	StaticSiteDatabaseConnectionConfigurationFileOverview[]	Az adatbázis-kapcsolathoz társított konfigurációs fájlok listája.
properties.connectionIdentity	string	Ha jelen van, az identitást a kapcsolati sztringgel együtt használja a rendszer az adatbázishoz való csatlakozáshoz. A rendszer által hozzárendelt felügyelt identitás használatát a "SystemAssigned" sztring jelzi, míg a felhasználó által hozzárendelt felügyelt identitás használata a felügyelt identitás erőforrás-azonosítójával van megjelölve.
properties.connectionString	string	Az adatbázishoz való csatlakozáshoz használandó kapcsolati sztring.
properties.region	string	Az adatbázis-erőforrás régiója.
properties.resourceId	string	Az adatbázis erőforrás-azonosítója.
type	string	Erőforrás típusa.

DatabaseConnectionPatchRequest

Objektum

Statikus helyadatbázis kapcsolatkérési tulajdonságai erőforrás javításkor

Name	Típus	Description
properties.connectionIdentity	string	Ha jelen van, az identitást a kapcsolati sztringgel együtt használja a rendszer az adatbázishoz való csatlakozáshoz. A rendszer által hozzárendelt felügyelt identitás használatát a "SystemAssigned" sztring jelzi, míg a felhasználó által hozzárendelt felügyelt identitás használata a felügyelt identitás erőforrás-azonosítójával van megjelölve.
properties.connectionString	string	Az adatbázishoz való csatlakozáshoz használandó kapcsolati sztring.
properties.region	string	Az adatbázis-erőforrás régiója.
properties.resourceId	string	Az adatbázis erőforrás-azonosítója.

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.

StaticSiteDatabaseConnectionConfigurationFileOverview

Objektum

Adatbázis-kapcsolat konfigurációs fájlja

Name	Típus	Description
contents	string	A fájl tartalmának Base64-kódolása.
fileName	string	A konfigurációs fájl neve.
type	string	A konfigurációs fájl típusa.