你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Web Apps - Get Site Connection String Key Vault Reference

Service:

App Service

API Version:

2023-12-01

获取应用的配置引用和状态的说明

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

URI 参数

名称	在	必需	类型	说明
connectionStringKey	path	True	string
name	path	True	string	应用的名称。
resourceGroupName	path	True	string	资源所属的资源组的名称。 Regex pattern: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	Azure 订阅 ID。 这是 GUID 格式的字符串 (例如 00000000-0000-0000-0000-0000-0000000000000) 。
api-version	query	True	string	API 版本

响应

名称	类型	说明
200 OK	ApiKVReference	确定
Other Status Codes	DefaultErrorResponse	App 服务错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

定义

名称	说明
ApiKVReference	站点密钥保管库引用的说明。
ConfigReferenceSource
DefaultErrorResponse	App 服务错误响应。
Details
Error	错误模型。
ManagedServiceIdentity	托管服务标识。
ManagedServiceIdentityType	托管服务标识的类型。
ResolveStatus
userAssignedIdentity	用户分配的标识。

ApiKVReference

站点密钥保管库引用的说明。

名称	类型	说明
id	string	资源 ID。
kind	string	资源类型。
name	string	资源名称。
properties.activeVersion	string
properties.details	string
properties.identityType	ManagedServiceIdentity	托管服务标识。
properties.reference	string
properties.secretName	string
properties.secretVersion	string
properties.source	ConfigReferenceSource
properties.status	ResolveStatus
properties.vaultName	string
type	string	资源类型。

ConfigReferenceSource

名称	类型	说明
KeyVault	string

DefaultErrorResponse

App 服务错误响应。

名称	类型	说明
error	Error	错误模型。

Details

名称	类型	说明
code	string	用于以编程方式识别错误的标准化字符串。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

Error

错误模型。

名称	类型	说明
code	string	用于以编程方式识别错误的标准化字符串。
details	Details[]	详细错误。
innererror	string	调试错误的详细信息。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

ManagedServiceIdentity

托管服务标识。

名称	类型	说明
principalId	string	托管服务标识的主体 ID。
tenantId	string	托管服务标识的租户。
type	ManagedServiceIdentityType	托管服务标识的类型。
userAssignedIdentities	<string,  userAssignedIdentity>	与资源关联的用户分配标识的列表。 用户标识字典密钥引用将是采用以下格式的 ARM 资源 ID：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

托管服务标识的类型。

名称	类型	说明
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ResolveStatus

名称	类型	说明
AccessToKeyVaultDenied	string
FetchTimedOut	string
Initialized	string
InvalidSyntax	string
MSINotEnabled	string
OtherReasons	string
Resolved	string
SecretNotFound	string
SecretVersionNotFound	string
UnauthorizedClient	string
VaultNotFound	string

userAssignedIdentity

用户分配的标识。

名称	类型	说明
clientId	string	用户分配标识的客户端 ID
principalId	string	用户分配标识的主体 ID