Web Apps - Get App Setting Key Vault Reference

Service:

App Service

API Version:

2023-01-01

Opis pobierania odwołania do konfiguracji i stanu aplikacji

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
appSettingKey	path	True	string	Nazwa klucza ustawienia aplikacji.
name	path	True	string	Nazwa aplikacji.
resourceGroupName	path	True	string	Nazwa grupy zasobów, do której należy zasób. Regex pattern: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Azure. Jest to ciąg w formacie GUID (np. 00000000-0000-0000-0000-0000-000000000000).
api-version	query	True	string	Wersja interfejsu API

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ApiKVReference	OK
Other Status Codes	DefaultErrorResponse	App Service odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Get Azure Key Vault app setting reference

Sample Request

HTTP

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

Java

/**
 * Samples for WebApps GetAppSettingKeyVaultReference.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/GetKeyVaultReferencesForAppSetting.
     * json
     */
    /**
     * Sample code: Get Azure Key Vault app setting reference.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAzureKeyVaultAppSettingReference(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().getAppSettingKeyVaultReferenceWithResponse("testrg123",
            "testc6282", "setting", 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_setting.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_setting_key_vault_reference(
        resource_group_name="testrg123",
        name="testc6282",
        app_setting_key="setting",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/GetKeyVaultReferencesForAppSetting.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/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/GetKeyVaultReferencesForAppSetting.json
func ExampleWebAppsClient_GetAppSettingKeyVaultReference() {
	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().GetAppSettingKeyVaultReference(ctx, "testrg123", "testc6282", "setting", 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.APIKVReference = armappservice.APIKVReference{
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testc6282/config/configreferences/appsettings/setting"),
	// 	Properties: &armappservice.APIKVReferenceProperties{
	// 		SecretName: to.Ptr("secretName"),
	// 		SecretVersion: to.Ptr("secretVersion"),
	// 		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");

/**
 * This sample demonstrates how to Description for Gets the config reference and status of an app
 *
 * @summary Description for Gets the config reference and status of an app
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/GetKeyVaultReferencesForAppSetting.json
 */
async function getAzureKeyVaultAppSettingReference() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "testc6282";
  const appSettingKey = "setting";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.getAppSettingKeyVaultReference(
    resourceGroupName,
    name,
    appSettingKey
  );
  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

Sample Response

Status code:

200

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

Definicje

Nazwa	Opis
ApiKVReference	Opis odwołań do magazynu kluczy lokacji.
ConfigReferenceSource
DefaultErrorResponse	App Service odpowiedź na błąd.
Details
Error	Model błędu.
ManagedServiceIdentity	Tożsamość usługi zarządzanej.
ManagedServiceIdentityType	Typ tożsamości usługi zarządzanej.
ResolveStatus
userAssignedIdentity	Tożsamość przypisana przez użytkownika.

ApiKVReference

Opis odwołań do magazynu kluczy lokacji.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
kind	string	Rodzaj zasobu.
name	string	Nazwa zasobu.
properties.activeVersion	string
properties.details	string
properties.identityType	ManagedServiceIdentity	Tożsamość usługi zarządzanej.
properties.reference	string
properties.secretName	string
properties.secretVersion	string
properties.source	ConfigReferenceSource
properties.status	ResolveStatus
properties.vaultName	string
type	string	Typ zasobu.

ConfigReferenceSource

Nazwa	Typ	Opis
KeyVault	string

DefaultErrorResponse

App Service odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Model błędu.

Details

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg w celu programowego identyfikowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

Error

Model błędu.

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg w celu programowego identyfikowania błędu.
details	Details[]	Szczegółowe błędy.
innererror	string	Więcej informacji na temat debugowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

ManagedServiceIdentity

Tożsamość usługi zarządzanej.

Nazwa	Typ	Opis
principalId	string	Identyfikator podmiotu zabezpieczeń tożsamości usługi zarządzanej.
tenantId	string	Dzierżawa tożsamości usługi zarządzanej.
type	ManagedServiceIdentityType	Typ tożsamości usługi zarządzanej.
userAssignedIdentities	<string,  userAssignedIdentity>	Lista tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Typ tożsamości usługi zarządzanej.

Nazwa	Typ	Opis
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ResolveStatus

Nazwa	Typ	Opis
AccessToKeyVaultDenied	string
FetchTimedOut	string
Initialized	string
InvalidSyntax	string
MSINotEnabled	string
OtherReasons	string
Resolved	string
SecretNotFound	string
SecretVersionNotFound	string
UnauthorizedClient	string
VaultNotFound	string

userAssignedIdentity

Tożsamość przypisana przez użytkownika.

Nazwa	Typ	Opis
clientId	string	Identyfikator klienta tożsamości przypisanej przez użytkownika
principalId	string	Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez użytkownika