Web Apps - Get App Settings Key Vault References

サービス:

App Service

API バージョン:

2024-11-01

[構成参照アプリの設定とアプリの状態を取得する] の説明

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/appsettings?api-version=2024-11-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 バージョン

応答

名前	型	説明
200 OK	ApiKVReferenceCollection	[OK]
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	ユーザー アカウントを偽装する

例

Get Azure Key Vault references for app settings

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testc6282/config/configreferences/appsettings?api-version=2024-11-01

Java

/**
 * Samples for WebApps GetAppSettingsKeyVaultReferences.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/GetKeyVaultReferencesForAppSettings.
     * json
     */
    /**
     * Sample code: Get Azure Key Vault references for app settings.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAzureKeyVaultReferencesForAppSettings(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().getAppSettingsKeyVaultReferences("testrg123",
            "testc6282", 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 get_key_vault_references_for_app_settings.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.get_app_settings_key_vault_references(
        resource_group_name="testrg123",
        name="testc6282",
    )
    for item in response:
        print(item)


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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/GetKeyVaultReferencesForAppSettings.json
func ExampleWebAppsClient_NewGetAppSettingsKeyVaultReferencesPager() {
	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)
	}
	pager := clientFactory.NewWebAppsClient().NewGetAppSettingsKeyVaultReferencesPager("testrg123", "testc6282", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.APIKVReferenceCollection = armappservice.APIKVReferenceCollection{
		// 	Value: []*armappservice.APIKVReference{
		// 		{
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testc6282/config/configreferences/appsettings/secretName"),
		// 			Properties: &armappservice.APIKVReferenceProperties{
		// 				SecretName: to.Ptr("secretName"),
		// 				SecretVersion: to.Ptr("secretVersion"),
		// 				VaultName: to.Ptr("keyVaultName"),
		// 			},
		// 		},
		// 		{
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testc6282/config/configreferences/appsettings/secretName2"),
		// 			Properties: &armappservice.APIKVReferenceProperties{
		// 				SecretName: to.Ptr("secretName2"),
		// 				SecretVersion: to.Ptr("secretVersion2"),
		// 				VaultName: to.Ptr("keyVaultName"),
		// 			},
		// 	}},
		// }
	}
}

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 Gets the config reference app settings and status of an app
 *
 * @summary Description for Gets the config reference app settings and status of an app
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/GetKeyVaultReferencesForAppSettings.json
 */
async function getAzureKeyVaultReferencesForAppSettings() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "testc6282";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.webApps.listAppSettingsKeyVaultReferences(
    resourceGroupName,
    name,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/GetKeyVaultReferencesForAppSettings.json
// this example is just showing the usage of "WebApps_GetAppSettingsKeyVaultReferences" 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 = "testc6282";
ResourceIdentifier webSiteResourceId = WebSiteResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
WebSiteResource webSite = client.GetWebSiteResource(webSiteResourceId);

// get the collection of this SiteConfigAppsettingResource
SiteConfigAppsettingCollection collection = webSite.GetSiteConfigAppsettings();

// invoke the operation and iterate over the result
await foreach (SiteConfigAppsettingResource item in collection.GetAllAsync())
{
    // the variable item 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
    ApiKeyVaultReferenceData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testc6282/config/configreferences/appsettings/secretName",
      "properties": {
        "vaultName": "keyVaultName",
        "secretName": "secretName",
        "secretVersion": "secretVersion"
      }
    },
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testc6282/config/configreferences/appsettings/secretName2",
      "properties": {
        "vaultName": "keyVaultName",
        "secretName": "secretName2",
        "secretVersion": "secretVersion2"
      }
    }
  ]
}

定義

名前	説明
ApiKVReference	サイト キー コンテナー参照の説明。
ApiKVReferenceCollection
ConfigReferenceSource
DefaultErrorResponse	App Service エラー応答。
Details
Error	エラー モデル。
ManagedServiceIdentity	マネージド サービス ID。
ManagedServiceIdentityType	マネージド サービス ID の種類。
ResolveStatus
userAssignedIdentity	ユーザー割り当て ID。

ApiKVReference

Object

サイト キー コンテナー参照の説明。

名前	型	説明
id	string	リソース ID。
kind	string	リソースの種類。
name	string	リソース名。
properties.activeVersion	string
properties.details	string
properties.identityType	ManagedServiceIdentity	マネージド サービス ID。
properties.reference	string
properties.secretName	string
properties.secretVersion	string
properties.source	ConfigReferenceSource
properties.status	ResolveStatus
properties.vaultName	string
type	string	リソースの種類。

ApiKVReferenceCollection

Object

名前	型	説明
nextLink	string	リソースの次のページへのリンク。
value	ApiKVReference[]	リソースのコレクション。

ConfigReferenceSource

列挙

値	説明
KeyVault

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	エラーの詳細な説明とデバッグ情報。

ManagedServiceIdentity

Object

マネージド サービス ID。

名前	型	説明
principalId	string	マネージド サービス ID のプリンシパル ID。
tenantId	string	マネージド サービス ID のテナント。
type	ManagedServiceIdentityType	マネージド サービス ID の種類。
userAssignedIdentities	<string,  userAssignedIdentity>	リソースに関連付けられているユーザー割り当て ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。

ManagedServiceIdentityType

列挙

マネージド サービス ID の種類。

値	説明
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

ResolveStatus

列挙

値	説明
AccessToKeyVaultDenied
FetchTimedOut
Initialized
InvalidSyntax
MSINotEnabled
OtherReasons
Resolved
SecretNotFound
SecretVersionNotFound
UnauthorizedClient
VaultNotFound

userAssignedIdentity

Object

ユーザー割り当て ID。

名前	型	説明
clientId	string	ユーザー割り当て ID のクライアント ID
principalId	string	ユーザー割り当て ID のプリンシパル ID