Share via

Microsoft.Migrate migrateProjects

Bicep resource definition

The migrateProjects 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/migrateProjects resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Migrate/migrateProjects@2023-01-01' = {
  eTag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    publicNetworkAccess: 'string'
    serviceEndpoint: 'string'
    utilityStorageAccountId: 'string'
  }
}

Property Values

Microsoft.Migrate/migrateProjects

Name Description Value
eTag For optimistic concurrency control. string
location Azure location in which project is created. string
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9-]{3,24}$ (required)
properties Properties of a migrate project. MigrateProjectProperties

MigrateProjectProperties

Name Description Value
publicNetworkAccess Gets or sets the state of public network access. 'Disabled'
'Enabled'
'NotSpecified'
serviceEndpoint Service endpoint. string
utilityStorageAccountId Utility storage account id. string

Usage Examples

Bicep Samples

A basic example of deploying Migrate Projects.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource project 'Microsoft.Migrate/migrateProjects@2020-05-01' = {
  name: resourceName
  location: location
  properties: {
    publicNetworkAccess: 'Enabled'
    utilityStorageAccountId: storageAccount.id
  }
}

resource storageAccount 'Microsoft.Storage/storageAccounts@2021-09-01' = {
  name: resourceName
  location: location
  kind: 'StorageV2'
  properties: {
    accessTier: 'Hot'
    allowBlobPublicAccess: true
    allowCrossTenantReplication: true
    allowSharedKeyAccess: true
    defaultToOAuthAuthentication: false
    encryption: {
      keySource: 'Microsoft.Storage'
      services: {
        queue: {
          keyType: 'Service'
        }
        table: {
          keyType: 'Service'
        }
      }
    }
    isHnsEnabled: false
    isNfsV3Enabled: false
    isSftpEnabled: false
    minimumTlsVersion: 'TLS1_2'
    networkAcls: {
      defaultAction: 'Allow'
    }
    publicNetworkAccess: 'Enabled'
    supportsHttpsTrafficOnly: true
  }
  sku: {
    name: 'Standard_LRS'
  }
}

ARM template resource definition

The migrateProjects 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/migrateProjects resource, add the following JSON to your template.

{
  "type": "Microsoft.Migrate/migrateProjects",
  "apiVersion": "2023-01-01",
  "name": "string",
  "eTag": "string",
  "location": "string",
  "properties": {
    "publicNetworkAccess": "string",
    "serviceEndpoint": "string",
    "utilityStorageAccountId": "string"
  }
}

Property Values

Microsoft.Migrate/migrateProjects

Name Description Value
apiVersion The api version '2023-01-01'
eTag For optimistic concurrency control. string
location Azure location in which project is created. string
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9-]{3,24}$ (required)
properties Properties of a migrate project. MigrateProjectProperties
type The resource type 'Microsoft.Migrate/migrateProjects'

MigrateProjectProperties

Name Description Value
publicNetworkAccess Gets or sets the state of public network access. 'Disabled'
'Enabled'
'NotSpecified'
serviceEndpoint Service endpoint. string
utilityStorageAccountId Utility storage account id. string

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Create an Azure Migrate project

Deploy to Azure		 This template creates an Azure Migrate project that will be used for discovering, assessing and migrating servers, apps, data

Terraform (AzAPI provider) resource definition

The migrateProjects 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.Migrate/migrateProjects resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Migrate/migrateProjects@2023-01-01"
  name = "string"
  parent_id = "string"
  location = "string"
  body = {
    eTag = "string"
    properties = {
      publicNetworkAccess = "string"
      serviceEndpoint = "string"
      utilityStorageAccountId = "string"
    }
  }
}

Property Values

Microsoft.Migrate/migrateProjects

Name Description Value
eTag For optimistic concurrency control. string
location Azure location in which project is created. string
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9-]{3,24}$ (required)
properties Properties of a migrate project. MigrateProjectProperties
type The resource type "Microsoft.Migrate/migrateProjects@2023-01-01"

MigrateProjectProperties

Name Description Value
publicNetworkAccess Gets or sets the state of public network access. 'Disabled'
'Enabled'
'NotSpecified'
serviceEndpoint Service endpoint. string
utilityStorageAccountId Utility storage account id. string

Usage Examples

Terraform Samples

A basic example of deploying Migrate Projects.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}


resource "azapi_resource" "storageAccount" {
  type      = "Microsoft.Storage/storageAccounts@2021-09-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "StorageV2"
    properties = {
      accessTier                   = "Hot"
      allowBlobPublicAccess        = true
      allowCrossTenantReplication  = true
      allowSharedKeyAccess         = true
      defaultToOAuthAuthentication = false
      encryption = {
        keySource = "Microsoft.Storage"
        services = {
          queue = {
            keyType = "Service"
          }
          table = {
            keyType = "Service"
          }
        }
      }
      isHnsEnabled      = false
      isNfsV3Enabled    = false
      isSftpEnabled     = false
      minimumTlsVersion = "TLS1_2"
      networkAcls = {
        defaultAction = "Allow"
      }
      publicNetworkAccess      = "Enabled"
      supportsHttpsTrafficOnly = true
    }
    sku = {
      name = "Standard_LRS"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}



resource "azapi_resource" "project" {
  type      = "Microsoft.Migrate/migrateProjects@2020-05-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      publicNetworkAccess     = "Enabled"
      utilityStorageAccountId = azapi_resource.storageAccount.id
    }
  }
}
  • Last updated on