Web Apps - Get Site Connection String Key Vault Reference

Servicio:

App Service

Versión de la API:

2024-11-01

Descripción de Obtiene la referencia de configuración y el estado de una aplicación

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
connectionStringKey	path	True	string
name	path	True	string	Nombre de la aplicación.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nombre del grupo de recursos al que pertenece el recurso.
subscriptionId	path	True	string	Su identificador de suscripción de Azure. Se trata de una cadena con formato GUID (por ejemplo, 000000000-00000-0000-0000-00000000000000).
api-version	query	True	string	Versión de la API

Respuestas

Nombre	Tipo	Description
200 OK	ApiKVReference	De acuerdo
Other Status Codes	DefaultErrorResponse	Respuesta de error de App Service.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Definiciones

Nombre	Description
ApiKVReference	Descripción de las referencias del almacén de claves de sitio.
ConfigReferenceSource
DefaultErrorResponse	Respuesta de error de App Service.
Details
Error	Modelo de error.
ManagedServiceIdentity	Identidad de servicio administrada.
ManagedServiceIdentityType	Tipo de identidad de servicio administrada.
ResolveStatus
userAssignedIdentity	Identidad asignada por el usuario.

ApiKVReference

Object

Descripción de las referencias del almacén de claves de sitio.

Nombre	Tipo	Description
id	string	Identificador de recurso.
kind	string	Tipo de recurso.
name	string	Nombre del recurso.
properties.activeVersion	string
properties.details	string
properties.identityType	ManagedServiceIdentity	Identidad de servicio administrada.
properties.reference	string
properties.secretName	string
properties.secretVersion	string
properties.source	ConfigReferenceSource
properties.status	ResolveStatus
properties.vaultName	string
type	string	Tipo de recurso.

ConfigReferenceSource

Enumeración

Valor	Description
KeyVault

DefaultErrorResponse

Object

Respuesta de error de App Service.

Nombre	Tipo	Description
error	Error	Modelo de error.

Details

Object

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar mediante programación el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

Error

Object

Modelo de error.

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar mediante programación el error.
details	Details[]	Errores detallados.
innererror	string	Más información para depurar el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

ManagedServiceIdentity

Object

Identidad de servicio administrada.

Nombre	Tipo	Description
principalId	string	Identificador de entidad de seguridad de la identidad de servicio administrada.
tenantId	string	Inquilino de la identidad de servicio administrada.
type	ManagedServiceIdentityType	Tipo de identidad de servicio administrada.
userAssignedIdentities	<string,  userAssignedIdentity>	Lista de identidades asignadas por el usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recurso de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Enumeración

Tipo de identidad de servicio administrada.

Valor	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

ResolveStatus

Enumeración

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

userAssignedIdentity

Object

Identidad asignada por el usuario.

Nombre	Tipo	Description
clientId	string	Identificador de cliente de la identidad asignada por el usuario
principalId	string	Identificador de entidad de seguridad de la identidad asignada por el usuario