Share via

Web Apps - List Site Containers

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

Lists all the site containers of a site, or a deployment slot.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sitecontainers?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

SiteContainerCollection

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
AuthType

Auth Type
DefaultErrorResponse

App Service error response.
Details
EnvironmentVariable
Error

Error model.
SiteContainer

Container of a site
SiteContainerCollection

Collection of site containers
VolumeMount

AuthType

Enumeration

Auth Type

Value Description
Anonymous
UserCredentials
SystemIdentity
UserAssigned

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.

EnvironmentVariable

Object
Name Type Description
name

string

Environment variable name
value

string

The value of this environment variable must be the name of an AppSetting. The actual value of the environment variable in container will be retrieved from the specified AppSetting at runtime. If the AppSetting is not found, the value will be set to an empty string in the container at runtime.

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.

SiteContainer

Object

Container of a site

Name Type Description
id

string

Resource Id.
kind

string

Kind of resource.
name

string

Resource Name.
properties.authType

AuthType

Auth Type
properties.createdTime

string (date-time)

Created Time
properties.environmentVariables

EnvironmentVariable[]

List of environment variables
properties.image

string

Image Name
properties.inheritAppSettingsAndConnectionStrings

boolean

true if all AppSettings and ConnectionStrings have to be passed to the container as environment variables; false otherwise.
properties.isMain

boolean

true if the container is the main site container; false otherwise.
properties.lastModifiedTime

string (date-time)

Last Modified Time
properties.passwordSecret

string

Password Secret
properties.startUpCommand

string

StartUp Command
properties.targetPort

string

Target Port
properties.userManagedIdentityClientId

string

UserManagedIdentity ClientId
properties.userName

string

User Name
properties.volumeMounts

VolumeMount[]

List of volume mounts
type

string

Resource type.

SiteContainerCollection

Object

Collection of site containers

Name Type Description
nextLink

string

Link to next page of resources.
value

SiteContainer[]

Collection of resources.

VolumeMount

Object
Name Type Description
containerMountPath

string

Target path on the container where volume is mounted on
data

string

Config Data to be mounted on the volume
readOnly

boolean

Boolean to specify if the mount is read only on the container
volumeSubPath

string

Sub path in the volume where volume is mounted from.