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 moveCollections/moveResources 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.Migrate/moveCollections/moveResources resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Migrate/moveCollections/moveResources@2023-08-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
dependsOnOverrides: [
{
id: 'string'
targetId: 'string'
}
]
existingTargetId: 'string'
resourceSettings: {
targetResourceGroupName: 'string'
targetResourceName: 'string'
resourceType: 'string'
// For remaining properties, see ResourceSettings objects
}
sourceId: 'string'
}
}
ResourceSettings objects
Set the resourceType property to specify the type of object.
For Microsoft.Compute/availabilitySets, use:
{
faultDomain: int
resourceType: 'Microsoft.Compute/availabilitySets'
tags: {
{customized property}: 'string'
}
updateDomain: int
}
For Microsoft.Compute/diskEncryptionSets, use:
{
resourceType: 'Microsoft.Compute/diskEncryptionSets'
}
For Microsoft.Compute/virtualMachines, use:
{
resourceType: 'Microsoft.Compute/virtualMachines'
tags: {
{customized property}: 'string'
}
targetAvailabilitySetId: 'string'
targetAvailabilityZone: 'string'
targetVmSize: 'string'
userManagedIdentities: [
'string'
]
}
For Microsoft.KeyVault/vaults, use:
{
resourceType: 'Microsoft.KeyVault/vaults'
}
For Microsoft.Network/loadBalancers, use:
{
backendAddressPools: [
{
name: 'string'
}
]
frontendIPConfigurations: [
{
name: 'string'
privateIpAddress: 'string'
privateIpAllocationMethod: 'string'
subnet: {
name: 'string'
sourceArmResourceId: 'string'
}
zones: 'string'
}
]
resourceType: 'Microsoft.Network/loadBalancers'
sku: 'string'
tags: {
{customized property}: 'string'
}
zones: 'string'
}
For Microsoft.Network/networkInterfaces, use:
{
enableAcceleratedNetworking: bool
ipConfigurations: [
{
loadBalancerBackendAddressPools: [
{
name: 'string'
sourceArmResourceId: 'string'
}
]
loadBalancerNatRules: [
{
name: 'string'
sourceArmResourceId: 'string'
}
]
name: 'string'
primary: bool
privateIpAddress: 'string'
privateIpAllocationMethod: 'string'
publicIp: {
sourceArmResourceId: 'string'
}
subnet: {
name: 'string'
sourceArmResourceId: 'string'
}
}
]
resourceType: 'Microsoft.Network/networkInterfaces'
tags: {
{customized property}: 'string'
}
}
For Microsoft.Network/networkSecurityGroups, use:
{
resourceType: 'Microsoft.Network/networkSecurityGroups'
securityRules: [
{
access: 'string'
description: 'string'
destinationAddressPrefix: 'string'
destinationPortRange: 'string'
direction: 'string'
name: 'string'
priority: int
protocol: 'string'
sourceAddressPrefix: 'string'
sourcePortRange: 'string'
}
]
tags: {
{customized property}: 'string'
}
}
For Microsoft.Network/publicIPAddresses, use:
{
domainNameLabel: 'string'
fqdn: 'string'
publicIpAllocationMethod: 'string'
resourceType: 'Microsoft.Network/publicIPAddresses'
sku: 'string'
tags: {
{customized property}: 'string'
}
zones: 'string'
}
For Microsoft.Network/virtualNetworks, use:
{
addressSpace: [
'string'
]
dnsServers: [
'string'
]
enableDdosProtection: bool
resourceType: 'Microsoft.Network/virtualNetworks'
subnets: [
{
addressPrefix: 'string'
name: 'string'
networkSecurityGroup: {
sourceArmResourceId: 'string'
}
}
]
tags: {
{customized property}: 'string'
}
}
For Microsoft.Sql/servers, use:
{
resourceType: 'Microsoft.Sql/servers'
}
For Microsoft.Sql/servers/databases, use:
{
resourceType: 'Microsoft.Sql/servers/databases'
tags: {
{customized property}: 'string'
}
zoneRedundant: 'string'
}
For Microsoft.Sql/servers/elasticPools, use:
{
resourceType: 'Microsoft.Sql/servers/elasticPools'
tags: {
{customized property}: 'string'
}
zoneRedundant: 'string'
}
For resourceGroups, use:
{
resourceType: 'resourceGroups'
}
Property Values
Microsoft.Migrate/moveCollections/moveResources
| Name | Description | Value |
|---|---|---|
| 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: moveCollections |
| properties | Defines the move resource properties. | MoveResourceProperties |
AvailabilitySetResourceSettings
| Name | Description | Value |
|---|---|---|
| faultDomain | Gets or sets the target fault domain. | int Constraints: Min value = 1 |
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Compute/availabilitySets' (required) |
| tags | Gets or sets the Resource tags. | AvailabilitySetResourceSettingsTags |
| updateDomain | Gets or sets the target update domain. | int Constraints: Min value = 1 Max value = 20 |
AvailabilitySetResourceSettingsTags
| Name | Description | Value |
|---|
DiskEncryptionSetResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Compute/diskEncryptionSets' (required) |
KeyVaultResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.KeyVault/vaults' (required) |
LBBackendAddressPoolResourceSettings
| Name | Description | Value |
|---|---|---|
| name | Gets or sets the backend address pool name. | string |
LBFrontendIPConfigurationResourceSettings
| Name | Description | Value |
|---|---|---|
| name | Gets or sets the frontend IP configuration name. | string |
| privateIpAddress | Gets or sets the IP address of the Load Balancer.This is only specified if a specific private IP address shall be allocated from the subnet specified in subnetRef. |
string |
| privateIpAllocationMethod | Gets or sets PrivateIP allocation method (Static/Dynamic). | string |
| subnet | Defines reference to subnet. | SubnetReference |
| zones | Gets or sets the csv list of zones. | string |
LoadBalancerBackendAddressPoolReference
| Name | Description | Value |
|---|---|---|
| name | Gets the name of the proxy resource on the target side. | string |
| sourceArmResourceId | Gets the ARM resource ID of the tracked resource being referenced. | string (required) |
LoadBalancerNatRuleReference
| Name | Description | Value |
|---|---|---|
| name | Gets the name of the proxy resource on the target side. | string |
| sourceArmResourceId | Gets the ARM resource ID of the tracked resource being referenced. | string (required) |
LoadBalancerResourceSettings
| Name | Description | Value |
|---|---|---|
| backendAddressPools | Gets or sets the backend address pools of the load balancer. | LBBackendAddressPoolResourceSettings[] |
| frontendIPConfigurations | Gets or sets the frontend IP configurations of the load balancer. | LBFrontendIPConfigurationResourceSettings[] |
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Network/loadBalancers' (required) |
| sku | Gets or sets load balancer sku (Basic/Standard). | string |
| tags | Gets or sets the Resource tags. | LoadBalancerResourceSettingsTags |
| zones | Gets or sets the csv list of zones common for all frontend IP configurations. Note this is given precedence only if frontend IP configurations settings are not present. |
string |
LoadBalancerResourceSettingsTags
| Name | Description | Value |
|---|
MoveResourceDependencyOverride
| Name | Description | Value |
|---|---|---|
| id | Gets or sets the ARM ID of the dependent resource. | string |
| targetId | Gets or sets the resource ARM id of either the MoveResource or the resource ARM ID of the dependent resource. |
string |
MoveResourceProperties
| Name | Description | Value |
|---|---|---|
| dependsOnOverrides | Gets or sets the move resource dependencies overrides. | MoveResourceDependencyOverride[] |
| existingTargetId | Gets or sets the existing target ARM Id of the resource. | string |
| resourceSettings | Gets or sets the resource settings. | ResourceSettings |
| sourceId | Gets or sets the Source ARM Id of the resource. | string (required) |
NetworkInterfaceResourceSettings
| Name | Description | Value |
|---|---|---|
| enableAcceleratedNetworking | Gets or sets a value indicating whether accelerated networking is enabled. | bool |
| ipConfigurations | Gets or sets the IP configurations of the NIC. | NicIpConfigurationResourceSettings[] |
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Network/networkInterfaces' (required) |
| tags | Gets or sets the Resource tags. | NetworkInterfaceResourceSettingsTags |
NetworkInterfaceResourceSettingsTags
| Name | Description | Value |
|---|
NetworkSecurityGroupResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Network/networkSecurityGroups' (required) |
| securityRules | Gets or sets Security rules of network security group. | NsgSecurityRule[] |
| tags | Gets or sets the Resource tags. | NetworkSecurityGroupResourceSettingsTags |
NetworkSecurityGroupResourceSettingsTags
| Name | Description | Value |
|---|
NicIpConfigurationResourceSettings
| Name | Description | Value |
|---|---|---|
| loadBalancerBackendAddressPools | Gets or sets the references of the load balancer backend address pools. | LoadBalancerBackendAddressPoolReference[] |
| loadBalancerNatRules | Gets or sets the references of the load balancer NAT rules. | LoadBalancerNatRuleReference[] |
| name | Gets or sets the IP configuration name. | string |
| primary | Gets or sets a value indicating whether this IP configuration is the primary. | bool |
| privateIpAddress | Gets or sets the private IP address of the network interface IP Configuration. | string |
| privateIpAllocationMethod | Gets or sets the private IP address allocation method. | string |
| publicIp | Defines reference to a public IP. | PublicIpReference |
| subnet | Defines reference to subnet. | SubnetReference |
NsgReference
| Name | Description | Value |
|---|---|---|
| sourceArmResourceId | Gets the ARM resource ID of the tracked resource being referenced. | string (required) |
NsgSecurityRule
| Name | Description | Value |
|---|---|---|
| access | Gets or sets whether network traffic is allowed or denied. Possible values are “Allow” and “Deny”. |
string |
| description | Gets or sets a description for this rule. Restricted to 140 chars. | string |
| destinationAddressPrefix | Gets or sets destination address prefix. CIDR or source IP range. A “*” can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. |
string |
| destinationPortRange | Gets or sets Destination Port or Range. Integer or range between 0 and 65535. A “*” can also be used to match all ports. |
string |
| direction | Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outgoing traffic. |
string |
| name | Gets or sets the Security rule name. | string |
| priority | Gets or sets the priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. |
int |
| protocol | Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). | string |
| sourceAddressPrefix | Gets or sets source address prefix. CIDR or source IP range. A “*” can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. If this is an ingress rule, specifies where network traffic originates from. |
string |
| sourcePortRange | Gets or sets Source Port or Range. Integer or range between 0 and 65535. A “*” can also be used to match all ports. |
string |
PublicIPAddressResourceSettings
| Name | Description | Value |
|---|---|---|
| domainNameLabel | Gets or sets the domain name label. | string |
| fqdn | Gets or sets the fully qualified domain name. | string |
| publicIpAllocationMethod | Gets or sets public IP allocation method. | string |
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Network/publicIPAddresses' (required) |
| sku | Gets or sets public IP sku. | string |
| tags | Gets or sets the Resource tags. | PublicIPAddressResourceSettingsTags |
| zones | Gets or sets public IP zones. | string |
PublicIPAddressResourceSettingsTags
| Name | Description | Value |
|---|
PublicIpReference
| Name | Description | Value |
|---|---|---|
| sourceArmResourceId | Gets the ARM resource ID of the tracked resource being referenced. | string (required) |
ResourceGroupResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'resourceGroups' (required) |
ResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | Set to 'Microsoft.Compute/availabilitySets' for type AvailabilitySetResourceSettings. Set to 'Microsoft.Compute/diskEncryptionSets' for type DiskEncryptionSetResourceSettings. Set to 'Microsoft.Compute/virtualMachines' for type VirtualMachineResourceSettings. Set to 'Microsoft.KeyVault/vaults' for type KeyVaultResourceSettings. Set to 'Microsoft.Network/loadBalancers' for type LoadBalancerResourceSettings. Set to 'Microsoft.Network/networkInterfaces' for type NetworkInterfaceResourceSettings. Set to 'Microsoft.Network/networkSecurityGroups' for type NetworkSecurityGroupResourceSettings. Set to 'Microsoft.Network/publicIPAddresses' for type PublicIPAddressResourceSettings. Set to 'Microsoft.Network/virtualNetworks' for type VirtualNetworkResourceSettings. Set to 'Microsoft.Sql/servers' for type SqlServerResourceSettings. Set to 'Microsoft.Sql/servers/databases' for type SqlDatabaseResourceSettings. Set to 'Microsoft.Sql/servers/elasticPools' for type SqlElasticPoolResourceSettings. Set to 'resourceGroups' for type ResourceGroupResourceSettings. | 'Microsoft.Compute/availabilitySets' 'Microsoft.Compute/diskEncryptionSets' 'Microsoft.Compute/virtualMachines' 'Microsoft.KeyVault/vaults' 'Microsoft.Network/loadBalancers' 'Microsoft.Network/networkInterfaces' 'Microsoft.Network/networkSecurityGroups' 'Microsoft.Network/publicIPAddresses' 'Microsoft.Network/virtualNetworks' 'Microsoft.Sql/servers' 'Microsoft.Sql/servers/databases' 'Microsoft.Sql/servers/elasticPools' 'resourceGroups' (required) |
| targetResourceGroupName | Gets or sets the target resource group name. | string |
| targetResourceName | Gets or sets the target Resource name. | string |
SqlDatabaseResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Sql/servers/databases' (required) |
| tags | Gets or sets the Resource tags. | SqlDatabaseResourceSettingsTags |
| zoneRedundant | Defines the zone redundant resource setting. | 'Disable' 'Enable' |
SqlDatabaseResourceSettingsTags
| Name | Description | Value |
|---|
SqlElasticPoolResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Sql/servers/elasticPools' (required) |
| tags | Gets or sets the Resource tags. | SqlElasticPoolResourceSettingsTags |
| zoneRedundant | Defines the zone redundant resource setting. | 'Disable' 'Enable' |
SqlElasticPoolResourceSettingsTags
| Name | Description | Value |
|---|
SqlServerResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Sql/servers' (required) |
SubnetReference
| Name | Description | Value |
|---|---|---|
| name | Gets the name of the proxy resource on the target side. | string |
| sourceArmResourceId | Gets the ARM resource ID of the tracked resource being referenced. | string (required) |
SubnetResourceSettings
| Name | Description | Value |
|---|---|---|
| addressPrefix | Gets or sets address prefix for the subnet. | string |
| name | Gets or sets the Subnet name. | string |
| networkSecurityGroup | Defines reference to NSG. | NsgReference |
VirtualMachineResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Compute/virtualMachines' (required) |
| tags | Gets or sets the Resource tags. | VirtualMachineResourceSettingsTags |
| targetAvailabilitySetId | Gets or sets the target availability set id for virtual machines not in an availability set at source. | string |
| targetAvailabilityZone | Gets or sets the target availability zone. | '1' '2' '3' 'NA' |
| targetVmSize | Gets or sets the target virtual machine size. | string |
| userManagedIdentities | Gets or sets user-managed identities | string[] |
VirtualMachineResourceSettingsTags
| Name | Description | Value |
|---|
VirtualNetworkResourceSettings
| Name | Description | Value |
|---|---|---|
| addressSpace | Gets or sets the address prefixes for the virtual network. | string[] |
| dnsServers | Gets or sets DHCPOptions that contains an array of DNS servers available to VMs deployed in the virtual network. |
string[] |
| enableDdosProtection | Gets or sets a value indicating whether gets or sets whether the DDOS protection should be switched on. |
bool |
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Network/virtualNetworks' (required) |
| subnets | Gets or sets List of subnets in a VirtualNetwork. | SubnetResourceSettings[] |
| tags | Gets or sets the Resource tags. | VirtualNetworkResourceSettingsTags |
VirtualNetworkResourceSettingsTags
| Name | Description | Value |
|---|
ARM template resource definition
The moveCollections/moveResources 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.Migrate/moveCollections/moveResources resource, add the following JSON to your template.
{
"type": "Microsoft.Migrate/moveCollections/moveResources",
"apiVersion": "2023-08-01",
"name": "string",
"properties": {
"dependsOnOverrides": [
{
"id": "string",
"targetId": "string"
}
],
"existingTargetId": "string",
"resourceSettings": {
"targetResourceGroupName": "string",
"targetResourceName": "string",
"resourceType": "string"
// For remaining properties, see ResourceSettings objects
},
"sourceId": "string"
}
}
ResourceSettings objects
Set the resourceType property to specify the type of object.
For Microsoft.Compute/availabilitySets, use:
{
"faultDomain": "int",
"resourceType": "Microsoft.Compute/availabilitySets",
"tags": {
"{customized property}": "string"
},
"updateDomain": "int"
}
For Microsoft.Compute/diskEncryptionSets, use:
{
"resourceType": "Microsoft.Compute/diskEncryptionSets"
}
For Microsoft.Compute/virtualMachines, use:
{
"resourceType": "Microsoft.Compute/virtualMachines",
"tags": {
"{customized property}": "string"
},
"targetAvailabilitySetId": "string",
"targetAvailabilityZone": "string",
"targetVmSize": "string",
"userManagedIdentities": [ "string" ]
}
For Microsoft.KeyVault/vaults, use:
{
"resourceType": "Microsoft.KeyVault/vaults"
}
For Microsoft.Network/loadBalancers, use:
{
"backendAddressPools": [
{
"name": "string"
}
],
"frontendIPConfigurations": [
{
"name": "string",
"privateIpAddress": "string",
"privateIpAllocationMethod": "string",
"subnet": {
"name": "string",
"sourceArmResourceId": "string"
},
"zones": "string"
}
],
"resourceType": "Microsoft.Network/loadBalancers",
"sku": "string",
"tags": {
"{customized property}": "string"
},
"zones": "string"
}
For Microsoft.Network/networkInterfaces, use:
{
"enableAcceleratedNetworking": "bool",
"ipConfigurations": [
{
"loadBalancerBackendAddressPools": [
{
"name": "string",
"sourceArmResourceId": "string"
}
],
"loadBalancerNatRules": [
{
"name": "string",
"sourceArmResourceId": "string"
}
],
"name": "string",
"primary": "bool",
"privateIpAddress": "string",
"privateIpAllocationMethod": "string",
"publicIp": {
"sourceArmResourceId": "string"
},
"subnet": {
"name": "string",
"sourceArmResourceId": "string"
}
}
],
"resourceType": "Microsoft.Network/networkInterfaces",
"tags": {
"{customized property}": "string"
}
}
For Microsoft.Network/networkSecurityGroups, use:
{
"resourceType": "Microsoft.Network/networkSecurityGroups",
"securityRules": [
{
"access": "string",
"description": "string",
"destinationAddressPrefix": "string",
"destinationPortRange": "string",
"direction": "string",
"name": "string",
"priority": "int",
"protocol": "string",
"sourceAddressPrefix": "string",
"sourcePortRange": "string"
}
],
"tags": {
"{customized property}": "string"
}
}
For Microsoft.Network/publicIPAddresses, use:
{
"domainNameLabel": "string",
"fqdn": "string",
"publicIpAllocationMethod": "string",
"resourceType": "Microsoft.Network/publicIPAddresses",
"sku": "string",
"tags": {
"{customized property}": "string"
},
"zones": "string"
}
For Microsoft.Network/virtualNetworks, use:
{
"addressSpace": [ "string" ],
"dnsServers": [ "string" ],
"enableDdosProtection": "bool",
"resourceType": "Microsoft.Network/virtualNetworks",
"subnets": [
{
"addressPrefix": "string",
"name": "string",
"networkSecurityGroup": {
"sourceArmResourceId": "string"
}
}
],
"tags": {
"{customized property}": "string"
}
}
For Microsoft.Sql/servers, use:
{
"resourceType": "Microsoft.Sql/servers"
}
For Microsoft.Sql/servers/databases, use:
{
"resourceType": "Microsoft.Sql/servers/databases",
"tags": {
"{customized property}": "string"
},
"zoneRedundant": "string"
}
For Microsoft.Sql/servers/elasticPools, use:
{
"resourceType": "Microsoft.Sql/servers/elasticPools",
"tags": {
"{customized property}": "string"
},
"zoneRedundant": "string"
}
For resourceGroups, use:
{
"resourceType": "resourceGroups"
}
Property Values
Microsoft.Migrate/moveCollections/moveResources
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-08-01' |
| name | The resource name | string (required) |
| properties | Defines the move resource properties. | MoveResourceProperties |
| type | The resource type | 'Microsoft.Migrate/moveCollections/moveResources' |
AvailabilitySetResourceSettings
| Name | Description | Value |
|---|---|---|
| faultDomain | Gets or sets the target fault domain. | int Constraints: Min value = 1 |
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Compute/availabilitySets' (required) |
| tags | Gets or sets the Resource tags. | AvailabilitySetResourceSettingsTags |
| updateDomain | Gets or sets the target update domain. | int Constraints: Min value = 1 Max value = 20 |
AvailabilitySetResourceSettingsTags
| Name | Description | Value |
|---|
DiskEncryptionSetResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Compute/diskEncryptionSets' (required) |
KeyVaultResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.KeyVault/vaults' (required) |
LBBackendAddressPoolResourceSettings
| Name | Description | Value |
|---|---|---|
| name | Gets or sets the backend address pool name. | string |
LBFrontendIPConfigurationResourceSettings
| Name | Description | Value |
|---|---|---|
| name | Gets or sets the frontend IP configuration name. | string |
| privateIpAddress | Gets or sets the IP address of the Load Balancer.This is only specified if a specific private IP address shall be allocated from the subnet specified in subnetRef. |
string |
| privateIpAllocationMethod | Gets or sets PrivateIP allocation method (Static/Dynamic). | string |
| subnet | Defines reference to subnet. | SubnetReference |
| zones | Gets or sets the csv list of zones. | string |
LoadBalancerBackendAddressPoolReference
| Name | Description | Value |
|---|---|---|
| name | Gets the name of the proxy resource on the target side. | string |
| sourceArmResourceId | Gets the ARM resource ID of the tracked resource being referenced. | string (required) |
LoadBalancerNatRuleReference
| Name | Description | Value |
|---|---|---|
| name | Gets the name of the proxy resource on the target side. | string |
| sourceArmResourceId | Gets the ARM resource ID of the tracked resource being referenced. | string (required) |
LoadBalancerResourceSettings
| Name | Description | Value |
|---|---|---|
| backendAddressPools | Gets or sets the backend address pools of the load balancer. | LBBackendAddressPoolResourceSettings[] |
| frontendIPConfigurations | Gets or sets the frontend IP configurations of the load balancer. | LBFrontendIPConfigurationResourceSettings[] |
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Network/loadBalancers' (required) |
| sku | Gets or sets load balancer sku (Basic/Standard). | string |
| tags | Gets or sets the Resource tags. | LoadBalancerResourceSettingsTags |
| zones | Gets or sets the csv list of zones common for all frontend IP configurations. Note this is given precedence only if frontend IP configurations settings are not present. |
string |
LoadBalancerResourceSettingsTags
| Name | Description | Value |
|---|
MoveResourceDependencyOverride
| Name | Description | Value |
|---|---|---|
| id | Gets or sets the ARM ID of the dependent resource. | string |
| targetId | Gets or sets the resource ARM id of either the MoveResource or the resource ARM ID of the dependent resource. |
string |
MoveResourceProperties
| Name | Description | Value |
|---|---|---|
| dependsOnOverrides | Gets or sets the move resource dependencies overrides. | MoveResourceDependencyOverride[] |
| existingTargetId | Gets or sets the existing target ARM Id of the resource. | string |
| resourceSettings | Gets or sets the resource settings. | ResourceSettings |
| sourceId | Gets or sets the Source ARM Id of the resource. | string (required) |
NetworkInterfaceResourceSettings
| Name | Description | Value |
|---|---|---|
| enableAcceleratedNetworking | Gets or sets a value indicating whether accelerated networking is enabled. | bool |
| ipConfigurations | Gets or sets the IP configurations of the NIC. | NicIpConfigurationResourceSettings[] |
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Network/networkInterfaces' (required) |
| tags | Gets or sets the Resource tags. | NetworkInterfaceResourceSettingsTags |
NetworkInterfaceResourceSettingsTags
| Name | Description | Value |
|---|
NetworkSecurityGroupResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Network/networkSecurityGroups' (required) |
| securityRules | Gets or sets Security rules of network security group. | NsgSecurityRule[] |
| tags | Gets or sets the Resource tags. | NetworkSecurityGroupResourceSettingsTags |
NetworkSecurityGroupResourceSettingsTags
| Name | Description | Value |
|---|
NicIpConfigurationResourceSettings
| Name | Description | Value |
|---|---|---|
| loadBalancerBackendAddressPools | Gets or sets the references of the load balancer backend address pools. | LoadBalancerBackendAddressPoolReference[] |
| loadBalancerNatRules | Gets or sets the references of the load balancer NAT rules. | LoadBalancerNatRuleReference[] |
| name | Gets or sets the IP configuration name. | string |
| primary | Gets or sets a value indicating whether this IP configuration is the primary. | bool |
| privateIpAddress | Gets or sets the private IP address of the network interface IP Configuration. | string |
| privateIpAllocationMethod | Gets or sets the private IP address allocation method. | string |
| publicIp | Defines reference to a public IP. | PublicIpReference |
| subnet | Defines reference to subnet. | SubnetReference |
NsgReference
| Name | Description | Value |
|---|---|---|
| sourceArmResourceId | Gets the ARM resource ID of the tracked resource being referenced. | string (required) |
NsgSecurityRule
| Name | Description | Value |
|---|---|---|
| access | Gets or sets whether network traffic is allowed or denied. Possible values are “Allow” and “Deny”. |
string |
| description | Gets or sets a description for this rule. Restricted to 140 chars. | string |
| destinationAddressPrefix | Gets or sets destination address prefix. CIDR or source IP range. A “*” can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. |
string |
| destinationPortRange | Gets or sets Destination Port or Range. Integer or range between 0 and 65535. A “*” can also be used to match all ports. |
string |
| direction | Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outgoing traffic. |
string |
| name | Gets or sets the Security rule name. | string |
| priority | Gets or sets the priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. |
int |
| protocol | Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). | string |
| sourceAddressPrefix | Gets or sets source address prefix. CIDR or source IP range. A “*” can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. If this is an ingress rule, specifies where network traffic originates from. |
string |
| sourcePortRange | Gets or sets Source Port or Range. Integer or range between 0 and 65535. A “*” can also be used to match all ports. |
string |
PublicIPAddressResourceSettings
| Name | Description | Value |
|---|---|---|
| domainNameLabel | Gets or sets the domain name label. | string |
| fqdn | Gets or sets the fully qualified domain name. | string |
| publicIpAllocationMethod | Gets or sets public IP allocation method. | string |
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Network/publicIPAddresses' (required) |
| sku | Gets or sets public IP sku. | string |
| tags | Gets or sets the Resource tags. | PublicIPAddressResourceSettingsTags |
| zones | Gets or sets public IP zones. | string |
PublicIPAddressResourceSettingsTags
| Name | Description | Value |
|---|
PublicIpReference
| Name | Description | Value |
|---|---|---|
| sourceArmResourceId | Gets the ARM resource ID of the tracked resource being referenced. | string (required) |
ResourceGroupResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'resourceGroups' (required) |
ResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | Set to 'Microsoft.Compute/availabilitySets' for type AvailabilitySetResourceSettings. Set to 'Microsoft.Compute/diskEncryptionSets' for type DiskEncryptionSetResourceSettings. Set to 'Microsoft.Compute/virtualMachines' for type VirtualMachineResourceSettings. Set to 'Microsoft.KeyVault/vaults' for type KeyVaultResourceSettings. Set to 'Microsoft.Network/loadBalancers' for type LoadBalancerResourceSettings. Set to 'Microsoft.Network/networkInterfaces' for type NetworkInterfaceResourceSettings. Set to 'Microsoft.Network/networkSecurityGroups' for type NetworkSecurityGroupResourceSettings. Set to 'Microsoft.Network/publicIPAddresses' for type PublicIPAddressResourceSettings. Set to 'Microsoft.Network/virtualNetworks' for type VirtualNetworkResourceSettings. Set to 'Microsoft.Sql/servers' for type SqlServerResourceSettings. Set to 'Microsoft.Sql/servers/databases' for type SqlDatabaseResourceSettings. Set to 'Microsoft.Sql/servers/elasticPools' for type SqlElasticPoolResourceSettings. Set to 'resourceGroups' for type ResourceGroupResourceSettings. | 'Microsoft.Compute/availabilitySets' 'Microsoft.Compute/diskEncryptionSets' 'Microsoft.Compute/virtualMachines' 'Microsoft.KeyVault/vaults' 'Microsoft.Network/loadBalancers' 'Microsoft.Network/networkInterfaces' 'Microsoft.Network/networkSecurityGroups' 'Microsoft.Network/publicIPAddresses' 'Microsoft.Network/virtualNetworks' 'Microsoft.Sql/servers' 'Microsoft.Sql/servers/databases' 'Microsoft.Sql/servers/elasticPools' 'resourceGroups' (required) |
| targetResourceGroupName | Gets or sets the target resource group name. | string |
| targetResourceName | Gets or sets the target Resource name. | string |
SqlDatabaseResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Sql/servers/databases' (required) |
| tags | Gets or sets the Resource tags. | SqlDatabaseResourceSettingsTags |
| zoneRedundant | Defines the zone redundant resource setting. | 'Disable' 'Enable' |
SqlDatabaseResourceSettingsTags
| Name | Description | Value |
|---|
SqlElasticPoolResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Sql/servers/elasticPools' (required) |
| tags | Gets or sets the Resource tags. | SqlElasticPoolResourceSettingsTags |
| zoneRedundant | Defines the zone redundant resource setting. | 'Disable' 'Enable' |
SqlElasticPoolResourceSettingsTags
| Name | Description | Value |
|---|
SqlServerResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Sql/servers' (required) |
SubnetReference
| Name | Description | Value |
|---|---|---|
| name | Gets the name of the proxy resource on the target side. | string |
| sourceArmResourceId | Gets the ARM resource ID of the tracked resource being referenced. | string (required) |
SubnetResourceSettings
| Name | Description | Value |
|---|---|---|
| addressPrefix | Gets or sets address prefix for the subnet. | string |
| name | Gets or sets the Subnet name. | string |
| networkSecurityGroup | Defines reference to NSG. | NsgReference |
VirtualMachineResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Compute/virtualMachines' (required) |
| tags | Gets or sets the Resource tags. | VirtualMachineResourceSettingsTags |
| targetAvailabilitySetId | Gets or sets the target availability set id for virtual machines not in an availability set at source. | string |
| targetAvailabilityZone | Gets or sets the target availability zone. | '1' '2' '3' 'NA' |
| targetVmSize | Gets or sets the target virtual machine size. | string |
| userManagedIdentities | Gets or sets user-managed identities | string[] |
VirtualMachineResourceSettingsTags
| Name | Description | Value |
|---|
VirtualNetworkResourceSettings
| Name | Description | Value |
|---|---|---|
| addressSpace | Gets or sets the address prefixes for the virtual network. | string[] |
| dnsServers | Gets or sets DHCPOptions that contains an array of DNS servers available to VMs deployed in the virtual network. |
string[] |
| enableDdosProtection | Gets or sets a value indicating whether gets or sets whether the DDOS protection should be switched on. |
bool |
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Network/virtualNetworks' (required) |
| subnets | Gets or sets List of subnets in a VirtualNetwork. | SubnetResourceSettings[] |
| tags | Gets or sets the Resource tags. | VirtualNetworkResourceSettingsTags |
VirtualNetworkResourceSettingsTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The moveCollections/moveResources 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.Migrate/moveCollections/moveResources resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Migrate/moveCollections/moveResources@2023-08-01"
name = "string"
parent_id = "string"
body = {
properties = {
dependsOnOverrides = [
{
id = "string"
targetId = "string"
}
]
existingTargetId = "string"
resourceSettings = {
targetResourceGroupName = "string"
targetResourceName = "string"
resourceType = "string"
// For remaining properties, see ResourceSettings objects
}
sourceId = "string"
}
}
}
ResourceSettings objects
Set the resourceType property to specify the type of object.
For Microsoft.Compute/availabilitySets, use:
{
faultDomain = int
resourceType = "Microsoft.Compute/availabilitySets"
tags = {
{customized property} = "string"
}
updateDomain = int
}
For Microsoft.Compute/diskEncryptionSets, use:
{
resourceType = "Microsoft.Compute/diskEncryptionSets"
}
For Microsoft.Compute/virtualMachines, use:
{
resourceType = "Microsoft.Compute/virtualMachines"
tags = {
{customized property} = "string"
}
targetAvailabilitySetId = "string"
targetAvailabilityZone = "string"
targetVmSize = "string"
userManagedIdentities = [
"string"
]
}
For Microsoft.KeyVault/vaults, use:
{
resourceType = "Microsoft.KeyVault/vaults"
}
For Microsoft.Network/loadBalancers, use:
{
backendAddressPools = [
{
name = "string"
}
]
frontendIPConfigurations = [
{
name = "string"
privateIpAddress = "string"
privateIpAllocationMethod = "string"
subnet = {
name = "string"
sourceArmResourceId = "string"
}
zones = "string"
}
]
resourceType = "Microsoft.Network/loadBalancers"
sku = "string"
tags = {
{customized property} = "string"
}
zones = "string"
}
For Microsoft.Network/networkInterfaces, use:
{
enableAcceleratedNetworking = bool
ipConfigurations = [
{
loadBalancerBackendAddressPools = [
{
name = "string"
sourceArmResourceId = "string"
}
]
loadBalancerNatRules = [
{
name = "string"
sourceArmResourceId = "string"
}
]
name = "string"
primary = bool
privateIpAddress = "string"
privateIpAllocationMethod = "string"
publicIp = {
sourceArmResourceId = "string"
}
subnet = {
name = "string"
sourceArmResourceId = "string"
}
}
]
resourceType = "Microsoft.Network/networkInterfaces"
tags = {
{customized property} = "string"
}
}
For Microsoft.Network/networkSecurityGroups, use:
{
resourceType = "Microsoft.Network/networkSecurityGroups"
securityRules = [
{
access = "string"
description = "string"
destinationAddressPrefix = "string"
destinationPortRange = "string"
direction = "string"
name = "string"
priority = int
protocol = "string"
sourceAddressPrefix = "string"
sourcePortRange = "string"
}
]
tags = {
{customized property} = "string"
}
}
For Microsoft.Network/publicIPAddresses, use:
{
domainNameLabel = "string"
fqdn = "string"
publicIpAllocationMethod = "string"
resourceType = "Microsoft.Network/publicIPAddresses"
sku = "string"
tags = {
{customized property} = "string"
}
zones = "string"
}
For Microsoft.Network/virtualNetworks, use:
{
addressSpace = [
"string"
]
dnsServers = [
"string"
]
enableDdosProtection = bool
resourceType = "Microsoft.Network/virtualNetworks"
subnets = [
{
addressPrefix = "string"
name = "string"
networkSecurityGroup = {
sourceArmResourceId = "string"
}
}
]
tags = {
{customized property} = "string"
}
}
For Microsoft.Sql/servers, use:
{
resourceType = "Microsoft.Sql/servers"
}
For Microsoft.Sql/servers/databases, use:
{
resourceType = "Microsoft.Sql/servers/databases"
tags = {
{customized property} = "string"
}
zoneRedundant = "string"
}
For Microsoft.Sql/servers/elasticPools, use:
{
resourceType = "Microsoft.Sql/servers/elasticPools"
tags = {
{customized property} = "string"
}
zoneRedundant = "string"
}
For resourceGroups, use:
{
resourceType = "resourceGroups"
}
Property Values
Microsoft.Migrate/moveCollections/moveResources
| Name | Description | Value |
|---|---|---|
| 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: moveCollections |
| properties | Defines the move resource properties. | MoveResourceProperties |
| type | The resource type | "Microsoft.Migrate/moveCollections/moveResources@2023-08-01" |
AvailabilitySetResourceSettings
| Name | Description | Value |
|---|---|---|
| faultDomain | Gets or sets the target fault domain. | int Constraints: Min value = 1 |
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Compute/availabilitySets' (required) |
| tags | Gets or sets the Resource tags. | AvailabilitySetResourceSettingsTags |
| updateDomain | Gets or sets the target update domain. | int Constraints: Min value = 1 Max value = 20 |
AvailabilitySetResourceSettingsTags
| Name | Description | Value |
|---|
DiskEncryptionSetResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Compute/diskEncryptionSets' (required) |
KeyVaultResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.KeyVault/vaults' (required) |
LBBackendAddressPoolResourceSettings
| Name | Description | Value |
|---|---|---|
| name | Gets or sets the backend address pool name. | string |
LBFrontendIPConfigurationResourceSettings
| Name | Description | Value |
|---|---|---|
| name | Gets or sets the frontend IP configuration name. | string |
| privateIpAddress | Gets or sets the IP address of the Load Balancer.This is only specified if a specific private IP address shall be allocated from the subnet specified in subnetRef. |
string |
| privateIpAllocationMethod | Gets or sets PrivateIP allocation method (Static/Dynamic). | string |
| subnet | Defines reference to subnet. | SubnetReference |
| zones | Gets or sets the csv list of zones. | string |
LoadBalancerBackendAddressPoolReference
| Name | Description | Value |
|---|---|---|
| name | Gets the name of the proxy resource on the target side. | string |
| sourceArmResourceId | Gets the ARM resource ID of the tracked resource being referenced. | string (required) |
LoadBalancerNatRuleReference
| Name | Description | Value |
|---|---|---|
| name | Gets the name of the proxy resource on the target side. | string |
| sourceArmResourceId | Gets the ARM resource ID of the tracked resource being referenced. | string (required) |
LoadBalancerResourceSettings
| Name | Description | Value |
|---|---|---|
| backendAddressPools | Gets or sets the backend address pools of the load balancer. | LBBackendAddressPoolResourceSettings[] |
| frontendIPConfigurations | Gets or sets the frontend IP configurations of the load balancer. | LBFrontendIPConfigurationResourceSettings[] |
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Network/loadBalancers' (required) |
| sku | Gets or sets load balancer sku (Basic/Standard). | string |
| tags | Gets or sets the Resource tags. | LoadBalancerResourceSettingsTags |
| zones | Gets or sets the csv list of zones common for all frontend IP configurations. Note this is given precedence only if frontend IP configurations settings are not present. |
string |
LoadBalancerResourceSettingsTags
| Name | Description | Value |
|---|
MoveResourceDependencyOverride
| Name | Description | Value |
|---|---|---|
| id | Gets or sets the ARM ID of the dependent resource. | string |
| targetId | Gets or sets the resource ARM id of either the MoveResource or the resource ARM ID of the dependent resource. |
string |
MoveResourceProperties
| Name | Description | Value |
|---|---|---|
| dependsOnOverrides | Gets or sets the move resource dependencies overrides. | MoveResourceDependencyOverride[] |
| existingTargetId | Gets or sets the existing target ARM Id of the resource. | string |
| resourceSettings | Gets or sets the resource settings. | ResourceSettings |
| sourceId | Gets or sets the Source ARM Id of the resource. | string (required) |
NetworkInterfaceResourceSettings
| Name | Description | Value |
|---|---|---|
| enableAcceleratedNetworking | Gets or sets a value indicating whether accelerated networking is enabled. | bool |
| ipConfigurations | Gets or sets the IP configurations of the NIC. | NicIpConfigurationResourceSettings[] |
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Network/networkInterfaces' (required) |
| tags | Gets or sets the Resource tags. | NetworkInterfaceResourceSettingsTags |
NetworkInterfaceResourceSettingsTags
| Name | Description | Value |
|---|
NetworkSecurityGroupResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Network/networkSecurityGroups' (required) |
| securityRules | Gets or sets Security rules of network security group. | NsgSecurityRule[] |
| tags | Gets or sets the Resource tags. | NetworkSecurityGroupResourceSettingsTags |
NetworkSecurityGroupResourceSettingsTags
| Name | Description | Value |
|---|
NicIpConfigurationResourceSettings
| Name | Description | Value |
|---|---|---|
| loadBalancerBackendAddressPools | Gets or sets the references of the load balancer backend address pools. | LoadBalancerBackendAddressPoolReference[] |
| loadBalancerNatRules | Gets or sets the references of the load balancer NAT rules. | LoadBalancerNatRuleReference[] |
| name | Gets or sets the IP configuration name. | string |
| primary | Gets or sets a value indicating whether this IP configuration is the primary. | bool |
| privateIpAddress | Gets or sets the private IP address of the network interface IP Configuration. | string |
| privateIpAllocationMethod | Gets or sets the private IP address allocation method. | string |
| publicIp | Defines reference to a public IP. | PublicIpReference |
| subnet | Defines reference to subnet. | SubnetReference |
NsgReference
| Name | Description | Value |
|---|---|---|
| sourceArmResourceId | Gets the ARM resource ID of the tracked resource being referenced. | string (required) |
NsgSecurityRule
| Name | Description | Value |
|---|---|---|
| access | Gets or sets whether network traffic is allowed or denied. Possible values are “Allow” and “Deny”. |
string |
| description | Gets or sets a description for this rule. Restricted to 140 chars. | string |
| destinationAddressPrefix | Gets or sets destination address prefix. CIDR or source IP range. A “*” can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. |
string |
| destinationPortRange | Gets or sets Destination Port or Range. Integer or range between 0 and 65535. A “*” can also be used to match all ports. |
string |
| direction | Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outgoing traffic. |
string |
| name | Gets or sets the Security rule name. | string |
| priority | Gets or sets the priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. |
int |
| protocol | Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). | string |
| sourceAddressPrefix | Gets or sets source address prefix. CIDR or source IP range. A “*” can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. If this is an ingress rule, specifies where network traffic originates from. |
string |
| sourcePortRange | Gets or sets Source Port or Range. Integer or range between 0 and 65535. A “*” can also be used to match all ports. |
string |
PublicIPAddressResourceSettings
| Name | Description | Value |
|---|---|---|
| domainNameLabel | Gets or sets the domain name label. | string |
| fqdn | Gets or sets the fully qualified domain name. | string |
| publicIpAllocationMethod | Gets or sets public IP allocation method. | string |
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Network/publicIPAddresses' (required) |
| sku | Gets or sets public IP sku. | string |
| tags | Gets or sets the Resource tags. | PublicIPAddressResourceSettingsTags |
| zones | Gets or sets public IP zones. | string |
PublicIPAddressResourceSettingsTags
| Name | Description | Value |
|---|
PublicIpReference
| Name | Description | Value |
|---|---|---|
| sourceArmResourceId | Gets the ARM resource ID of the tracked resource being referenced. | string (required) |
ResourceGroupResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'resourceGroups' (required) |
ResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | Set to 'Microsoft.Compute/availabilitySets' for type AvailabilitySetResourceSettings. Set to 'Microsoft.Compute/diskEncryptionSets' for type DiskEncryptionSetResourceSettings. Set to 'Microsoft.Compute/virtualMachines' for type VirtualMachineResourceSettings. Set to 'Microsoft.KeyVault/vaults' for type KeyVaultResourceSettings. Set to 'Microsoft.Network/loadBalancers' for type LoadBalancerResourceSettings. Set to 'Microsoft.Network/networkInterfaces' for type NetworkInterfaceResourceSettings. Set to 'Microsoft.Network/networkSecurityGroups' for type NetworkSecurityGroupResourceSettings. Set to 'Microsoft.Network/publicIPAddresses' for type PublicIPAddressResourceSettings. Set to 'Microsoft.Network/virtualNetworks' for type VirtualNetworkResourceSettings. Set to 'Microsoft.Sql/servers' for type SqlServerResourceSettings. Set to 'Microsoft.Sql/servers/databases' for type SqlDatabaseResourceSettings. Set to 'Microsoft.Sql/servers/elasticPools' for type SqlElasticPoolResourceSettings. Set to 'resourceGroups' for type ResourceGroupResourceSettings. | 'Microsoft.Compute/availabilitySets' 'Microsoft.Compute/diskEncryptionSets' 'Microsoft.Compute/virtualMachines' 'Microsoft.KeyVault/vaults' 'Microsoft.Network/loadBalancers' 'Microsoft.Network/networkInterfaces' 'Microsoft.Network/networkSecurityGroups' 'Microsoft.Network/publicIPAddresses' 'Microsoft.Network/virtualNetworks' 'Microsoft.Sql/servers' 'Microsoft.Sql/servers/databases' 'Microsoft.Sql/servers/elasticPools' 'resourceGroups' (required) |
| targetResourceGroupName | Gets or sets the target resource group name. | string |
| targetResourceName | Gets or sets the target Resource name. | string |
SqlDatabaseResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Sql/servers/databases' (required) |
| tags | Gets or sets the Resource tags. | SqlDatabaseResourceSettingsTags |
| zoneRedundant | Defines the zone redundant resource setting. | 'Disable' 'Enable' |
SqlDatabaseResourceSettingsTags
| Name | Description | Value |
|---|
SqlElasticPoolResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Sql/servers/elasticPools' (required) |
| tags | Gets or sets the Resource tags. | SqlElasticPoolResourceSettingsTags |
| zoneRedundant | Defines the zone redundant resource setting. | 'Disable' 'Enable' |
SqlElasticPoolResourceSettingsTags
| Name | Description | Value |
|---|
SqlServerResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Sql/servers' (required) |
SubnetReference
| Name | Description | Value |
|---|---|---|
| name | Gets the name of the proxy resource on the target side. | string |
| sourceArmResourceId | Gets the ARM resource ID of the tracked resource being referenced. | string (required) |
SubnetResourceSettings
| Name | Description | Value |
|---|---|---|
| addressPrefix | Gets or sets address prefix for the subnet. | string |
| name | Gets or sets the Subnet name. | string |
| networkSecurityGroup | Defines reference to NSG. | NsgReference |
VirtualMachineResourceSettings
| Name | Description | Value |
|---|---|---|
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Compute/virtualMachines' (required) |
| tags | Gets or sets the Resource tags. | VirtualMachineResourceSettingsTags |
| targetAvailabilitySetId | Gets or sets the target availability set id for virtual machines not in an availability set at source. | string |
| targetAvailabilityZone | Gets or sets the target availability zone. | '1' '2' '3' 'NA' |
| targetVmSize | Gets or sets the target virtual machine size. | string |
| userManagedIdentities | Gets or sets user-managed identities | string[] |
VirtualMachineResourceSettingsTags
| Name | Description | Value |
|---|
VirtualNetworkResourceSettings
| Name | Description | Value |
|---|---|---|
| addressSpace | Gets or sets the address prefixes for the virtual network. | string[] |
| dnsServers | Gets or sets DHCPOptions that contains an array of DNS servers available to VMs deployed in the virtual network. |
string[] |
| enableDdosProtection | Gets or sets a value indicating whether gets or sets whether the DDOS protection should be switched on. |
bool |
| resourceType | The resource type. For example, the value can be Microsoft.Compute/virtualMachines. | 'Microsoft.Network/virtualNetworks' (required) |
| subnets | Gets or sets List of subnets in a VirtualNetwork. | SubnetResourceSettings[] |
| tags | Gets or sets the Resource tags. | VirtualNetworkResourceSettingsTags |
VirtualNetworkResourceSettingsTags
| Name | Description | Value |
|---|