Web Apps - Get App Settings Key Vault References Slot

Referencia

Service:: App Service

API Version:: 2023-12-01

Descripción de Obtiene la configuración de la aplicación de 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}/slots/{slot}/config/configreferences/appsettings?api-version=2023-12-01

Parámetros de identificador URI

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

Respuestas

Nombre	Tipo	Description
200 OK	ApiKVReferenceCollection	Aceptar
Other Status Codes	DefaultErrorResponse	App Service respuesta de error.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Get Azure Key Vault references for app settings for slot

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

Sample Response

Status code:: 200

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

Definiciones

Nombre	Description
ApiKVReference	Descripción de las referencias del almacén de claves de sitio.
ApiKVReferenceCollection
ConfigReferenceSource
DefaultErrorResponse	App Service respuesta de error.
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

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

Nombre	Tipo	Description
id	string	Id. 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.

ApiKVReferenceCollection

Nombre	Tipo	Description
nextLink	string	Vínculo a la página siguiente de recursos.
value	ApiKVReference[]	Colección de recursos.

ConfigReferenceSource

Nombre	Tipo	Description
KeyVault	string

DefaultErrorResponse

App Service respuesta de error.

Nombre	Tipo	Description
error	Error	Modelo de error.

Details

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

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

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 recursos de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Tipo de identidad de servicio administrada.

Nombre	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ResolveStatus

Nombre	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

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

Share via