Share via

Microsoft.Web sites/sitecontainers 2023-12-01

Bicep resource definition

The sites/sitecontainers resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Web/sites/sitecontainers resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Web/sites/sitecontainers@2023-12-01' = {
  parent: resourceSymbolicName
  kind: 'string'
  name: 'string'
  properties: {
    authType: 'string'
    environmentVariables: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    image: 'string'
    isMain: bool
    passwordSecret: 'string'
    startUpCommand: 'string'
    targetPort: 'string'
    userManagedIdentityClientId: 'string'
    userName: 'string'
    volumeMounts: [
      {
        containerMountPath: 'string'
        data: 'string'
        readOnly: bool
        volumeSubPath: 'string'
      }
    ]
  }
}

Property Values

Microsoft.Web/sites/sitecontainers

Name Description Value
kind Kind of resource. string
name The resource name string

Constraints:
Pattern = (^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$) (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: sites
properties SiteContainer resource specific properties SiteContainerProperties

EnvironmentVariable

Name Description Value
name Environment variable name string (required)
value Environment variable value string (required)

SiteContainerProperties

Name Description Value
authType Auth Type 'Anonymous'
'SystemIdentity'
'UserAssigned'
'UserCredentials'
environmentVariables List of environment variables EnvironmentVariable[]
image Image Name string (required)
isMain <code>true</code> if the container is the main site container; <code>false</code> otherwise. bool (required)
passwordSecret Password Secret string

Constraints:
Sensitive value. Pass in as a secure parameter.
startUpCommand StartUp Command string
targetPort Target Port string
userManagedIdentityClientId UserManagedIdentity ClientId string
userName User Name string
volumeMounts List of volume mounts VolumeMount[]

VolumeMount

Name Description Value
containerMountPath Target path on the container where volume is mounted on string (required)
data Config Data to be mounted on the volume string
readOnly Boolean to specify if the mount is read only on the container bool
volumeSubPath Sub path in the volume where volume is mounted from. string (required)

ARM template resource definition

The sites/sitecontainers resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Web/sites/sitecontainers resource, add the following JSON to your template.

{
  "type": "Microsoft.Web/sites/sitecontainers",
  "apiVersion": "2023-12-01",
  "name": "string",
  "kind": "string",
  "properties": {
    "authType": "string",
    "environmentVariables": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "image": "string",
    "isMain": "bool",
    "passwordSecret": "string",
    "startUpCommand": "string",
    "targetPort": "string",
    "userManagedIdentityClientId": "string",
    "userName": "string",
    "volumeMounts": [
      {
        "containerMountPath": "string",
        "data": "string",
        "readOnly": "bool",
        "volumeSubPath": "string"
      }
    ]
  }
}

Property Values

Microsoft.Web/sites/sitecontainers

Name Description Value
apiVersion The api version '2023-12-01'
kind Kind of resource. string
name The resource name string

Constraints:
Pattern = (^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$) (required)
properties SiteContainer resource specific properties SiteContainerProperties
type The resource type 'Microsoft.Web/sites/sitecontainers'

EnvironmentVariable

Name Description Value
name Environment variable name string (required)
value Environment variable value string (required)

SiteContainerProperties

Name Description Value
authType Auth Type 'Anonymous'
'SystemIdentity'
'UserAssigned'
'UserCredentials'
environmentVariables List of environment variables EnvironmentVariable[]
image Image Name string (required)
isMain <code>true</code> if the container is the main site container; <code>false</code> otherwise. bool (required)
passwordSecret Password Secret string

Constraints:
Sensitive value. Pass in as a secure parameter.
startUpCommand StartUp Command string
targetPort Target Port string
userManagedIdentityClientId UserManagedIdentity ClientId string
userName User Name string
volumeMounts List of volume mounts VolumeMount[]

VolumeMount

Name Description Value
containerMountPath Target path on the container where volume is mounted on string (required)
data Config Data to be mounted on the volume string
readOnly Boolean to specify if the mount is read only on the container bool
volumeSubPath Sub path in the volume where volume is mounted from. string (required)

Usage Examples

Terraform (AzAPI provider) resource definition

The sites/sitecontainers resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Web/sites/sitecontainers resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/sitecontainers@2023-12-01"
  name = "string"
  parent_id = "string"
  body = {
    kind = "string"
    properties = {
      authType = "string"
      environmentVariables = [
        {
          name = "string"
          value = "string"
        }
      ]
      image = "string"
      isMain = bool
      passwordSecret = "string"
      startUpCommand = "string"
      targetPort = "string"
      userManagedIdentityClientId = "string"
      userName = "string"
      volumeMounts = [
        {
          containerMountPath = "string"
          data = "string"
          readOnly = bool
          volumeSubPath = "string"
        }
      ]
    }
  }
}

Property Values

Microsoft.Web/sites/sitecontainers

Name Description Value
kind Kind of resource. string
name The resource name string

Constraints:
Pattern = (^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$) (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sites
properties SiteContainer resource specific properties SiteContainerProperties
type The resource type "Microsoft.Web/sites/sitecontainers@2023-12-01"

EnvironmentVariable

Name Description Value
name Environment variable name string (required)
value Environment variable value string (required)

SiteContainerProperties

Name Description Value
authType Auth Type 'Anonymous'
'SystemIdentity'
'UserAssigned'
'UserCredentials'
environmentVariables List of environment variables EnvironmentVariable[]
image Image Name string (required)
isMain <code>true</code> if the container is the main site container; <code>false</code> otherwise. bool (required)
passwordSecret Password Secret string

Constraints:
Sensitive value. Pass in as a secure parameter.
startUpCommand StartUp Command string
targetPort Target Port string
userManagedIdentityClientId UserManagedIdentity ClientId string
userName User Name string
volumeMounts List of volume mounts VolumeMount[]

VolumeMount

Name Description Value
containerMountPath Target path on the container where volume is mounted on string (required)
data Config Data to be mounted on the volume string
readOnly Boolean to specify if the mount is read only on the container bool
volumeSubPath Sub path in the volume where volume is mounted from. string (required)