Static Sites - Update Database Connection

サービス:

App Service

API バージョン:

2025-05-01

静的サイトのデータベース接続を作成または更新する説明

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

URI パラメーター

名前	/	必須	型	説明
databaseConnectionName	path	True	string pattern: ^[a-zA-Z0-9]+$	データベース接続の名前。
name	path	True	string	静的サイトの名前
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前は大文字と小文字が区別されます。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
properties.connectionIdentity	string	存在する場合、ID は接続文字列と組み合わせて使用され、データベースに接続されます。 システム割り当てマネージド ID の使用は文字列 'SystemAssigned' で示されますが、ユーザー割り当てマネージド ID の使用はマネージド ID リソースのリソース ID で示されます。
properties.connectionString	string	データベースへの接続に使用する接続文字列。
properties.region	string	データベース リソースのリージョン。
properties.resourceId	string	データベースのリソース ID。

応答

名前	型	説明
200 OK	DatabaseConnection	Azure 操作は正常に完了しました。
Other Status Codes	DefaultErrorResponse	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

Patch a database connection for a static site

要求のサンプル

HTTP

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

{
  "properties": {}
}

Java

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

/**
 * Samples for StaticSites UpdateDatabaseConnection.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-05-01/PatchStaticSiteDatabaseConnection.json
     */
    /**
     * Sample code: Patch a database connection for a static site.
     * 
     * @param manager Entry point to AppServiceManager.
     */
    public static void
        patchADatabaseConnectionForAStaticSite(com.azure.resourcemanager.appservice.AppServiceManager manager) {
        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

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/v6"
)

// Generated from example definition: 2025-05-01/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("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", 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 = armappservice.StaticSitesClientUpdateDatabaseConnectionResponse{
	// 	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

応答のサンプル

状態コード:

200

{
  "name": "default",
  "type": "Microsoft.Web/staticSites/databaseConnections",
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/databaseConnections/default",
  "properties": {
    "connectionIdentity": "SystemAssigned",
    "region": "West US 2",
    "resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName"
  }
}

定義

名前	説明
createdByType	リソースを作成した ID の種類。
DatabaseConnection	静的サイト データベース接続リソース。
DatabaseConnectionPatchRequest	修正プログラムの適用時の静的サイト データベース接続要求プロパティ リソース
DefaultErrorResponse	App Service エラー応答。
DefaultErrorResponseError	エラー モデル。
DefaultErrorResponseErrorDetailsItem	詳細なエラー。
StaticSiteDatabaseConnectionConfigurationFileOverview	データベース接続構成ファイル
systemData	リソースの作成と最後の変更に関連するメタデータ。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

DatabaseConnection

Object

静的サイト データベース接続リソース。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	リソースの種類。
name	string	リソースの名前
properties.configurationFiles	StaticSiteDatabaseConnectionConfigurationFileOverview[]	このデータベース接続に関連付けられている構成ファイルのリスト。
properties.connectionIdentity	string	存在する場合、ID は接続文字列と組み合わせて使用され、データベースに接続されます。 システム割り当てマネージド ID の使用は文字列 'SystemAssigned' で示されますが、ユーザー割り当てマネージド ID の使用はマネージド ID リソースのリソース ID で示されます。
properties.connectionString	string	データベースへの接続に使用する接続文字列。
properties.region	string	データベース リソースのリージョン。
properties.resourceId	string	データベースのリソース ID。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

DatabaseConnectionPatchRequest

Object

修正プログラムの適用時の静的サイト データベース接続要求プロパティ リソース

名前	型	説明
properties.connectionIdentity	string	存在する場合、ID は接続文字列と組み合わせて使用され、データベースに接続されます。 システム割り当てマネージド ID の使用は文字列 'SystemAssigned' で示されますが、ユーザー割り当てマネージド ID の使用はマネージド ID リソースのリソース ID で示されます。
properties.connectionString	string	データベースへの接続に使用する接続文字列。
properties.region	string	データベース リソースのリージョン。
properties.resourceId	string	データベースのリソース ID。

DefaultErrorResponse

Object

App Service エラー応答。

名前	型	説明
error	DefaultErrorResponseError	エラー モデル。

DefaultErrorResponseError

Object

エラー モデル。

名前	型	説明
code	string	プログラムでエラーを識別するための標準化された文字列。
details	DefaultErrorResponseErrorDetailsItem[]	詳細なエラー。
innererror	string	エラーのデバッグに関する詳細情報。
message	string	詳細なエラーの説明とデバッグ情報。
target	string	詳細なエラーの説明とデバッグ情報。

DefaultErrorResponseErrorDetailsItem

Object

詳細なエラー。

名前	型	説明
code	string	プログラムでエラーを識別するための標準化された文字列。
message	string	詳細なエラーの説明とデバッグ情報。
target	string	詳細なエラーの説明とデバッグ情報。

StaticSiteDatabaseConnectionConfigurationFileOverview

Object

データベース接続構成ファイル

名前	型	説明
contents	string	ファイル内容の Base64 エンコーディング。
fileName	string	構成ファイルの名前。
type	string	構成ファイルのタイプ。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。