Container Apps - List Secrets

Service:

Azure Container Apps

API Version:

2023-08-01-preview

List secrets for a container app

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/listSecrets?api-version=2023-08-01-preview

URI Parameters

Name	In	Required	Type	Description
containerAppName	path	True	string	Name of the Container App.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	SecretsCollection	OK
Other Status Codes	DefaultErrorResponse	Common 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

Examples

List Container Apps Secrets

Sample request

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0/listSecrets?api-version=2023-08-01-preview

Sample response

Status code:

200

{
  "value": [
    {
      "name": "secret1"
    },
    {
      "name": "secret2"
    }
  ]
}

Definitions

Name	Description
ContainerAppSecret	Container App Secret.
DefaultErrorResponse	App Service error response.
Details	Details or the error
Error	Error model.
SecretsCollection	Container App Secrets Collection ARM resource.

ContainerAppSecret

Container App Secret.

Name	Type	Description
identity	string	Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.
keyVaultUrl	string	Azure Key Vault URL pointing to the secret referenced by the container app.
name	string	Secret Name.
value	string	Secret Value.

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Details or the error

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[]	Details or the error
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

SecretsCollection

Container App Secrets Collection ARM resource.

Name	Type	Description
value	ContainerAppSecret[]	Collection of resources.