Importing Azure Infrastructure

Create initial resources

To start, login to the Azure Console and follow the instructions in the official Microsoft documentation to create a new Storage Account. Then, login to the Pulumi CLI and ensure it is configured to use your Azure account.

Next, create a new project and stack that will be used to hold the resource definition for your imported resources.

# Example using Python
$ mkdir pulumi-tutorial-import
$ cd pulumi-tutorial-import
$ pulumi new python

This tutorial will define resources using the Azure Native provider, so you will also need to make sure to install the Azure Native dependency into your project.

Importing a resource

In Pulumi, there are three paths to take when importing resources:

• the pulumi import CLI command for individual resources
• the pulumi import CLI command with a special JSON file for bulk import
• an import option in your Pulumi program code.

Import using the CLI

The pulumi import command looks up the resource using the specified type token and resource identifier, adds the resource to the stack’s current state, and emits the code required to manage the resource with Pulumi from that point forward. This option requires the least manual effort, so it is generally recommended and best suited to projects consisting consisting of only one stack.

To import an existing cloud resource with the Pulumi CLI, use the following syntax:

$ pulumi import <type> <name> <id>

• The first argument, type, is the Pulumi type token to use for the imported resource. You can find the type token for a given resource by navigating to the Import section of the resource’s API documentation in the Pulumi Registry. For example, the type token of an Azure Storage Account resource is azure-native:storage:StorageAccount.

  

• The second argument, name, is the resource name to apply to the resource once it’s imported.

• The third argument, id, corresponds to the value you would use in Pulumi to lookup the resource in the cloud provider. This value should correspond to the designated lookup property specified in the Import section of the resource’s API documentation in the Registry. In the case of an Azure Storage Account, this would be:

  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}
  

  The subscriptionId parameter refers to your Azure subscription ID, the resourceGroupName parameter refers to the name of the resource group that the Storage Account lives in, and the accountName parameter refers to the name of your Storage Account.

When put all together, the import command should look something like the following example, where imported-storage-account is the resource name that will be applied to the Storage Account once imported.

$ pulumi import azure-native:storage:StorageAccount \
imported-storage-account \
/subscriptions/0282681f.../resourceGroups/pulumi-tutorials/providers/Microsoft.Storage/storageAccounts/tutorialstorageacct

The output should look something like the following:

$ pulumi import azure-native:storage:StorageAccount \
imported-storage-account \
/subscriptions/0282681f..../resourceGroups/pulumi-tutorials/providers/Microsoft.Storage/storageAccounts/tutorialstorageacct

Previewing import (dev)

     Type                                    Name                      Plan
 +   pulumi:pulumi:Stack                     dev                       create
 =   └─ azure-native:storage:StorageAccount  imported-storage-account  import

Resources:
    + 1 to create
    = 1 to import
    2 changes

Do you want to perform this import?  [Use arrows to move, type to filter]
> yes
  no
  details

Notice the equals sign (=) instead of our usual plus sign (+) in the resource table and in the details. This is Pulumi’s way of telling you that it’s adding something to the state without modifying it.

Choose yes to complete the import. This will immediately add the resource to the current stack’s state and will emit a block of code to STDOUT to be added to your Pulumi program. If the current program were written in Python, for example, the resulting CLI output would resemble the following:

...
Importing (dev)

     Type                                    Name                      Status
 +   pulumi:pulumi:Stack                     dev                       created
 =   └─ azure-native:storage:StorageAccount  imported-storage-account  imported (2s)

Resources:
    + 1 created
    = 1 imported
    2 changes

Duration: 4s

Please copy the following code into your Pulumi application. Not doing so
will cause Pulumi to report that an update will happen on the next update command.

Please note that the imported resources are marked as protected. To destroy them
you will need to remove the `protect` option and run `pulumi update` *before*
the destroy will take effect.

import pulumi
import pulumi_azure_native as azure_native

