Microsoft.Web sites/deployments 2020-10-01

Bicep resource definition

The sites/deployments resource type can be deployed to:

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

Resource format

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

resource symbolicname 'Microsoft.Web/sites/deployments@2020-10-01' = {
  name: 'string'
  kind: 'string'
  parent: resourceSymbolicName
  properties: {
    active: bool
    author: 'string'
    author_email: 'string'
    deployer: 'string'
    details: 'string'
    end_time: 'string'
    message: 'string'
    start_time: 'string'
    status: int
  }
}

Property values

sites/deployments

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.
string (required)
kind Kind of resource. string
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 Deployment resource specific properties DeploymentProperties

DeploymentProperties

Name Description Value
active True if deployment is currently active, false if completed and null if not started. bool
author Who authored the deployment. string
author_email Author email. string
deployer Who performed the deployment. string
details Details on deployment. string
end_time End time. string
message Details about deployment status. string
start_time Start time. string
status Deployment status. int

ARM template resource definition

The sites/deployments resource type can be deployed to:

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

Resource format

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

{
  "type": "Microsoft.Web/sites/deployments",
  "apiVersion": "2020-10-01",
  "name": "string",
  "kind": "string",
  "properties": {
    "active": "bool",
    "author": "string",
    "author_email": "string",
    "deployer": "string",
    "details": "string",
    "end_time": "string",
    "message": "string",
    "start_time": "string",
    "status": "int"
  }
}

Property values

sites/deployments

Name Description Value
type The resource type 'Microsoft.Web/sites/deployments'
apiVersion The resource api version '2020-10-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
kind Kind of resource. string
properties Deployment resource specific properties DeploymentProperties

DeploymentProperties

Name Description Value
active True if deployment is currently active, false if completed and null if not started. bool
author Who authored the deployment. string
author_email Author email. string
deployer Who performed the deployment. string
details Details on deployment. string
end_time End time. string
message Details about deployment status. string
start_time Start time. string
status Deployment status. int

Terraform (AzAPI provider) resource definition

The sites/deployments resource type can be deployed to:

  • Resource groups

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

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/deployments@2020-10-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      active = bool
      author = "string"
      author_email = "string"
      deployer = "string"
      details = "string"
      end_time = "string"
      message = "string"
      start_time = "string"
      status = int
    }
    kind = "string"
  })
}

Property values

sites/deployments

Name Description Value
type The resource type "Microsoft.Web/sites/deployments@2020-10-01"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sites
kind Kind of resource. string
properties Deployment resource specific properties DeploymentProperties

DeploymentProperties

Name Description Value
active True if deployment is currently active, false if completed and null if not started. bool
author Who authored the deployment. string
author_email Author email. string
deployer Who performed the deployment. string
details Details on deployment. string
end_time End time. string
message Details about deployment status. string
start_time Start time. string
status Deployment status. int