Web Apps - Get App Setting Key Vault Reference

Tjänst:

App Service

API-version:

2024-04-01

Beskrivning för Hämtar konfigurationsreferensen och statusen för en app

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
appSettingKey	path	True	string	Namn på appinställningsnyckel.
name	path	True	string	Namnet på appen.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Namnet på resursgruppen som resursen tillhör.
subscriptionId	path	True	string	Ditt Azure-prenumerations-ID. Det här är en GUID-formaterad sträng (t.ex. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API-version

Svar

Name	Typ	Description
200 OK	ApiKVReference	OKEJ
Other Status Codes	DefaultErrorResponse	App Service-felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Get Azure Key Vault app setting reference

Exempelbegäran

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=2024-04-01

Java

/**
 * Samples for WebApps GetAppSettingKeyVaultReference.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-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/2024-04-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/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.Web/stable/2024-04-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");
require("dotenv/config");

/**
 * 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/2024-04-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

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-04-01/examples/GetKeyVaultReferencesForAppSetting.json
// this example is just showing the usage of "WebApps_GetAppSettingKeyVaultReference" 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 SiteConfigAppsettingResource created on azure
// for more information of creating SiteConfigAppsettingResource, please refer to the document of SiteConfigAppsettingResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "testc6282";
string appSettingKey = "setting";
ResourceIdentifier siteConfigAppsettingResourceId = SiteConfigAppsettingResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name, appSettingKey);
SiteConfigAppsettingResource siteConfigAppsetting = client.GetSiteConfigAppsettingResource(siteConfigAppsettingResourceId);

// invoke the operation
SiteConfigAppsettingResource result = await siteConfigAppsetting.GetAsync();

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
ApiKVReference	Beskrivning av referenser till platsnyckelvalv.
ConfigReferenceSource
DefaultErrorResponse	App Service-felsvar.
Details
Error	Felmodell.
ManagedServiceIdentity	Hanterad tjänstidentitet.
ManagedServiceIdentityType	Typ av hanterad tjänstidentitet.
ResolveStatus
userAssignedIdentity	Användartilldelad identitet.

ApiKVReference

Objekt

Beskrivning av referenser till platsnyckelvalv.

Name	Typ	Description
id	string	Resurs-ID.
kind	string	Typ av resurs.
name	string	Resursnamn.
properties.activeVersion	string
properties.details	string
properties.identityType	ManagedServiceIdentity	Hanterad tjänstidentitet.
properties.reference	string
properties.secretName	string
properties.secretVersion	string
properties.source	ConfigReferenceSource
properties.status	ResolveStatus
properties.vaultName	string
type	string	Resurstyp.

ConfigReferenceSource

Uppräkning

Värde	Description
KeyVault

DefaultErrorResponse

Objekt

App Service-felsvar.

Name	Typ	Description
error	Error	Felmodell.

Details

Objekt

Name	Typ	Description
code	string	Standardiserad sträng för att programmatiskt identifiera felet.
message	string	Detaljerad felbeskrivning och felsökningsinformation.
target	string	Detaljerad felbeskrivning och felsökningsinformation.

Error

Objekt

Felmodell.

Name	Typ	Description
code	string	Standardiserad sträng för att programmatiskt identifiera felet.
details	Details[]	Detaljerade fel.
innererror	string	Mer information om felsökningsfel.
message	string	Detaljerad felbeskrivning och felsökningsinformation.
target	string	Detaljerad felbeskrivning och felsökningsinformation.

ManagedServiceIdentity

Objekt

Hanterad tjänstidentitet.

Name	Typ	Description
principalId	string	Huvud-ID för hanterad tjänstidentitet.
tenantId	string	Klientorganisation för hanterad tjänstidentitet.
type	ManagedServiceIdentityType	Typ av hanterad tjänstidentitet.
userAssignedIdentities	<string,  userAssignedIdentity>	Listan över användartilldelade identiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Uppräkning

Typ av hanterad tjänstidentitet.

Värde	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

ResolveStatus

Uppräkning

Värde	Description
AccessToKeyVaultDenied
FetchTimedOut
Initialized
InvalidSyntax
MSINotEnabled
OtherReasons
Resolved
SecretNotFound
SecretVersionNotFound
UnauthorizedClient
VaultNotFound

userAssignedIdentity

Objekt

Användartilldelad identitet.

Name	Typ	Description
clientId	string	Klient-ID för användartilldelad identitet
principalId	string	Huvud-ID för användartilldelad identitet