Microsoft.Web sites/deployments 2023-01-01
Bicep resource definition
The sites/deployments resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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@2023-01-01' = {
kind: 'string'
name: '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
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 |
Microsoft.Web/sites/deployments
| Name | Description | Value |
|---|---|---|
| kind | Kind of resource. | string |
| name | The resource name | string (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 | Deployment resource specific properties | DeploymentProperties |
ARM template resource definition
The sites/deployments resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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": "2023-01-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
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 |
Microsoft.Web/sites/deployments
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-01-01' |
| kind | Kind of resource. | string |
| name | The resource name | string (required) |
| properties | Deployment resource specific properties | DeploymentProperties |
| type | The resource type | 'Microsoft.Web/sites/deployments' |
Terraform (AzAPI provider) resource definition
The sites/deployments 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/deployments resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Web/sites/deployments@2023-01-01"
name = "string"
kind = "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
}
})
}
Property values
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 |
Microsoft.Web/sites/deployments
| Name | Description | Value |
|---|---|---|
| kind | Kind of resource. | string |
| 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 |
| properties | Deployment resource specific properties | DeploymentProperties |
| type | The resource type | "Microsoft.Web/sites/deployments@2023-01-01" |