imported_storage_account = azure_native.storage.StorageAccount("imported-storage-account",
    access_tier=azure_native.storage.AccessTier.HOT,
    account_name="tutorialstorageacct",
    allow_blob_public_access=False,
    allow_cross_tenant_replication=False,
    allow_shared_key_access=True,
    default_to_o_auth_authentication=False,
    dns_endpoint_type=azure_native.storage.DnsEndpointType.STANDARD,
    enable_https_traffic_only=True,
    encryption={
        "key_source": azure_native.storage.KeySource.MICROSOFT_STORAGE,
        "require_infrastructure_encryption": False,
        "services": {
            "blob": {
                "enabled": True,
                "key_type": azure_native.storage.KeyType.ACCOUNT,
            },
            "file": {
                "enabled": True,
                "key_type": azure_native.storage.KeyType.ACCOUNT,
            },
        },
    },
    kind=azure_native.storage.Kind.STORAGE_V2,
    large_file_shares_state=azure_native.storage.LargeFileSharesState.ENABLED,
    location="northcentralus",
    minimum_tls_version=azure_native.storage.MinimumTlsVersion.TLS1_2,
    network_rule_set={
        "bypass": azure_native.storage.Bypass.AZURE_SERVICES,
        "default_action": azure_native.storage.DefaultAction.ALLOW,
    },
    public_network_access=azure_native.storage.PublicNetworkAccess.ENABLED,
    resource_group_name="pulumi-tutorials",
    sku={
        "name": azure_native.storage.SkuName.STANDARD_RAGRS,
    },
    opts = pulumi.ResourceOptions(protect=True))

Next, copy the emitted code snippet and replace the contents of your Pulumi program file with it. Then, save the file and run pulumi up. You should see that the update produces no changes:

$ pulumi up

Previewing update (dev)

     Type                 Name                     Plan
     pulumi:pulumi:Stack  dev

Resources:
    2 unchanged

Do you want to perform this update? yes

Updating (dev)

     Type                 Name                     Status
     pulumi:pulumi:Stack  dev

Resources:
    2 unchanged

Duration: 2s

The resource is now under management with Pulumi!

Import in bulk

The pulumi import command also enables you to import resources in bulk for scenarios in which you need to bring multiple resources under management with Pulumi. To do so, you will need to create a JSON file that has all of the required information for each resource: a type, a desired name, and an id.

To start, return to the Azure console and create two additional Storage Accounts. Next, return to your program folder and create a new file called resources.json. Inside of this file, copy and paste the following JSON object, making sure to replace the values of the id parameters with the actual values for your environment:

{
    "resources": [
        {
            "type": "azure-native:storage:StorageAccount",
            "name": "second-imported-storage-account",
            "id": "/subscriptions/0282681f..../resourceGroups/pulumi-tutorials/providers/Microsoft.Storage/storageAccounts/tutorialstorageacct2" # REPLACE
        },
        {
            "type": "azure-native:storage:StorageAccount",
            "name": "third-imported-storage-account",
            "id": "/subscriptions/0282681f..../resourceGroups/pulumi-tutorials/providers/Microsoft.Storage/storageAccounts/tutorialstorageacct3" # REPLACE
        }
    ]
}

To import these resources, save the file and then run the pulumi import command with the -f flag, passing in the path to the resources.json file:

$ pulumi import -f ./resources.json

Previewing import (dev)

     Type                                    Name                             Plan
 +   pulumi:pulumi:Stack                     dev                              create
 =   ├─ azure-native:storage:StorageAccount  second-imported-storage-account  import
 =   └─ azure-native:storage:StorageAccount  third-imported-storage-account   import

Resources:
    = 2 to import
    2 unchanged

Do you want to perform this import? yes

Importing (dev)

     Type                                    Name                               Status
     pulumi:pulumi:Stack                     dev
 =   ├─ azure-native:storage:StorageAccount  second-imported-storage-account    imported (1s)
 =   └─ azure-native:storage:StorageAccount  third-imported-storage-account     imported (2s)

Resources:
    = 2 imported
    2 unchanged

Duration: 6s

