Web Apps - Get App Settings Key Vault References

Başvuru

Service:: App Service

API Version:: 2023-12-01

Yapılandırma başvurusu uygulama ayarlarını ve bir uygulamanın durumunu alır açıklaması

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
name	path	True	string	Uygulamanın adı.
resourceGroupName	path	True	string	Kaynağın ait olduğu kaynak grubunun adı. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Azure abonelik kimliğiniz. Bu GUID biçimli bir dizedir (örneğin, 000000000-0000-0000-0000-00000000000000).
api-version	query	True	string	API Sürümü

Yanıtlar

Name	Tür	Description
200 OK	ApiKVReferenceCollection	Tamam
Other Status Codes	DefaultErrorResponse	hata yanıtı App Service.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Get Azure Key Vault references for app settings

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testc6282/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/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/config/configreferences/appsettings/secretName2",
      "properties": {
        "vaultName": "keyVaultName",
        "secretName": "secretName2",
        "secretVersion": "secretVersion2"
      }
    }
  ]
}

Tanımlar

Name	Description
ApiKVReference	Site anahtarı kasası başvurularının açıklaması.
ApiKVReferenceCollection
ConfigReferenceSource
DefaultErrorResponse	hata yanıtı App Service.
Details
Error	Hata modeli.
ManagedServiceIdentity	Yönetilen hizmet kimliği.
ManagedServiceIdentityType	Yönetilen hizmet kimliğinin türü.
ResolveStatus
userAssignedIdentity	Kullanıcı Tarafından Atanan kimlik.

ApiKVReference

Site anahtarı kasası başvurularının açıklaması.

Name	Tür	Description
id	string	Kaynak Kimliği.
kind	string	Bir tür kaynak.
name	string	Kaynak Adı.
properties.activeVersion	string
properties.details	string
properties.identityType	ManagedServiceIdentity	Yönetilen hizmet kimliği.
properties.reference	string
properties.secretName	string
properties.secretVersion	string
properties.source	ConfigReferenceSource
properties.status	ResolveStatus
properties.vaultName	string
type	string	Kaynak türü.

ApiKVReferenceCollection

Name	Tür	Description
nextLink	string	Sonraki kaynak sayfasına bağlantı.
value	ApiKVReference[]	Kaynak koleksiyonu.

ConfigReferenceSource

Name	Tür	Description
KeyVault	string

DefaultErrorResponse

hata yanıtı App Service.

Name	Tür	Description
error	Error	Hata modeli.

Details

Name	Tür	Description
code	string	Hatayı program aracılığıyla tanımlamak için standartlaştırılmış dize.
message	string	Ayrıntılı hata açıklaması ve hata ayıklama bilgileri.
target	string	Ayrıntılı hata açıklaması ve hata ayıklama bilgileri.

Error

Hata modeli.

Name	Tür	Description
code	string	Hatayı program aracılığıyla tanımlamak için standartlaştırılmış dize.
details	Details[]	Ayrıntılı hatalar.
innererror	string	Hata ayıklamak için daha fazla bilgi.
message	string	Ayrıntılı hata açıklaması ve hata ayıklama bilgileri.
target	string	Ayrıntılı hata açıklaması ve hata ayıklama bilgileri.

ManagedServiceIdentity

Yönetilen hizmet kimliği.

Name	Tür	Description
principalId	string	Yönetilen hizmet kimliğinin Asıl Kimliği.
tenantId	string	Yönetilen hizmet kimliğinin kiracısı.
type	ManagedServiceIdentityType	Yönetilen hizmet kimliğinin türü.
userAssignedIdentities	<string, userAssignedIdentity>	Kaynakla ilişkili kullanıcı tarafından atanan kimliklerin listesi. Kullanıcı kimliği sözlüğü anahtar başvuruları şu biçimde ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Yönetilen hizmet kimliğinin türü.

Name	Tür	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ResolveStatus

Name	Tür	Description
AccessToKeyVaultDenied	string
FetchTimedOut	string
Initialized	string
InvalidSyntax	string
MSINotEnabled	string
OtherReasons	string
Resolved	string
SecretNotFound	string
SecretVersionNotFound	string
UnauthorizedClient	string
VaultNotFound	string

userAssignedIdentity

Kullanıcı Tarafından Atanan kimlik.

Name	Tür	Description
clientId	string	Kullanıcı tarafından atanan kimliğin istemci kimliği
principalId	string	Kullanıcı tarafından atanan kimliğin Asıl Kimliği

Share via