Web Apps - List Connection Strings

Service:

App Service

API Version:

2024-04-01

Description for Gets the connection strings of an app.

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

URI Parameters

Name	In	Required	Type	Description
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	ConnectionStringDictionary	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
ConnectionStringDictionary	String dictionary resource.
ConnectionStringType	Type of database.
ConnStringValueTypePair	Database connection string value to type pair.
DefaultErrorResponse	App Service error response.
Details
Error	Error model.

ConnectionStringDictionary

String dictionary resource.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.	ConnStringValueTypePair	Database connection string value to type pair.
type	string	Resource type.

ConnectionStringType

Type of database.

Name	Type	Description
ApiHub	string
Custom	string
DocDb	string
EventHub	string
MySql	string
NotificationHub	string
PostgreSQL	string
RedisCache	string
SQLAzure	string
SQLServer	string
ServiceBus	string

ConnStringValueTypePair

Database connection string value to type pair.

Name	Type	Description
type	ConnectionStringType	Type of database.
value	string	Value of pair.

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.