Web Apps - Get App Setting Key Vault Reference Slot

Referência

Service:: App Service

API Version:: 2023-12-01

Descrição de Obtém a referência de configuração e o estado de uma aplicação

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
appSettingKey	path	True	string	Nome da chave de Definição da Aplicação.
name	path	True	string	Nome da aplicação.
resourceGroupName	path	True	string	Nome do grupo de recursos ao qual o recurso pertence. Regex pattern: `^[-\w\._]+[^\.]$`
slot	path	True	string
subscriptionId	path	True	string	O seu ID de subscrição do Azure. Esta é uma cadeia formatada com GUID (por exemplo, 000000000-0000-0000-0000-000000000000).
api-version	query	True	string	Versão da API

Respostas

Name	Tipo	Description
200 OK	ApiKVReference	OK
Other Status Codes	DefaultErrorResponse	Serviço de Aplicações resposta de erro.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Get Azure Key Vault slot app setting reference

Sample Request

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=2023-12-01

Sample Response

Status code:: 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

Name	Description
ApiKVReference	Descrição das referências do cofre de chaves do site.
ConfigReferenceSource
DefaultErrorResponse	Serviço de Aplicações resposta de erro.
Details
Error	Modelo de erro.
ManagedServiceIdentity	Identidade de serviço gerida.
ManagedServiceIdentityType	Tipo de identidade de serviço gerida.
ResolveStatus
userAssignedIdentity	Identidade atribuída pelo utilizador.

ApiKVReference

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

Name	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 gerida.
properties.reference	string
properties.secretName	string
properties.secretVersion	string
properties.source	ConfigReferenceSource
properties.status	ResolveStatus
properties.vaultName	string
type	string	Tipo de recurso.

ConfigReferenceSource

Name	Tipo	Description
KeyVault	string

DefaultErrorResponse

Serviço de Aplicações resposta de erro.

Name	Tipo	Description
error	Error	Modelo de erro.

Details

Name	Tipo	Description
code	string	Cadeia padronizada para identificar programaticamente o erro.
message	string	Descrição detalhada do erro e informações de depuração.
target	string	Descrição detalhada do erro e informações de depuração.

Error

Modelo de erro.

Name	Tipo	Description
code	string	Cadeia padronizada para identificar programaticamente o erro.
details	Details[]	Erros detalhados.
innererror	string	Mais informações para depurar o erro.
message	string	Descrição detalhada do erro e informações de depuração.
target	string	Descrição detalhada do erro e informações de depuração.

ManagedServiceIdentity

Identidade de serviço gerida.

Name	Tipo	Description
principalId	string	ID principal da identidade de serviço gerida.
tenantId	string	Inquilino da identidade de serviço gerida.
type	ManagedServiceIdentityType	Tipo de identidade de serviço gerida.
userAssignedIdentities	<string, userAssignedIdentity>	A lista de identidades atribuídas pelo utilizador associadas ao recurso. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Tipo de identidade de serviço gerida.

Name	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ResolveStatus

Name	Tipo	Description
AccessToKeyVaultDenied	string
FetchTimedOut	string
Initialized	string
InvalidSyntax	string
MSINotEnabled	string
OtherReasons	string
Resolved	string
SecretNotFound	string
SecretVersionNotFound	string
UnauthorizedClient	string
VaultNotFound	string

userAssignedIdentity

Identidade atribuída pelo utilizador.

Name	Tipo	Description
clientId	string	ID de cliente da identidade atribuída pelo utilizador
principalId	string	ID principal da identidade atribuída pelo utilizador