Web Apps - Get App Setting Key Vault Reference
Description pour Obtient la référence et la status de configuration d’une application
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/appsettings/{appSettingKey}?api-version=2023-12-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
app
|
path | True |
string |
Nom de la clé du paramètre d’application. |
name
|
path | True |
string |
Nom de l’application. |
resource
|
path | True |
string |
Nom du groupe de ressources auquel appartient la ressource. Regex pattern: |
subscription
|
path | True |
string |
Votre ID d’abonnement Azure. Il s’agit d’une chaîne au format GUID (par exemple, 000000-0000-0000-0000-000000000000000). |
api-version
|
query | True |
string |
Version d'API |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Ok |
|
Other Status Codes |
App Service réponse d’erreur. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Exemples
Get Azure Key Vault app setting reference
Sample Request
GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testc6282/config/configreferences/appsettings/setting?api-version=2023-12-01
Sample Response
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testc6282/config/configreferences/appsettings/setting",
"properties": {
"vaultName": "keyVaultName",
"secretName": "secretName",
"secretVersion": "secretVersion"
}
}
Définitions
Nom | Description |
---|---|
Api |
Description des références de coffre de clés de site. |
Config |
|
Default |
App Service réponse d’erreur. |
Details | |
Error |
Modèle d’erreur. |
Managed |
Identité de service managée. |
Managed |
Type d’identité de service managé. |
Resolve |
|
user |
Identité affectée par l’utilisateur. |
ApiKVReference
Description des références de coffre de clés de site.
Nom | Type | Description |
---|---|---|
id |
string |
ID de ressource. |
kind |
string |
Type de ressource. |
name |
string |
Nom de la ressource. |
properties.activeVersion |
string |
|
properties.details |
string |
|
properties.identityType |
Identité de service managée. |
|
properties.reference |
string |
|
properties.secretName |
string |
|
properties.secretVersion |
string |
|
properties.source | ||
properties.status | ||
properties.vaultName |
string |
|
type |
string |
Type de ressource. |
ConfigReferenceSource
Nom | Type | Description |
---|---|---|
KeyVault |
string |
DefaultErrorResponse
App Service réponse d’erreur.
Nom | Type | Description |
---|---|---|
error |
Modèle d’erreur. |
Details
Nom | Type | Description |
---|---|---|
code |
string |
Chaîne standardisée pour identifier l’erreur par programmation. |
message |
string |
Description détaillée de l’erreur et informations de débogage. |
target |
string |
Description détaillée de l’erreur et informations de débogage. |
Error
Modèle d’erreur.
Nom | Type | Description |
---|---|---|
code |
string |
Chaîne standardisée pour identifier l’erreur par programmation. |
details |
Details[] |
Erreurs détaillées. |
innererror |
string |
Plus d’informations sur l’erreur de débogage. |
message |
string |
Description détaillée de l’erreur et informations de débogage. |
target |
string |
Description détaillée de l’erreur et informations de débogage. |
ManagedServiceIdentity
Identité de service managée.
Nom | Type | Description |
---|---|---|
principalId |
string |
ID principal de l’identité de service managé. |
tenantId |
string |
Locataire de l’identité de service managé. |
type |
Type d’identité de service managé. |
|
userAssignedIdentities |
<string,
user |
Liste des identités affectées par l’utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM au format « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} |
ManagedServiceIdentityType
Type d’identité de service managé.
Nom | Type | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
ResolveStatus
Nom | Type | Description |
---|---|---|
AccessToKeyVaultDenied |
string |
|
FetchTimedOut |
string |
|
Initialized |
string |
|
InvalidSyntax |
string |
|
MSINotEnabled |
string |
|
OtherReasons |
string |
|
Resolved |
string |
|
SecretNotFound |
string |
|
SecretVersionNotFound |
string |
|
UnauthorizedClient |
string |
|
VaultNotFound |
string |
userAssignedIdentity
Identité affectée par l’utilisateur.
Nom | Type | Description |
---|---|---|
clientId |
string |
ID client de l’identité affectée par l’utilisateur |
principalId |
string |
ID principal de l’identité affectée par l’utilisateur |