Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The phpWorkloads 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.Workloads/phpWorkloads resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Workloads/phpWorkloads@2021-12-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
kind: 'string'
location: 'string'
name: 'string'
properties: {
adminUserProfile: {
sshPublicKey: 'string'
userName: 'string'
}
appLocation: 'string'
backupProfile: {
backupEnabled: 'string'
}
cacheProfile: {
capacity: int
family: 'string'
name: 'string'
skuName: 'string'
}
controllerProfile: {
dataDisks: [
{
sizeInGB: int
storageType: 'string'
}
]
name: 'string'
nodeSku: 'string'
osDisk: {
sizeInGB: int
storageType: 'string'
}
osImage: {
offer: 'string'
publisher: 'string'
sku: 'string'
version: 'string'
}
}
databaseProfile: {
backupRetentionDays: int
haEnabled: 'string'
serverName: 'string'
sku: 'string'
sslEnforcementEnabled: 'string'
storageInGB: int
storageIops: int
storageSku: 'string'
tier: 'string'
type: 'string'
version: 'string'
}
fileshareProfile: {
shareSizeInGB: int
shareType: 'string'
storageType: 'string'
}
managedResourceGroupConfiguration: {
name: 'string'
}
networkProfile: {
azureFrontDoorEnabled: 'string'
capacity: int
loadBalancerSku: 'string'
loadBalancerTier: 'string'
loadBalancerType: 'string'
}
phpProfile: {
version: 'string'
}
searchProfile: {
dataDisks: [
{
sizeInGB: int
storageType: 'string'
}
]
name: 'string'
nodeSku: 'string'
osDisk: {
sizeInGB: int
storageType: 'string'
}
osImage: {
offer: 'string'
publisher: 'string'
sku: 'string'
version: 'string'
}
searchType: 'string'
}
siteProfile: {
domainName: 'string'
}
webNodesProfile: {
autoScaleMaxCount: int
autoScaleMinCount: int
dataDisks: [
{
sizeInGB: int
storageType: 'string'
}
]
name: 'string'
nodeSku: 'string'
osDisk: {
sizeInGB: int
storageType: 'string'
}
osImage: {
offer: 'string'
publisher: 'string'
sku: 'string'
version: 'string'
}
}
}
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Workloads/phpWorkloads
| Name | Description | Value |
|---|---|---|
| identity | Identity for the resource. Currently not supported | PhpWorkloadResourceIdentity |
| kind | Indicates which kind of php workload this resource represent e.g WordPress | 'WordPress' (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | Resource properties | PhpWorkloadResourceProperties |
| sku | Php workloads SKU | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
BackupProfile
| Name | Description | Value |
|---|---|---|
| backupEnabled | Whether to enable Azure backup for the workload | 'Disabled' 'Enabled' (required) |
CacheProfile
| Name | Description | Value |
|---|---|---|
| capacity | Cache capacity | int (required) |
| family | Cache family | 'C' 'P' (required) |
| name | Cache name | string |
| skuName | Cache SKU name | string (required) |
DatabaseProfile
| Name | Description | Value |
|---|---|---|
| backupRetentionDays | Backup retention days for the server | int |
| haEnabled | Whether to enable HA for the server | 'Disabled' 'Enabled' |
| serverName | Database server name | string |
| sku | The name of the server SKU, e.g. Standard_D32s_v4 | string (required) |
| sslEnforcementEnabled | Whether to enable SSL enforcement on the database | 'Disabled' 'Enabled' |
| storageInGB | Database storage size in GB | int Constraints: Min value = 1 |
| storageIops | Storage IOPS for the server | int |
| storageSku | SKU name for database storage | string |
| tier | Tier of the server SKU | 'Burstable' 'GeneralPurpose' 'MemoryOptimized' (required) |
| type | Database type | 'MySql' (required) |
| version | Database version | string |
DiskInfo
| Name | Description | Value |
|---|---|---|
| sizeInGB | Disk size in GB | int |
| storageType | Storage type | 'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' (required) |
FileshareProfile
| Name | Description | Value |
|---|---|---|
| shareSizeInGB | File share size in GB | int Constraints: Min value = 1 |
| shareType | Share type | 'AzureFiles' 'NfsOnController' (required) |
| storageType | File share backing storage type | 'Premium_LRS' 'Standard_GRS' 'Standard_LRS' 'Standard_ZRS' (required) |
ManagedRGConfiguration
| Name | Description | Value |
|---|---|---|
| name | Managed resource group name | string |
NetworkProfile
| Name | Description | Value |
|---|---|---|
| azureFrontDoorEnabled | Whether to enable Azure front door | 'Disabled' 'Enabled' |
| capacity | Capacity, applicable only for Application Gateway | int |
| loadBalancerSku | Load balancer SKU | string |
| loadBalancerTier | Load balancer tier | string |
| loadBalancerType | Load balancer type | 'ApplicationGateway' 'LoadBalancer' (required) |
NodeProfile
| Name | Description | Value |
|---|---|---|
| dataDisks | Data disks details. This property is not in use right now | DiskInfo[] |
| name | VM or VMSS name | string |
| nodeSku | VM SKU for node(s) | string (required) |
| osDisk | OS disk details | DiskInfo (required) |
| osImage | OS image used for creating the nodes | OsImageProfile (required) |
OsImageProfile
| Name | Description | Value |
|---|---|---|
| offer | OS image offer | 'UbuntuServer' |
| publisher | OS image publisher | 'Canonical' |
| sku | OS image sku | '16.04-LTS' '18.04-LTS' |
| version | OS image version | 'latest' |
PhpProfile
| Name | Description | Value |
|---|---|---|
| version | PHP version | '7.2' '7.3' '7.4' (required) |
PhpWorkloadResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of manage identity | 'None' 'UserAssigned' (required) |
| userAssignedIdentities | User assigned identities dictionary | UserAssignedIdentities |
PhpWorkloadResourceProperties
| Name | Description | Value |
|---|---|---|
| adminUserProfile | Admin user profile used for VM and VMSS | UserProfile (required) |
| appLocation | The infra resources for PHP workload will be created in this location | string (required) |
| backupProfile | Backup profile | BackupProfile |
| cacheProfile | Cache profile | CacheProfile |
| controllerProfile | Controller VM profile | NodeProfile (required) |
| databaseProfile | Database profile | DatabaseProfile (required) |
| fileshareProfile | File share profile | FileshareProfile |
| managedResourceGroupConfiguration | Managed resource group configuration of the workload | ManagedRGConfiguration |
| networkProfile | Network profile | NetworkProfile |
| phpProfile | PHP profile | PhpProfile |
| searchProfile | Search profile | SearchProfile |
| siteProfile | Site profile | SiteProfile |
| webNodesProfile | VMSS web nodes profile | VmssNodesProfile (required) |
SearchProfile
| Name | Description | Value |
|---|---|---|
| dataDisks | Data disks details. This property is not in use right now | DiskInfo[] |
| name | VM or VMSS name | string |
| nodeSku | VM SKU for node(s) | string (required) |
| osDisk | OS disk details | DiskInfo (required) |
| osImage | OS image used for creating the nodes | OsImageProfile (required) |
| searchType | Search type | 'Elastic' (required) |
SiteProfile
| Name | Description | Value |
|---|---|---|
| domainName | Domain name for the application site URL | string |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. | int |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| name | The name of the SKU. Ex - P3. It is typically a letter+number code | string (required) |
| size | The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. | string |
| tier | This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. | 'Basic' 'Free' 'Premium' 'Standard' |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
UserProfile
| Name | Description | Value |
|---|---|---|
| sshPublicKey | SSH public key data | string (required) |
| userName | User name | string (required) |
VmssNodesProfile
| Name | Description | Value |
|---|---|---|
| autoScaleMaxCount | Maximum number of nodes for autoscale | int Constraints: Min value = 1 |
| autoScaleMinCount | Minimum number of nodes for autoscale | int Constraints: Min value = 1 |
| dataDisks | Data disks details. This property is not in use right now | DiskInfo[] |
| name | VM or VMSS name | string |
| nodeSku | VM SKU for node(s) | string (required) |
| osDisk | OS disk details | DiskInfo (required) |
| osImage | OS image used for creating the nodes | OsImageProfile (required) |
ARM template resource definition
The phpWorkloads 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.Workloads/phpWorkloads resource, add the following JSON to your template.
{
"type": "Microsoft.Workloads/phpWorkloads",
"apiVersion": "2021-12-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"kind": "string",
"location": "string",
"properties": {
"adminUserProfile": {
"sshPublicKey": "string",
"userName": "string"
},
"appLocation": "string",
"backupProfile": {
"backupEnabled": "string"
},
"cacheProfile": {
"capacity": "int",
"family": "string",
"name": "string",
"skuName": "string"
},
"controllerProfile": {
"dataDisks": [
{
"sizeInGB": "int",
"storageType": "string"
}
],
"name": "string",
"nodeSku": "string",
"osDisk": {
"sizeInGB": "int",
"storageType": "string"
},
"osImage": {
"offer": "string",
"publisher": "string",
"sku": "string",
"version": "string"
}
},
"databaseProfile": {
"backupRetentionDays": "int",
"haEnabled": "string",
"serverName": "string",
"sku": "string",
"sslEnforcementEnabled": "string",
"storageInGB": "int",
"storageIops": "int",
"storageSku": "string",
"tier": "string",
"type": "string",
"version": "string"
},
"fileshareProfile": {
"shareSizeInGB": "int",
"shareType": "string",
"storageType": "string"
},
"managedResourceGroupConfiguration": {
"name": "string"
},
"networkProfile": {
"azureFrontDoorEnabled": "string",
"capacity": "int",
"loadBalancerSku": "string",
"loadBalancerTier": "string",
"loadBalancerType": "string"
},
"phpProfile": {
"version": "string"
},
"searchProfile": {
"dataDisks": [
{
"sizeInGB": "int",
"storageType": "string"
}
],
"name": "string",
"nodeSku": "string",
"osDisk": {
"sizeInGB": "int",
"storageType": "string"
},
"osImage": {
"offer": "string",
"publisher": "string",
"sku": "string",
"version": "string"
},
"searchType": "string"
},
"siteProfile": {
"domainName": "string"
},
"webNodesProfile": {
"autoScaleMaxCount": "int",
"autoScaleMinCount": "int",
"dataDisks": [
{
"sizeInGB": "int",
"storageType": "string"
}
],
"name": "string",
"nodeSku": "string",
"osDisk": {
"sizeInGB": "int",
"storageType": "string"
},
"osImage": {
"offer": "string",
"publisher": "string",
"sku": "string",
"version": "string"
}
}
},
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Workloads/phpWorkloads
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-12-01-preview' |
| identity | Identity for the resource. Currently not supported | PhpWorkloadResourceIdentity |
| kind | Indicates which kind of php workload this resource represent e.g WordPress | 'WordPress' (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | Resource properties | PhpWorkloadResourceProperties |
| sku | Php workloads SKU | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Workloads/phpWorkloads' |
BackupProfile
| Name | Description | Value |
|---|---|---|
| backupEnabled | Whether to enable Azure backup for the workload | 'Disabled' 'Enabled' (required) |
CacheProfile
| Name | Description | Value |
|---|---|---|
| capacity | Cache capacity | int (required) |
| family | Cache family | 'C' 'P' (required) |
| name | Cache name | string |
| skuName | Cache SKU name | string (required) |
DatabaseProfile
| Name | Description | Value |
|---|---|---|
| backupRetentionDays | Backup retention days for the server | int |
| haEnabled | Whether to enable HA for the server | 'Disabled' 'Enabled' |
| serverName | Database server name | string |
| sku | The name of the server SKU, e.g. Standard_D32s_v4 | string (required) |
| sslEnforcementEnabled | Whether to enable SSL enforcement on the database | 'Disabled' 'Enabled' |
| storageInGB | Database storage size in GB | int Constraints: Min value = 1 |
| storageIops | Storage IOPS for the server | int |
| storageSku | SKU name for database storage | string |
| tier | Tier of the server SKU | 'Burstable' 'GeneralPurpose' 'MemoryOptimized' (required) |
| type | Database type | 'MySql' (required) |
| version | Database version | string |
DiskInfo
| Name | Description | Value |
|---|---|---|
| sizeInGB | Disk size in GB | int |
| storageType | Storage type | 'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' (required) |
FileshareProfile
| Name | Description | Value |
|---|---|---|
| shareSizeInGB | File share size in GB | int Constraints: Min value = 1 |
| shareType | Share type | 'AzureFiles' 'NfsOnController' (required) |
| storageType | File share backing storage type | 'Premium_LRS' 'Standard_GRS' 'Standard_LRS' 'Standard_ZRS' (required) |
ManagedRGConfiguration
| Name | Description | Value |
|---|---|---|
| name | Managed resource group name | string |
NetworkProfile
| Name | Description | Value |
|---|---|---|
| azureFrontDoorEnabled | Whether to enable Azure front door | 'Disabled' 'Enabled' |
| capacity | Capacity, applicable only for Application Gateway | int |
| loadBalancerSku | Load balancer SKU | string |
| loadBalancerTier | Load balancer tier | string |
| loadBalancerType | Load balancer type | 'ApplicationGateway' 'LoadBalancer' (required) |
NodeProfile
| Name | Description | Value |
|---|---|---|
| dataDisks | Data disks details. This property is not in use right now | DiskInfo[] |
| name | VM or VMSS name | string |
| nodeSku | VM SKU for node(s) | string (required) |
| osDisk | OS disk details | DiskInfo (required) |
| osImage | OS image used for creating the nodes | OsImageProfile (required) |
OsImageProfile
| Name | Description | Value |
|---|---|---|
| offer | OS image offer | 'UbuntuServer' |
| publisher | OS image publisher | 'Canonical' |
| sku | OS image sku | '16.04-LTS' '18.04-LTS' |
| version | OS image version | 'latest' |
PhpProfile
| Name | Description | Value |
|---|---|---|
| version | PHP version | '7.2' '7.3' '7.4' (required) |
PhpWorkloadResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of manage identity | 'None' 'UserAssigned' (required) |
| userAssignedIdentities | User assigned identities dictionary | UserAssignedIdentities |
PhpWorkloadResourceProperties
| Name | Description | Value |
|---|---|---|
| adminUserProfile | Admin user profile used for VM and VMSS | UserProfile (required) |
| appLocation | The infra resources for PHP workload will be created in this location | string (required) |
| backupProfile | Backup profile | BackupProfile |
| cacheProfile | Cache profile | CacheProfile |
| controllerProfile | Controller VM profile | NodeProfile (required) |
| databaseProfile | Database profile | DatabaseProfile (required) |
| fileshareProfile | File share profile | FileshareProfile |
| managedResourceGroupConfiguration | Managed resource group configuration of the workload | ManagedRGConfiguration |
| networkProfile | Network profile | NetworkProfile |
| phpProfile | PHP profile | PhpProfile |
| searchProfile | Search profile | SearchProfile |
| siteProfile | Site profile | SiteProfile |
| webNodesProfile | VMSS web nodes profile | VmssNodesProfile (required) |
SearchProfile
| Name | Description | Value |
|---|---|---|
| dataDisks | Data disks details. This property is not in use right now | DiskInfo[] |
| name | VM or VMSS name | string |
| nodeSku | VM SKU for node(s) | string (required) |
| osDisk | OS disk details | DiskInfo (required) |
| osImage | OS image used for creating the nodes | OsImageProfile (required) |
| searchType | Search type | 'Elastic' (required) |
SiteProfile
| Name | Description | Value |
|---|---|---|
| domainName | Domain name for the application site URL | string |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. | int |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| name | The name of the SKU. Ex - P3. It is typically a letter+number code | string (required) |
| size | The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. | string |
| tier | This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. | 'Basic' 'Free' 'Premium' 'Standard' |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
UserProfile
| Name | Description | Value |
|---|---|---|
| sshPublicKey | SSH public key data | string (required) |
| userName | User name | string (required) |
VmssNodesProfile
| Name | Description | Value |
|---|---|---|
| autoScaleMaxCount | Maximum number of nodes for autoscale | int Constraints: Min value = 1 |
| autoScaleMinCount | Minimum number of nodes for autoscale | int Constraints: Min value = 1 |
| dataDisks | Data disks details. This property is not in use right now | DiskInfo[] |
| name | VM or VMSS name | string |
| nodeSku | VM SKU for node(s) | string (required) |
| osDisk | OS disk details | DiskInfo (required) |
| osImage | OS image used for creating the nodes | OsImageProfile (required) |
Usage Examples
Terraform (AzAPI provider) resource definition
The phpWorkloads 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.Workloads/phpWorkloads resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Workloads/phpWorkloads@2021-12-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
kind = "string"
properties = {
adminUserProfile = {
sshPublicKey = "string"
userName = "string"
}
appLocation = "string"
backupProfile = {
backupEnabled = "string"
}
cacheProfile = {
capacity = int
family = "string"
name = "string"
skuName = "string"
}
controllerProfile = {
dataDisks = [
{
sizeInGB = int
storageType = "string"
}
]
name = "string"
nodeSku = "string"
osDisk = {
sizeInGB = int
storageType = "string"
}
osImage = {
offer = "string"
publisher = "string"
sku = "string"
version = "string"
}
}
databaseProfile = {
backupRetentionDays = int
haEnabled = "string"
serverName = "string"
sku = "string"
sslEnforcementEnabled = "string"
storageInGB = int
storageIops = int
storageSku = "string"
tier = "string"
type = "string"
version = "string"
}
fileshareProfile = {
shareSizeInGB = int
shareType = "string"
storageType = "string"
}
managedResourceGroupConfiguration = {
name = "string"
}
networkProfile = {
azureFrontDoorEnabled = "string"
capacity = int
loadBalancerSku = "string"
loadBalancerTier = "string"
loadBalancerType = "string"
}
phpProfile = {
version = "string"
}
searchProfile = {
dataDisks = [
{
sizeInGB = int
storageType = "string"
}
]
name = "string"
nodeSku = "string"
osDisk = {
sizeInGB = int
storageType = "string"
}
osImage = {
offer = "string"
publisher = "string"
sku = "string"
version = "string"
}
searchType = "string"
}
siteProfile = {
domainName = "string"
}
webNodesProfile = {
autoScaleMaxCount = int
autoScaleMinCount = int
dataDisks = [
{
sizeInGB = int
storageType = "string"
}
]
name = "string"
nodeSku = "string"
osDisk = {
sizeInGB = int
storageType = "string"
}
osImage = {
offer = "string"
publisher = "string"
sku = "string"
version = "string"
}
}
}
sku = {
capacity = int
family = "string"
name = "string"
size = "string"
tier = "string"
}
}
}
Property Values
Microsoft.Workloads/phpWorkloads
| Name | Description | Value |
|---|---|---|
| identity | Identity for the resource. Currently not supported | PhpWorkloadResourceIdentity |
| kind | Indicates which kind of php workload this resource represent e.g WordPress | 'WordPress' (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | Resource properties | PhpWorkloadResourceProperties |
| sku | Php workloads SKU | Sku |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Workloads/phpWorkloads@2021-12-01-preview" |
BackupProfile
| Name | Description | Value |
|---|---|---|
| backupEnabled | Whether to enable Azure backup for the workload | 'Disabled' 'Enabled' (required) |
CacheProfile
| Name | Description | Value |
|---|---|---|
| capacity | Cache capacity | int (required) |
| family | Cache family | 'C' 'P' (required) |
| name | Cache name | string |
| skuName | Cache SKU name | string (required) |
DatabaseProfile
| Name | Description | Value |
|---|---|---|
| backupRetentionDays | Backup retention days for the server | int |
| haEnabled | Whether to enable HA for the server | 'Disabled' 'Enabled' |
| serverName | Database server name | string |
| sku | The name of the server SKU, e.g. Standard_D32s_v4 | string (required) |
| sslEnforcementEnabled | Whether to enable SSL enforcement on the database | 'Disabled' 'Enabled' |
| storageInGB | Database storage size in GB | int Constraints: Min value = 1 |
| storageIops | Storage IOPS for the server | int |
| storageSku | SKU name for database storage | string |
| tier | Tier of the server SKU | 'Burstable' 'GeneralPurpose' 'MemoryOptimized' (required) |
| type | Database type | 'MySql' (required) |
| version | Database version | string |
DiskInfo
| Name | Description | Value |
|---|---|---|
| sizeInGB | Disk size in GB | int |
| storageType | Storage type | 'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' (required) |
FileshareProfile
| Name | Description | Value |
|---|---|---|
| shareSizeInGB | File share size in GB | int Constraints: Min value = 1 |
| shareType | Share type | 'AzureFiles' 'NfsOnController' (required) |
| storageType | File share backing storage type | 'Premium_LRS' 'Standard_GRS' 'Standard_LRS' 'Standard_ZRS' (required) |
ManagedRGConfiguration
| Name | Description | Value |
|---|---|---|
| name | Managed resource group name | string |
NetworkProfile
| Name | Description | Value |
|---|---|---|
| azureFrontDoorEnabled | Whether to enable Azure front door | 'Disabled' 'Enabled' |
| capacity | Capacity, applicable only for Application Gateway | int |
| loadBalancerSku | Load balancer SKU | string |
| loadBalancerTier | Load balancer tier | string |
| loadBalancerType | Load balancer type | 'ApplicationGateway' 'LoadBalancer' (required) |
NodeProfile
| Name | Description | Value |
|---|---|---|
| dataDisks | Data disks details. This property is not in use right now | DiskInfo[] |
| name | VM or VMSS name | string |
| nodeSku | VM SKU for node(s) | string (required) |
| osDisk | OS disk details | DiskInfo (required) |
| osImage | OS image used for creating the nodes | OsImageProfile (required) |
OsImageProfile
| Name | Description | Value |
|---|---|---|
| offer | OS image offer | 'UbuntuServer' |
| publisher | OS image publisher | 'Canonical' |
| sku | OS image sku | '16.04-LTS' '18.04-LTS' |
| version | OS image version | 'latest' |
PhpProfile
| Name | Description | Value |
|---|---|---|
| version | PHP version | '7.2' '7.3' '7.4' (required) |
PhpWorkloadResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of manage identity | 'None' 'UserAssigned' (required) |
| userAssignedIdentities | User assigned identities dictionary | UserAssignedIdentities |
PhpWorkloadResourceProperties
| Name | Description | Value |
|---|---|---|
| adminUserProfile | Admin user profile used for VM and VMSS | UserProfile (required) |
| appLocation | The infra resources for PHP workload will be created in this location | string (required) |
| backupProfile | Backup profile | BackupProfile |
| cacheProfile | Cache profile | CacheProfile |
| controllerProfile | Controller VM profile | NodeProfile (required) |
| databaseProfile | Database profile | DatabaseProfile (required) |
| fileshareProfile | File share profile | FileshareProfile |
| managedResourceGroupConfiguration | Managed resource group configuration of the workload | ManagedRGConfiguration |
| networkProfile | Network profile | NetworkProfile |
| phpProfile | PHP profile | PhpProfile |
| searchProfile | Search profile | SearchProfile |
| siteProfile | Site profile | SiteProfile |
| webNodesProfile | VMSS web nodes profile | VmssNodesProfile (required) |
SearchProfile
| Name | Description | Value |
|---|---|---|
| dataDisks | Data disks details. This property is not in use right now | DiskInfo[] |
| name | VM or VMSS name | string |
| nodeSku | VM SKU for node(s) | string (required) |
| osDisk | OS disk details | DiskInfo (required) |
| osImage | OS image used for creating the nodes | OsImageProfile (required) |
| searchType | Search type | 'Elastic' (required) |
SiteProfile
| Name | Description | Value |
|---|---|---|
| domainName | Domain name for the application site URL | string |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. | int |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| name | The name of the SKU. Ex - P3. It is typically a letter+number code | string (required) |
| size | The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. | string |
| tier | This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. | 'Basic' 'Free' 'Premium' 'Standard' |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
UserProfile
| Name | Description | Value |
|---|---|---|
| sshPublicKey | SSH public key data | string (required) |
| userName | User name | string (required) |
VmssNodesProfile
| Name | Description | Value |
|---|---|---|
| autoScaleMaxCount | Maximum number of nodes for autoscale | int Constraints: Min value = 1 |
| autoScaleMinCount | Minimum number of nodes for autoscale | int Constraints: Min value = 1 |
| dataDisks | Data disks details. This property is not in use right now | DiskInfo[] |
| name | VM or VMSS name | string |
| nodeSku | VM SKU for node(s) | string (required) |
| osDisk | OS disk details | DiskInfo (required) |
| osImage | OS image used for creating the nodes | OsImageProfile (required) |