Please copy the following code into your Pulumi application. Not doing so
will cause Pulumi to report that an update will happen on the next update command.

Please note that the imported resources are marked as protected. To destroy them
you will need to remove the `protect` option and run `pulumi update` *before*
the destroy will take effect.

# Code begins here...

Just like when running the command against a single resource, the pulumi import command will import the resources into your stack’s state file and will generate the code snippets for all of the resources in the JSON file. Once again, copy the generated code for the two new resources into your existing program file, save the file, and run the pulumi up command to bring these new resources under the management of Pulumi.

Import using code

The third method to import existing cloud resources into a Pulumi project is by defining the resource code yourself and configuring the import resource option in the resource’s definition. This approach may be better suited for scenarios that require importing multiple resources of the same type across multiple stacks and/or deployment environments as part of an automation workflow.

To demonstrate, you will start by creating a simple Resource Group in the Azure portal. Once that is complete, you will need to identify the lookup property of the Resource Group resource. To do so, navigate to the Import section of the Azure Native Resource Group resource page in the Pulumi documentation. You will notice that the lookup property is the following:

/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}

Now, navigate to your program code file and update the code with the following resource definition, making sure to replace the value of the resource group name variable with the name of your own resource group:

"use strict";
const pulumi = require("@pulumi/pulumi");
const azure = require("@pulumi/azure-native");
const resources = require("@pulumi/azure-native/resources");

async function importResourceGroup() {
    const clientConfig = await azure.authorization.getClientConfig();
    const subscriptionId = clientConfig.subscriptionId;
    const resourceGroupName = new pulumi.Config().get("resourceGroupName"); // REPLACE
    const lookupProp = `/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}`;

    const importedResourceGroup = new resources.ResourceGroup(
        "imported-rg",
        {},
        {
            import: lookupProp,
        },
    );

    return importedResourceGroup;
}

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure-native";
import * as resources from "@pulumi/azure-native/resources";

async function createResourceGroup() {
    const clientConfig = await azure.authorization.getClientConfig();
    const subscriptionId = clientConfig.subscriptionId;
    const resourceGroupName = new pulumi.Config().get("resourceGroupName"); // REPLACE
    const lookupProp = `/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}`;

    const importedResourceGroup = new resources.ResourceGroup(
        "imported-rg",
        {},
        {
            import: lookupProp,
        },
    );

    return importedResourceGroup;
}

import pulumi
import pulumi_azure_native as azure_native

client_config = azure_native.authorization.get_client_config()
subscription_id = client_config.subscription_id
resource_group_name = pulumi.Config().get("resourceGroupName") # REPLACE
lookup_prop = f"/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}"

imported_resource_group = azure_native.resources.ResourceGroup("imported-rg",
    opts = pulumi.ResourceOptions(import_= lookup_prop)
)

package main

import (
    "fmt"
    "github.com/pulumi/pulumi-azure-native/sdk/go/azure/authorization"
    "github.com/pulumi/pulumi-azure-native/sdk/go/azure/resources"
    "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    "github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        clientConfig, err := authorization.GetClientConfig(ctx, nil)
        if err != nil {
            return err
        }

        conf := config.New(ctx, "")
        resourceGroupName := conf.Require("resourceGroupName") // REPLACE
        lookupProp := fmt.Sprintf("/subscriptions/%s/resourceGroups/%s", clientConfig.SubscriptionId, resourceGroupName)

        _, err = resources.NewResourceGroup(ctx, "imported-rg", &resources.ResourceGroupArgs{}, 
			pulumi.Import(pulumi.ID(lookupProp)))
        if err != nil {
            return err
        }
        return nil
    })
}

using Pulumi;
using Pulumi.AzureNative.Resources;
using Pulumi.AzureNative.Authorization;

return await Pulumi.Deployment.RunAsync(async () =>
{
    var clientConfig = await GetClientConfig.InvokeAsync();
    var subscriptionId = clientConfig.SubscriptionId;
    var resourceGroupName = new Config().Get("resourceGroupName"); // REPLACE
    var lookupProp = $"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}";

    var importedResourceGroup = new ResourceGroup("imported-rg", new(),
        new CustomResourceOptions { ImportId = lookupProp }
    );
});

