次の方法で共有

Web Apps - Get Site Connection String Key Vault Reference

  • Reference
Service:
App Service
API Version:
2024-04-01

Description for Gets the config reference and status of an app

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

URI Parameters

Name In Required Type Description
connectionStringKey
 path True

string

name
 path True

string

Name of the app.
resourceGroupName
 path True

string

Name of the resource group to which the resource belongs.

Regex pattern: ^[-\w\._\(\)]+[^\.]$
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

ApiKVReference

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

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.

ConfigReferenceSource

Name Type Description
KeyVault

string

DefaultErrorResponse

App Service error response.

Name Type Description
error

Error

Error model.

Details

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

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

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

Type of managed service identity.

Name Type Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

ResolveStatus

Name 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

User Assigned identity.

Name Type Description
clientId

string

Client Id of user assigned identity
principalId

string

Principal Id of user assigned identity