Share via

Web Apps - Get Site Connection String Key Vault References

Service:
App Service
API Version:
2025-03-01

Description for Gets the config reference app settings and status of an app

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

URI Parameters

Name In Required Type Description
name
 path True

string

Name of the app.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+[^\.]$

Name of the resource group to which the resource belongs.
subscriptionId
 path True

string

Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version
 query True

string

API Version

Responses

Name Type Description
200 OK

ApiKVReferenceCollection

OK
Other Status Codes

DefaultErrorResponse

App Service error response.

Security

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 impersonate your user account

Definitions

Name Description
ApiKVReference

Description of site key vault references.
ApiKVReferenceCollection
ConfigReferenceSource
DefaultErrorResponse

App Service error response.
Details
Error

Error model.
ManagedServiceIdentity

Managed service identity.
ManagedServiceIdentityType

Type of managed service identity.
ResolveStatus
userAssignedIdentity

User Assigned identity.

ApiKVReference

Object

Description of site key vault references.

Name Type Description
id

string

Resource Id.
kind

string

Kind of resource.
name

string

Resource Name.
properties.activeVersion

string

properties.details

string

properties.identityType

ManagedServiceIdentity

Managed service identity.
properties.reference

string

properties.secretName

string

properties.secretVersion

string

properties.source

ConfigReferenceSource

properties.status

ResolveStatus

properties.vaultName

string

type

string

Resource type.

ApiKVReferenceCollection

Object
Name Type Description
nextLink

string

Link to next page of resources.
value

ApiKVReference[]

Collection of resources.

ConfigReferenceSource

Enumeration
Value Description
KeyVault

DefaultErrorResponse

Object

App Service error response.

Name Type Description
error

Error

Error model.

Details

Object
Name Type Description
code

string

Standardized string to programmatically identify the error.
message

string

Detailed error description and debugging information.
target

string

Detailed error description and debugging information.

Error

Object

Error model.

Name Type Description
code

string

Standardized string to programmatically identify the error.
details

Details[]

Detailed errors.
innererror

string

More information to debug error.
message

string

Detailed error description and debugging information.
target

string

Detailed error description and debugging information.

ManagedServiceIdentity

Object

Managed service identity.

Name Type Description
principalId

string

Principal Id of managed service identity.
tenantId

string

Tenant of managed service identity.
type

ManagedServiceIdentityType

Type of managed service identity.
userAssignedIdentities

<string,  userAssignedIdentity>

The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Enumeration

Type of managed service identity.

Value Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

ResolveStatus

Enumeration
Value Description
Initialized
Resolved
InvalidSyntax
MSINotEnabled
VaultNotFound
SecretNotFound
SecretVersionNotFound
AccessToKeyVaultDenied
OtherReasons
FetchTimedOut
UnauthorizedClient

userAssignedIdentity

Object

User Assigned identity.

Name Type Description
clientId

string

Client Id of user assigned identity
principalId

string

Principal Id of user assigned identity