Web Apps - Update Azure Storage Accounts

Service:

App Service

API-versie:

2023-12-01

Beschrijving voor Updates de configuraties van het Azure-opslagaccount van een app.

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

URI-parameters

Name	In	Vereist	Type	Description
name	path	True	string	Naam van de app.
resourceGroupName	path	True	string	Naam van de resourcegroep waartoe de resource behoort. Regex-patroon: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	Uw Azure-abonnements-id. Dit is een tekenreeks met GUID-indeling (bijvoorbeeld 000000000-0000-0000-0000-000000000000).
api-version	query	True	string	API-versie

Aanvraagbody

Name	Type	Description
kind	string	Soort resource.
properties.	AzureStorageInfoValue	Azure Files- of Blob Storage-waarde voor toegangsgegevens voor woordenlijstopslag.

Antwoorden

Name	Type	Description
200 OK	AzureStoragePropertyDictionaryResource	OK
Other Status Codes	DefaultErrorResponse	App Service foutreactie.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Update Azure Storage Accounts

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
AzureStorageInfoValue	Azure Files- of Blob Storage-waarde voor toegangsgegevens voor woordenlijstopslag.
AzureStoragePropertyDictionaryResource	AzureStorageInfo-woordenlijstresource.
AzureStorageProtocol	Het koppelingsprotocol dat moet worden gebruikt voor het opslagaccount.
AzureStorageState	Status van het opslagaccount.
AzureStorageType	Type opslag.
DefaultErrorResponse	App Service foutreactie.
Details
Error	Foutmodel.

AzureStorageInfoValue

Azure Files- of Blob Storage-waarde voor toegangsgegevens voor woordenlijstopslag.

Name	Type	Description
accessKey	string	Toegangssleutel voor het opslagaccount.
accountName	string	Naam van het opslagaccount.
mountPath	string	Pad voor het koppelen van de opslag binnen de runtime-omgeving van de site.
protocol	AzureStorageProtocol	Het koppelingsprotocol dat moet worden gebruikt voor het opslagaccount.
shareName	string	Naam van de bestandsshare (containernaam, voor Blob Storage).
state	AzureStorageState	Status van het opslagaccount.
type	AzureStorageType	Type opslag.

AzureStoragePropertyDictionaryResource

AzureStorageInfo-woordenlijstresource.

Name	Type	Description
id	string	Resource-id.
kind	string	Soort resource.
name	string	Resourcenaam.
properties.	AzureStorageInfoValue	Azure Files- of Blob Storage-waarde voor toegangsgegevens voor woordenlijstopslag.
type	string	Resourcetype.

AzureStorageProtocol

Het koppelingsprotocol dat moet worden gebruikt voor het opslagaccount.

Name	Type	Description
Http	string
Nfs	string
Smb	string

AzureStorageState

Status van het opslagaccount.

Name	Type	Description
InvalidCredentials	string
InvalidShare	string
NotValidated	string
Ok	string

AzureStorageType

Type opslag.

Name	Type	Description
AzureBlob	string
AzureFiles	string

DefaultErrorResponse

App Service foutreactie.

Name	Type	Description
error	Error	Foutmodel.

Details

Name	Type	Description
code	string	Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
message	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.
target	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.

Error

Foutmodel.

Name	Type	Description
code	string	Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
details	Details[]	Gedetailleerde fouten.
innererror	string	Meer informatie over foutopsporing.
message	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.
target	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.