Web Apps - Get App Settings Key Vault References Slot

Referenz

Service:: App Service

API Version:: 2023-12-01

Beschreibung für Ruft die Konfigurationsverweis-App-Einstellungen und status einer App ab.

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

URI-Parameter

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

Antworten

Name	Typ	Beschreibung
200 OK	ApiKVReferenceCollection	OK
Other Status Codes	DefaultErrorResponse	App Service Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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"
      }
    }
  ]
}

Definitionen

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

ApiKVReference

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	Der Ressourcentyp.

ApiKVReferenceCollection

Name	Typ	Beschreibung
nextLink	string	Link zur nächsten Seite der Ressourcen.
value	ApiKVReference[]	Sammlung von Ressourcen.

ConfigReferenceSource

Name	Typ	Beschreibung
KeyVault	string

DefaultErrorResponse

App Service Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Fehlermodell.

Details

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge zum programmgesteuerten Identifizieren des Fehlers.
message	string	Ausführliche Fehlerbeschreibung und Debuginformationen.
target	string	Ausführliche Fehlerbeschreibung und Debuginformationen.

Error

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge zum programmgesteuerten Identifizieren des Fehlers.
details	Details[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen des Fehlers.
message	string	Ausführliche Fehlerbeschreibung und Debuginformationen.
target	string	Ausführliche Fehlerbeschreibung und Debuginformationen.

ManagedServiceIdentity

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 benutzerseitig zugewiesenen Identitäten, die der Ressource zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Typ der verwalteten Dienstidentität.

Name	Typ	Beschreibung
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ResolveStatus

Name	Typ	Beschreibung
AccessToKeyVaultDenied	string
FetchTimedOut	string
Initialized	string
InvalidSyntax	string
MSINotEnabled	string
OtherReasons	string
Resolved	string
SecretNotFound	string
SecretVersionNotFound	string
UnauthorizedClient	string
VaultNotFound	string

userAssignedIdentity

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

Share via