Web Apps - Get Site Connection String Key Vault Reference

Dienst:

App Service

API-Version:

2024-11-01

Beschreibung für Abrufen der Konfigurationsreferenz und des Status einer App

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
connectionStringKey	path	True	string
name	path	True	string	Name der App.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Name der Ressourcengruppe, zu der die Ressource gehört.
subscriptionId	path	True	string	die Azure-Abonnement-ID Dies ist eine GUID-formatierte Zeichenfolge (z. B. 0000000-0000-0000-0000-000000000000).
api-version	query	True	string	API-Version

Antworten

Name	Typ	Beschreibung
200 OK	ApiKVReference	OKAY
Other Status Codes	DefaultErrorResponse	Fehlerantwort des App-Diensts.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Definitionen

Name	Beschreibung
ApiKVReference	Beschreibung der Websiteschlüsseltresorverweise.
ConfigReferenceSource
DefaultErrorResponse	Fehlerantwort des App-Diensts.
Details
Error	Fehlermodell.
ManagedServiceIdentity	Verwaltete Dienstidentität.
ManagedServiceIdentityType	Typ der verwalteten Dienstidentität.
ResolveStatus
userAssignedIdentity	Vom Benutzer zugewiesene Identität.

ApiKVReference

Objekt

Beschreibung der Websiteschlüsseltresorverweise.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
kind	string	Art der Ressource.
name	string	Ressourcenname.
properties.activeVersion	string
properties.details	string
properties.identityType	ManagedServiceIdentity	Verwaltete Dienstidentität.
properties.reference	string
properties.secretName	string
properties.secretVersion	string
properties.source	ConfigReferenceSource
properties.status	ResolveStatus
properties.vaultName	string
type	string	Ressourcentyp.

ConfigReferenceSource

Enumeration

Wert	Beschreibung
KeyVault

DefaultErrorResponse

Objekt

Fehlerantwort des App-Diensts.

Name	Typ	Beschreibung
error	Error	Fehlermodell.

Details

Objekt

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

Error

Objekt

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
details	Details[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen von Fehlern.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

ManagedServiceIdentity

Objekt

Verwaltete Dienstidentität.

Name	Typ	Beschreibung
principalId	string	Prinzipal-ID der verwalteten Dienstidentität.
tenantId	string	Mandant der verwalteten Dienstidentität.
type	ManagedServiceIdentityType	Typ der verwalteten Dienstidentität.
userAssignedIdentities	<string,  userAssignedIdentity>	Die Liste der benutzer zugewiesenen Identitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Enumeration

Typ der verwalteten Dienstidentität.

Wert	Beschreibung
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

ResolveStatus

Enumeration

Wert	Beschreibung
AccessToKeyVaultDenied
FetchTimedOut
Initialized
InvalidSyntax
MSINotEnabled
OtherReasons
Resolved
SecretNotFound
SecretVersionNotFound
UnauthorizedClient
VaultNotFound

userAssignedIdentity

Objekt

Vom Benutzer zugewiesene Identität.

Name	Typ	Beschreibung
clientId	string	Client-ID der vom Benutzer zugewiesenen Identität
principalId	string	Prinzipal-ID der vom Benutzer zugewiesenen Identität