Web Apps - Get App Setting Key Vault Reference Slot

Serviço:

App Service

Versão da API:

2024-04-01

Descrição para Obter a referência de configuração e o status de um aplicativo

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
appSettingKey	path	True	string	Nome da chave de Configuração do Aplicativo.
name	path	True	string	Nome do aplicativo.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nome do grupo de recursos ao qual o recurso pertence.
slot	path	True	string
subscriptionId	path	True	string	Sua ID de assinatura do Azure. Esta é uma cadeia de caracteres formatada por GUID (por exemplo, 000000000-0000-0000-0000-000000000000000).
api-version	query	True	string	Versão da API

Respostas

Nome	Tipo	Description
200 OK	ApiKVReference	OKEY
Other Status Codes	DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get Azure Key Vault slot app setting reference

Solicitação de exemplo

HTTP

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

Java

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


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetKeyVaultReferencesForAppSettingSlot.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/GetKeyVaultReferencesForAppSettingSlot.json
func ExampleWebAppsClient_GetAppSettingKeyVaultReferenceSlot() {
	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().GetAppSettingKeyVaultReferenceSlot(ctx, "testrg123", "testc6282", "setting", "stage", 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/slots/stage/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/GetKeyVaultReferencesForAppSettingSlot.json
 */
async function getAzureKeyVaultSlotAppSettingReference() {
  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 slot = "stage";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.getAppSettingKeyVaultReferenceSlot(
    resourceGroupName,
    name,
    appSettingKey,
    slot,
  );
  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/GetKeyVaultReferencesForAppSettingSlot.json
// this example is just showing the usage of "WebApps_GetAppSettingKeyVaultReferenceSlot" 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 WebSiteSlotConfigAppSettingResource created on azure
// for more information of creating WebSiteSlotConfigAppSettingResource, please refer to the document of WebSiteSlotConfigAppSettingResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "testc6282";
string slot = "stage";
string appSettingKey = "setting";
ResourceIdentifier webSiteSlotConfigAppSettingResourceId = WebSiteSlotConfigAppSettingResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name, slot, appSettingKey);
WebSiteSlotConfigAppSettingResource webSiteSlotConfigAppSetting = client.GetWebSiteSlotConfigAppSettingResource(webSiteSlotConfigAppSettingResourceId);

// invoke the operation
WebSiteSlotConfigAppSettingResource result = await webSiteSlotConfigAppSetting.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

Resposta de exemplo

Código de status:

200

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

Definições

Nome	Description
ApiKVReference	Descrição das referências do cofre de chaves do site.
ConfigReferenceSource
DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.
Details
Error	Modelo de erro.
ManagedServiceIdentity	Identidade de serviço gerenciada.
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado.
ResolveStatus
userAssignedIdentity	Identidade atribuída pelo usuário.

ApiKVReference

Objeto

Descrição das referências do cofre de chaves do site.

Nome	Tipo	Description
id	string	ID do recurso.
kind	string	Tipo de recurso.
name	string	Nome do recurso.
properties.activeVersion	string
properties.details	string
properties.identityType	ManagedServiceIdentity	Identidade de serviço gerenciada.
properties.reference	string
properties.secretName	string
properties.secretVersion	string
properties.source	ConfigReferenceSource
properties.status	ResolveStatus
properties.vaultName	string
type	string	Tipo de recurso.

ConfigReferenceSource

Enumeração

Valor	Description
KeyVault

DefaultErrorResponse

Objeto

Resposta de erro do Serviço de Aplicativo.

Nome	Tipo	Description
error	Error	Modelo de erro.

Details

Objeto

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
message	string	Informações detalhadas de descrição e depuração de erros.
target	string	Informações detalhadas de descrição e depuração de erros.

Error

Objeto

Modelo de erro.

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
details	Details[]	Erros detalhados.
innererror	string	Mais informações para depurar o erro.
message	string	Informações detalhadas de descrição e depuração de erros.
target	string	Informações detalhadas de descrição e depuração de erros.

ManagedServiceIdentity

Objeto

Identidade de serviço gerenciada.

Nome	Tipo	Description
principalId	string	ID da entidade de segurança da identidade do serviço gerenciado.
tenantId	string	Locatário da identidade do serviço gerenciado.
type	ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado.
userAssignedIdentities	<string,  userAssignedIdentity>	A lista de identidades atribuídas pelo usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Enumeração

Tipo de identidade de serviço gerenciado.

Valor	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

ResolveStatus

Enumeração

Valor	Description
AccessToKeyVaultDenied
FetchTimedOut
Initialized
InvalidSyntax
MSINotEnabled
OtherReasons
Resolved
SecretNotFound
SecretVersionNotFound
UnauthorizedClient
VaultNotFound

userAssignedIdentity

Objeto

Identidade atribuída pelo usuário.

Nome	Tipo	Description
clientId	string	ID do cliente da identidade atribuída pelo usuário
principalId	string	ID da entidade de segurança da identidade atribuída pelo usuário