Web Apps - Update Azure Storage Accounts

Dienst:

App Service

API-Version:

2023-12-01

Beschreibung für Updates der Azure-Speicherkontokonfigurationen einer App.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
name	path	True	string	Name der App
resourceGroupName	path	True	string	Name der Ressourcengruppe, zu der die Ressource gehört. RegEx-Muster: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	die Azure-Abonnement-ID Dies ist eine GUID-formatierte Zeichenfolge (z. B. 00000000-0000-0000-0000-00000000000000).
api-version	query	True	string	API-Version

Anforderungstext

Name	Typ	Beschreibung
kind	string	Art der Ressource.
properties.	AzureStorageInfoValue	Azure Files- oder Blob Storage-Zugriffsdatenwert für den Wörterbuchspeicher.

Antworten

Name	Typ	Beschreibung
200 OK	AzureStoragePropertyDictionaryResource	OK
Other Status Codes	DefaultErrorResponse	App Service Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Update Azure Storage Accounts

Beispielanforderung

HTTP

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

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

Java

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-12-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

Python

from typing import Any, IO, Union

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-12-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

Go

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/21c2852d62ccc3abe9cc3800c989c6826f8363dc/specification/web/resource-manager/Microsoft.Web/stable/2023-12-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

JavaScript

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-12-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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/UpdateAzureStorageAccounts.json
// this example is just showing the usage of "WebApps_UpdateAzureStorageAccounts" 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 WebSiteResource created on azure
// for more information of creating WebSiteResource, please refer to the document of WebSiteResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "sitef6141";
ResourceIdentifier webSiteResourceId = WebSiteResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
WebSiteResource webSite = client.GetWebSiteResource(webSiteResourceId);

// invoke the operation
AzureStoragePropertyDictionary azureStorageAccounts = new AzureStoragePropertyDictionary()
{
    Properties =
    {
    ["account1"] = new AppServiceStorageAccessInfo()
    {
    StorageType = AppServiceStorageType.AzureFiles,
    AccountName = "testsa",
    ShareName = "web",
    AccessKey = "26515^%@#*",
    MountPath = "/mounts/a/files",
    },
    },
};
AzureStoragePropertyDictionary result = await webSite.UpdateAzureStorageAccountsAsync(azureStorageAccounts);

Console.WriteLine($"Succeeded: {result}");

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

Beispiel für eine Antwort

Statuscode:

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"
    }
  }
}

Definitionen

Name	Beschreibung
AzureStorageInfoValue	Azure Files- oder Blob Storage-Zugriffsdatenwert für den Wörterbuchspeicher.
AzureStoragePropertyDictionaryResource	AzureStorageInfo-Wörterbuchressource.
AzureStorageProtocol	Bereitstellungsprotokoll, das für das Speicherkonto verwendet werden soll.
AzureStorageState	Status des Speicherkontos.
AzureStorageType	Speichertyp.
DefaultErrorResponse	App Service Fehlerantwort.
Details
Error	Fehlermodell.

AzureStorageInfoValue

Azure Files- oder Blob Storage-Zugriffsdatenwert für den Wörterbuchspeicher.

Name	Typ	Beschreibung
accessKey	string	Zugriffsschlüssel für das Speicherkonto.
accountName	string	Name des Speicherkontos.
mountPath	string	Pfad zum Einbinden des Speichers in der Laufzeitumgebung des Standorts.
protocol	AzureStorageProtocol	Bereitstellungsprotokoll, das für das Speicherkonto verwendet werden soll.
shareName	string	Name der Dateifreigabe (Containername, für Blob Storage).
state	AzureStorageState	Status des Speicherkontos.
type	AzureStorageType	Speichertyp.

AzureStoragePropertyDictionaryResource

AzureStorageInfo-Wörterbuchressource.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
kind	string	Art der Ressource.
name	string	Ressourcenname.
properties.	AzureStorageInfoValue	Azure Files- oder Blob Storage-Zugriffsdatenwert für den Wörterbuchspeicher.
type	string	Der Ressourcentyp.

AzureStorageProtocol

Bereitstellungsprotokoll, das für das Speicherkonto verwendet werden soll.

Name	Typ	Beschreibung
Http	string
Nfs	string
Smb	string

AzureStorageState

Status des Speicherkontos.

Name	Typ	Beschreibung
InvalidCredentials	string
InvalidShare	string
NotValidated	string
Ok	string

AzureStorageType

Speichertyp.

Name	Typ	Beschreibung
AzureBlob	string
AzureFiles	string

DefaultErrorResponse

App Service Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Fehlermodell.

Details

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

Error

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
details	Details[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen eines Fehlers.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.