Web Apps - Update Azure Storage Accounts

リファレンス

サービス:: App Service

API バージョン:: 2023-01-01

「アプリの Azure ストレージアカウント構成を更新する」の説明。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts?api-version=2023-01-01

URI パラメーター

名前	/	必須	型	説明
name	path	True	string	アプリの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+[^\.]$	リソースが属するリソースグループの名前。
subscriptionId	path	True	string	Azure サブスクリプション ID。これは GUID 形式の文字列です (例: 000000000-0000-0000-0000-000000000000)。
api-version	query	True	string	API バージョン

要求本文

名前	型	説明
kind	string	リソースの種類。
properties.	AzureStorageInfoValue	ディクショナリストレージの Azure Files または Blob Storage アクセス情報の値。

応答

名前	型	説明
200 OK	AzureStoragePropertyDictionaryResource	わかりました
Other Status Codes	DefaultErrorResponse	App Service エラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

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

例

Update Azure Storage Accounts

要求のサンプル

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/azurestorageaccounts?api-version=2023-01-01

{
  "properties": {
    "account1": {
      "type": "AzureFiles",
      "accountName": "testsa",
      "shareName": "web",
      "accessKey": "26515^%@#*",
      "mountPath": "/mounts/a/files"
    }
  }
}


import com.azure.resourcemanager.appservice.fluent.models.AzureStoragePropertyDictionaryResourceInner;
import com.azure.resourcemanager.appservice.models.AzureStorageInfoValue;
import com.azure.resourcemanager.appservice.models.AzureStorageType;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for WebApps UpdateAzureStorageAccounts.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/UpdateAzureStorageAccounts.json
     */
    /**
     * Sample code: Update Azure Storage Accounts.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateAzureStorageAccounts(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().updateAzureStorageAccountsWithResponse("testrg123",
            "sitef6141",
            new AzureStoragePropertyDictionaryResourceInner().withProperties(mapOf("account1",
                new AzureStorageInfoValue().withType(AzureStorageType.AZURE_FILES).withAccountName("testsa")
                    .withShareName("web").withAccessKey("fakeTokenPlaceholder").withMountPath("/mounts/a/files"))),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python update_azure_storage_accounts.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.web_apps.update_azure_storage_accounts(
        resource_group_name="testrg123",
        name="sitef6141",
        azure_storage_accounts={
            "properties": {
                "account1": {
                    "accessKey": "26515^%@#*",
                    "accountName": "testsa",
                    "mountPath": "/mounts/a/files",
                    "shareName": "web",
                    "type": "AzureFiles",
                }
            }
        },
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/UpdateAzureStorageAccounts.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

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/738ab25fe76324897f273645906d4a0415068a6c/specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/UpdateAzureStorageAccounts.json
func ExampleWebAppsClient_UpdateAzureStorageAccounts() {
	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.NewWebAppsClient().UpdateAzureStorageAccounts(ctx, "testrg123", "sitef6141", armappservice.AzureStoragePropertyDictionaryResource{
		Properties: map[string]*armappservice.AzureStorageInfoValue{
			"account1": {
				Type:        to.Ptr(armappservice.AzureStorageTypeAzureFiles),
				AccessKey:   to.Ptr("26515^%@#*"),
				AccountName: to.Ptr("testsa"),
				MountPath:   to.Ptr("/mounts/a/files"),
				ShareName:   to.Ptr("web"),
			},
		},
	}, 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.AzureStoragePropertyDictionaryResource = armappservice.AzureStoragePropertyDictionaryResource{
	// 	Name: to.Ptr("web"),
	// 	Type: to.Ptr("Microsoft.Web/sites/config"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/web"),
	// 	Kind: to.Ptr("app"),
	// 	Properties: map[string]*armappservice.AzureStorageInfoValue{
	// 		"account1": &armappservice.AzureStorageInfoValue{
	// 			Type: to.Ptr(armappservice.AzureStorageTypeAzureFiles),
	// 			AccountName: to.Ptr("testsa"),
	// 			MountPath: to.Ptr("/mounts/a/files"),
	// 			ShareName: to.Ptr("web"),
	// 			State: to.Ptr(armappservice.AzureStorageStateOk),
	// 		},
	// 	},
	// }
}

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

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Description for Updates the Azure storage account configurations of an app.
 *
 * @summary Description for Updates the Azure storage account configurations of an app.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/UpdateAzureStorageAccounts.json
 */
async function updateAzureStorageAccounts() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "sitef6141";
  const azureStorageAccounts = {
    properties: {
      account1: {
        type: "AzureFiles",
        accessKey: "26515^%@#*",
        accountName: "testsa",
        mountPath: "/mounts/a/files",
        shareName: "web",
      },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.updateAzureStorageAccounts(
    resourceGroupName,
    name,
    azureStorageAccounts
  );
  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

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/web",
  "name": "web",
  "type": "Microsoft.Web/sites/config",
  "kind": "app",
  "properties": {
    "account1": {
      "type": "AzureFiles",
      "accountName": "testsa",
      "shareName": "web",
      "mountPath": "/mounts/a/files",
      "state": "Ok"
    }
  }
}

定義

名前	説明
AzureStorageInfoValue	ディクショナリストレージの Azure Files または Blob Storage アクセス情報の値。
AzureStoragePropertyDictionaryResource	AzureStorageInfo ディクショナリリソース。
AzureStorageState	ストレージアカウントの状態。
AzureStorageType	ストレージの種類。
DefaultErrorResponse	App Service エラー応答。
Details
Error	エラーモデル。

AzureStorageInfoValue

Object

ディクショナリストレージの Azure Files または Blob Storage アクセス情報の値。

名前	型	説明
accessKey	string	ストレージアカウントのアクセスキー。
accountName	string	ストレージアカウントの名前。
mountPath	string	サイトのランタイム環境内にストレージをマウントするパス。
shareName	string	ファイル共有の名前 (BLOB ストレージの場合はコンテナー名)。
state	AzureStorageState	ストレージアカウントの状態。
type	AzureStorageType	ストレージの種類。

AzureStoragePropertyDictionaryResource

Object

AzureStorageInfo ディクショナリリソース。

名前	型	説明
id	string	リソース ID。
kind	string	リソースの種類。
name	string	リソース名。
properties.	AzureStorageInfoValue	ディクショナリストレージの Azure Files または Blob Storage アクセス情報の値。
type	string	リソースの種類。

AzureStorageState

列挙

ストレージアカウントの状態。

値	説明
InvalidCredentials
InvalidShare
NotValidated
Ok

AzureStorageType

列挙

ストレージの種類。

値	説明
AzureBlob
AzureFiles

DefaultErrorResponse

Object

App Service エラー応答。

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

Details

Object

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

Error

Object

エラーモデル。

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

次の方法で共有

Web Apps - Update Azure Storage Accounts

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

Update Azure Storage Accounts

要求のサンプル

応答のサンプル

定義

AzureStorageInfoValue

AzureStoragePropertyDictionaryResource

AzureStorageState

AzureStorageType

DefaultErrorResponse

Details

Error