name: azure-native-import-resource-group-yaml
description: An example that provides the code to import an existing resource group from Azure.
runtime: yaml

variables:
  resourceGroupName: pulumi-tutorials # REPLACE

  clientConfig:
    fn::invoke:
      function: azure-native:authorization:getClientConfig

  importPath: /subscriptions/${clientConfig.subscriptionId}/resourceGroups/${resourceGroupName}

resources:
  importedResourceGroup:
    type: azure-native:resources:ResourceGroup
    properties:
      location: eastus
    options:
      import: ${importPath}

As you can see, the lookup property of the Resource Goup resource has been provided as the value of the import option in the resource definition.

At this point, the definition for the imported resources has only been written, meaning it has not yet been imported into your project’s state and is therefore not yet under management by Pulumi. To complete the import process using this method, you will need to save your file and run the pulumi up command. You should see output resembling the following example:

$ pulumi up -y
Previewing update (dev)

     Type                                     Name                  Plan
 +   pulumi:pulumi:Stack                      dev                   create
 =   └─ azure-native:resources:ResourceGroup  imported-rg           import

Resources:
    + 1 to create
    = 1 to import
    2 changes

Updating (zephyr/static-website)

     Type                                     Name                  Status
 +   pulumi:pulumi:Stack                      dev                   created (4s)
 =   └─ azure-native:resources:ResourceGroup  imported-rg           imported (2s)

Resources:
    + 1 created
    = 1 imported
    2 changes

Duration: 6s

It is important to note that when defining resources that you want to import using the import resource option method, the resource definition must match all properties of the existing resource. If you fail to include all of the existing properties, you will run into an error similar to the following:

Previewing update (dev)

     Type                                     Name           Plan       Info
 +   pulumi:pulumi:Stack                      dev            create
 =   └─ azure-native:resources:ResourceGroup  imported-rg    import     [diff: -tags]; 1 warning

Diagnostics:
  azure-native:resources:ResourceGroup (imported-rg):
    warning: inputs to import do not match the existing resource; importing this resource will fail

Resources:
    + 1 to create
    = 1 to import
    2 changes

Updating (dev)

     Type                                        Name           Status                       Info
 +   pulumi:pulumi:Stack                         dev            **creating failed (5s)**     1 error
 =   └─ azure-native:resources:ResourceGroup     imported-rg    **importing failed**         1 error

Diagnostics:
  azure-native:resources:ResourceGroup (imported-rg):
    error: inputs to import do not match the existing resource

  pulumi:pulumi:Stack (dev):
    error: update failed

Resources:
    + 1 created

Duration: 7s

The highlighted line in the preview section of the output indicates which property of the existing resource is missing in the resource definition. You can use this to correct your resource definition before re-deploying. Once a resource is successfully imported, make sure to remove the import option from your code because Pulumi is now managing the resource.

Clean-up

Before moving on, tear down the resources that are part of your stack to avoid incurring any charges.

1. Run pulumi destroy to tear down all resources. You'll be prompted to make sure you really want to delete these resources. A destroy operation may take some time, since Pulumi waits for the resources to finish shutting down before it considers the destroy operation to be complete.
2. To delete the stack itself, run pulumi stack rm. Note that this command deletes all deployment history from the Pulumi Service.

Next steps

In this tutorial, you imported existing cloud resources via the CLI and updated the program code to include the definition of those imported resources. You also imported existing cloud resources by manually defining the resource definition using the import resource option method.

To learn more about creating and managing resources in Pulumi, take a look a the following resources:

• Learn more about importing resources in Pulumi in the Adopting Pulumi -> Import resources documentation.
• Learn more about migrating to Pulumi in the Migrating from other solutions to Pulumi documentation.
• Learn more about other useful Pulumi CLI commands in the Pulumi CLI overview documentation.