Deployments - Create Or Update

Service:: Resource Management

API Version:: 2025-04-01

Deploys resources to a resource group.
You can provide the template and parameters directly in the request or link to JSON files.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2025-04-01

URI Parameters

Name	In	Required	Type	Description
deploymentName	path	True	string minLength: 1 maxLength: 64 pattern: ^[-\w\._]+$	The name of the deployment.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	The name of the resource group to deploy the resources to. The name is case insensitive. The resource group must already exist.
subscriptionId	path	True	string	The Microsoft Azure subscription ID.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Required	Type	Description
properties	True	DeploymentProperties	The deployment properties.
identity		DeploymentIdentity	The Managed Identity configuration for a deployment.
___location		string	The ___location to store the deployment data.
tags		object	Deployment tags

Responses

Name	Type	Description
200 OK	DeploymentExtended	OK - Returns information about the deployment, including provisioning status.
201 Created	DeploymentExtended	Created - Returns information about the deployment, including provisioning status.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Create a deployment that will deploy a template with a uri and queryString

Create a deployment that will deploy a templateSpec with the given resourceId

Create a deployment that will redeploy another deployment on failure

Create a deployment that will redeploy the last successful deployment on failure

Create deployment using external inputs

Create a deployment that will deploy a template with a uri and queryString

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000001/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment?api-version=2025-04-01

{
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json",
      "queryString": "sv=2019-02-02&st=2019-04-29T22%3A18%3A26Z&se=2019-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=xxxxxxxx0xxxxxxxxxxxxx%2bxxxxxxxxxxxxxxxxxxxx%3d"
    },
    "parameters": {},
    "mode": "Incremental"
  }
}


import com.azure.resourcemanager.resources.fluent.models.DeploymentInner;
import com.azure.resourcemanager.resources.models.DeploymentMode;
import com.azure.resourcemanager.resources.models.DeploymentProperties;
import com.azure.resourcemanager.resources.models.TemplateLink;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Deployments CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/
     * PutDeploymentResourceGroup.json
     */
    /**
     * Sample code: Create a deployment that will deploy a template with a uri and queryString.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createADeploymentThatWillDeployATemplateWithAUriAndQueryString(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().deploymentClient().getDeployments().createOrUpdate("my-resource-group",
            "my-deployment",
            new DeploymentInner().withProperties(new DeploymentProperties().withTemplateLink(
                new TemplateLink().withUri("https://example.com/exampleTemplate.json").withQueryString(
                    "sv=2019-02-02&st=2019-04-29T22%3A18%3A26Z&se=2019-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=xxxxxxxx0xxxxxxxxxxxxx%2bxxxxxxxxxxxxxxxxxxxx%3d"))
                .withParameters(mapOf()).withMode(DeploymentMode.INCREMENTAL)),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource.deployments import DeploymentsMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource-deployments
# USAGE
    python put_deployment_resource_group.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DeploymentsMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000001",
    )

    response = client.deployments.begin_create_or_update(
        resource_group_name="my-resource-group",
        deployment_name="my-deployment",
        parameters={
            "properties": {
                "mode": "Incremental",
                "parameters": {},
                "templateLink": {
                    "queryString": "sv=2019-02-02&st=2019-04-29T22%3A18%3A26Z&se=2019-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=xxxxxxxx0xxxxxxxxxxxxx%2bxxxxxxxxxxxxxxxxxxxx%3d",
                    "uri": "https://example.com/exampleTemplate.json",
                },
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentResourceGroup.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armdeployments_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armdeployments"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/edacc3b43f9603efa119eabb6013d952d1dbe7d6/specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentResourceGroup.json
func ExampleClient_BeginCreateOrUpdate_createADeploymentThatWillDeployATemplateWithAUriAndQueryString() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdeployments.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewClient().BeginCreateOrUpdate(ctx, "my-resource-group", "my-deployment", armdeployments.Deployment{
		Properties: &armdeployments.DeploymentProperties{
			Mode:       to.Ptr(armdeployments.DeploymentModeIncremental),
			Parameters: map[string]*armdeployments.DeploymentParameter{},
			TemplateLink: &armdeployments.TemplateLink{
				QueryString: to.Ptr("sv=2019-02-02&st=2019-04-29T22%3A18%3A26Z&se=2019-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=xxxxxxxx0xxxxxxxxxxxxx%2bxxxxxxxxxxxxxxxxxxxx%3d"),
				URI:         to.Ptr("https://example.com/exampleTemplate.json"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DeploymentExtended = armdeployments.DeploymentExtended{
	// 	Name: to.Ptr("my-deployment"),
	// 	Type: to.Ptr("Microsoft.Resources/deployments"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment"),
	// 	Properties: &armdeployments.DeploymentPropertiesExtended{
	// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		Dependencies: []*armdeployments.Dependency{
	// 		},
	// 		Duration: to.Ptr("PT22.8356799S"),
	// 		Mode: to.Ptr(armdeployments.DeploymentModeIncremental),
	// 		OutputResources: []*armdeployments.ResourceReference{
	// 			{
	// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/my-storage-account"),
	// 		}},
	// 		Parameters: map[string]any{
	// 		},
	// 		Providers: []*armdeployments.Provider{
	// 			{
	// 				Namespace: to.Ptr("Microsoft.Storage"),
	// 				ResourceTypes: []*armdeployments.ProviderResourceType{
	// 					{
	// 						Locations: []*string{
	// 							to.Ptr("eastus")},
	// 							ResourceType: to.Ptr("storageAccounts"),
	// 					}},
	// 			}},
	// 			ProvisioningState: to.Ptr(armdeployments.ProvisioningStateSucceeded),
	// 			TemplateHash: to.Ptr("0000000000000000000"),
	// 			TemplateLink: &armdeployments.TemplateLink{
	// 				ContentVersion: to.Ptr("1.0.0.0"),
	// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1"),
	// 			},
	// 			Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-05T01:20:01.723Z"); return t}()),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { DeploymentsClient } = require("@azure/arm-resourcesdeployments");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to You can provide the template and parameters directly in the request or link to JSON files.
 *
 * @summary You can provide the template and parameters directly in the request or link to JSON files.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentResourceGroup.json
 */
async function createADeploymentThatWillDeployATemplateWithAUriAndQueryString() {
  const subscriptionId =
    process.env["RESOURCES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000001";
  const resourceGroupName = process.env["RESOURCES_RESOURCE_GROUP"] || "my-resource-group";
  const deploymentName = "my-deployment";
  const parameters = {
    properties: {
      mode: "Incremental",
      parameters: {},
      templateLink: {
        queryString:
          "sv=2019-02-02&st=2019-04-29T22%3A18%3A26Z&se=2019-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=xxxxxxxx0xxxxxxxxxxxxx%2bxxxxxxxxxxxxxxxxxxxx%3d",
        uri: "https://example.com/exampleTemplate.json",
      },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new DeploymentsClient(credential, subscriptionId);
  const result = await client.deployments.beginCreateOrUpdateAndWait(
    resourceGroupName,
    deploymentName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "properties": {
    "templateLink": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
      "contentVersion": "1.0.0.0"
    },
    "templateHash": "0000000000000000000",
    "parameters": {},
    "mode": "Incremental",
    "provisioningState": "Succeeded",
    "timestamp": "2020-06-05T01:20:01.723776Z",
    "duration": "PT22.8356799S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Storage",
        "resourceTypes": [
          {
            "resourceType": "storageAccounts",
            "locations": [
              "eastus"
            ]
          }
        ]
      }
    ],
    "dependencies": [],
    "outputResources": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/my-storage-account"
      }
    ]
  }
}

Status code:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "properties": {
    "templateLink": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
      "contentVersion": "1.0.0.0"
    },
    "templateHash": "0000000000000000000",
    "parameters": {},
    "mode": "Incremental",
    "provisioningState": "Accepted",
    "timestamp": "2020-06-05T01:20:01.723776Z",
    "duration": "PT22.8356799S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Storage",
        "resourceTypes": [
          {
            "resourceType": "storageAccounts",
            "locations": [
              "eastus"
            ]
          }
        ]
      }
    ],
    "dependencies": []
  }
}

Create a deployment that will deploy a templateSpec with the given resourceId

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000001/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment?api-version=2025-04-01

{
  "properties": {
    "templateLink": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1"
    },
    "parameters": {},
    "mode": "Incremental"
  }
}


import com.azure.resourcemanager.resources.fluent.models.DeploymentInner;
import com.azure.resourcemanager.resources.models.DeploymentMode;
import com.azure.resourcemanager.resources.models.DeploymentProperties;
import com.azure.resourcemanager.resources.models.TemplateLink;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Deployments CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/
     * PutDeploymentResourceGroupTemplateSpecsWithId.json
     */
    /**
     * Sample code: Create a deployment that will deploy a templateSpec with the given resourceId.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createADeploymentThatWillDeployATemplateSpecWithTheGivenResourceId(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().deploymentClient().getDeployments().createOrUpdate("my-resource-group",
            "my-deployment",
            new DeploymentInner().withProperties(new DeploymentProperties().withTemplateLink(new TemplateLink().withId(
                "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1"))
                .withParameters(mapOf()).withMode(DeploymentMode.INCREMENTAL)),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource.deployments import DeploymentsMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource-deployments
# USAGE
    python put_deployment_resource_group_template_specs_with_id.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DeploymentsMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000001",
    )

    response = client.deployments.begin_create_or_update(
        resource_group_name="my-resource-group",
        deployment_name="my-deployment",
        parameters={
            "properties": {
                "mode": "Incremental",
                "parameters": {},
                "templateLink": {
                    "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1"
                },
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armdeployments_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armdeployments"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/edacc3b43f9603efa119eabb6013d952d1dbe7d6/specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json
func ExampleClient_BeginCreateOrUpdate_createADeploymentThatWillDeployATemplateSpecWithTheGivenResourceId() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdeployments.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewClient().BeginCreateOrUpdate(ctx, "my-resource-group", "my-deployment", armdeployments.Deployment{
		Properties: &armdeployments.DeploymentProperties{
			Mode:       to.Ptr(armdeployments.DeploymentModeIncremental),
			Parameters: map[string]*armdeployments.DeploymentParameter{},
			TemplateLink: &armdeployments.TemplateLink{
				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DeploymentExtended = armdeployments.DeploymentExtended{
	// 	Name: to.Ptr("my-deployment"),
	// 	Type: to.Ptr("Microsoft.Resources/deployments"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment"),
	// 	Properties: &armdeployments.DeploymentPropertiesExtended{
	// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		Dependencies: []*armdeployments.Dependency{
	// 		},
	// 		Duration: to.Ptr("PT22.8356799S"),
	// 		Mode: to.Ptr(armdeployments.DeploymentModeIncremental),
	// 		OutputResources: []*armdeployments.ResourceReference{
	// 			{
	// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/my-storage-account"),
	// 		}},
	// 		Parameters: map[string]any{
	// 		},
	// 		Providers: []*armdeployments.Provider{
	// 			{
	// 				Namespace: to.Ptr("Microsoft.Storage"),
	// 				ResourceTypes: []*armdeployments.ProviderResourceType{
	// 					{
	// 						Locations: []*string{
	// 							to.Ptr("eastus")},
	// 							ResourceType: to.Ptr("storageAccounts"),
	// 					}},
	// 			}},
	// 			ProvisioningState: to.Ptr(armdeployments.ProvisioningStateSucceeded),
	// 			TemplateHash: to.Ptr("0000000000000000000"),
	// 			TemplateLink: &armdeployments.TemplateLink{
	// 				ContentVersion: to.Ptr("1.0.0.0"),
	// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1"),
	// 			},
	// 			Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-05T01:20:01.723Z"); return t}()),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { DeploymentsClient } = require("@azure/arm-resourcesdeployments");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to You can provide the template and parameters directly in the request or link to JSON files.
 *
 * @summary You can provide the template and parameters directly in the request or link to JSON files.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json
 */
async function createADeploymentThatWillDeployATemplateSpecWithTheGivenResourceId() {
  const subscriptionId =
    process.env["RESOURCES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000001";
  const resourceGroupName = process.env["RESOURCES_RESOURCE_GROUP"] || "my-resource-group";
  const deploymentName = "my-deployment";
  const parameters = {
    properties: {
      mode: "Incremental",
      parameters: {},
      templateLink: {
        id: "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
      },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new DeploymentsClient(credential, subscriptionId);
  const result = await client.deployments.beginCreateOrUpdateAndWait(
    resourceGroupName,
    deploymentName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "properties": {
    "templateLink": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
      "contentVersion": "1.0.0.0"
    },
    "templateHash": "0000000000000000000",
    "parameters": {},
    "mode": "Incremental",
    "provisioningState": "Succeeded",
    "timestamp": "2020-06-05T01:20:01.723776Z",
    "duration": "PT22.8356799S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Storage",
        "resourceTypes": [
          {
            "resourceType": "storageAccounts",
            "locations": [
              "eastus"
            ]
          }
        ]
      }
    ],
    "dependencies": [],
    "outputResources": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/my-storage-account"
      }
    ]
  }
}

Status code:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "properties": {
    "templateLink": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
      "contentVersion": "1.0.0.0"
    },
    "templateHash": "0000000000000000000",
    "parameters": {},
    "mode": "Incremental",
    "provisioningState": "Accepted",
    "timestamp": "2020-06-05T01:20:01.723776Z",
    "duration": "PT22.8356799S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Storage",
        "resourceTypes": [
          {
            "resourceType": "storageAccounts",
            "locations": [
              "eastus"
            ]
          }
        ]
      }
    ],
    "dependencies": []
  }
}

Create a deployment that will redeploy another deployment on failure

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment?api-version=2025-04-01

{
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json"
    },
    "parameters": {},
    "mode": "Complete",
    "onErrorDeployment": {
      "type": "SpecificDeployment",
      "deploymentName": "name-of-deployment-to-use"
    }
  }
}


import com.azure.resourcemanager.resources.fluent.models.DeploymentInner;
import com.azure.resourcemanager.resources.models.DeploymentMode;
import com.azure.resourcemanager.resources.models.DeploymentProperties;
import com.azure.resourcemanager.resources.models.OnErrorDeployment;
import com.azure.resourcemanager.resources.models.OnErrorDeploymentType;
import com.azure.resourcemanager.resources.models.TemplateLink;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Deployments CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/
     * PutDeploymentWithOnErrorDeploymentSpecificDeployment.json
     */
    /**
     * Sample code: Create a deployment that will redeploy another deployment on failure.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createADeploymentThatWillRedeployAnotherDeploymentOnFailure(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().deploymentClient().getDeployments().createOrUpdate("my-resource-group",
            "my-deployment",
            new DeploymentInner().withProperties(new DeploymentProperties()
                .withTemplateLink(new TemplateLink().withUri("https://example.com/exampleTemplate.json"))
                .withParameters(mapOf()).withMode(DeploymentMode.COMPLETE)
                .withOnErrorDeployment(new OnErrorDeployment().withType(OnErrorDeploymentType.SPECIFIC_DEPLOYMENT)
                    .withDeploymentName("name-of-deployment-to-use"))),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource.deployments import DeploymentsMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource-deployments
# USAGE
    python put_deployment_with_on_error_deployment_specific_deployment.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DeploymentsMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.deployments.begin_create_or_update(
        resource_group_name="my-resource-group",
        deployment_name="my-deployment",
        parameters={
            "properties": {
                "mode": "Complete",
                "onErrorDeployment": {"deploymentName": "name-of-deployment-to-use", "type": "SpecificDeployment"},
                "parameters": {},
                "templateLink": {"uri": "https://example.com/exampleTemplate.json"},
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armdeployments_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armdeployments"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/edacc3b43f9603efa119eabb6013d952d1dbe7d6/specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json
func ExampleClient_BeginCreateOrUpdate_createADeploymentThatWillRedeployAnotherDeploymentOnFailure() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdeployments.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewClient().BeginCreateOrUpdate(ctx, "my-resource-group", "my-deployment", armdeployments.Deployment{
		Properties: &armdeployments.DeploymentProperties{
			Mode: to.Ptr(armdeployments.DeploymentModeComplete),
			OnErrorDeployment: &armdeployments.OnErrorDeployment{
				Type:           to.Ptr(armdeployments.OnErrorDeploymentTypeSpecificDeployment),
				DeploymentName: to.Ptr("name-of-deployment-to-use"),
			},
			Parameters: map[string]*armdeployments.DeploymentParameter{},
			TemplateLink: &armdeployments.TemplateLink{
				URI: to.Ptr("https://example.com/exampleTemplate.json"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DeploymentExtended = armdeployments.DeploymentExtended{
	// 	Name: to.Ptr("my-deployment"),
	// 	Type: to.Ptr("Microsoft.Resources/deployments"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment"),
	// 	Properties: &armdeployments.DeploymentPropertiesExtended{
	// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		Dependencies: []*armdeployments.Dependency{
	// 			{
	// 				DependsOn: []*armdeployments.BasicDependency{
	// 					{
	// 						ID: to.Ptr("{resourceid}"),
	// 						ResourceName: to.Ptr("VNet1"),
	// 						ResourceType: to.Ptr("Microsoft.Network/virtualNetworks"),
	// 				}},
	// 				ID: to.Ptr("{resourceid}"),
	// 				ResourceName: to.Ptr("VNet1/Subnet1"),
	// 				ResourceType: to.Ptr("Microsoft.Network/virtualNetworks/subnets"),
	// 			},
	// 			{
	// 				DependsOn: []*armdeployments.BasicDependency{
	// 					{
	// 						ID: to.Ptr("{resourceid}"),
	// 						ResourceName: to.Ptr("VNet1"),
	// 						ResourceType: to.Ptr("Microsoft.Network/virtualNetworks"),
	// 					},
	// 					{
	// 						ID: to.Ptr("{resourceid}"),
	// 						ResourceName: to.Ptr("VNet1/Subnet1"),
	// 						ResourceType: to.Ptr("Microsoft.Network/virtualNetworks/subnets"),
	// 				}},
	// 				ID: to.Ptr("{resourceid}"),
	// 				ResourceName: to.Ptr("VNet1/Subnet2"),
	// 				ResourceType: to.Ptr("Microsoft.Network/virtualNetworks/subnets"),
	// 		}},
	// 		Duration: to.Ptr("PT0.8204881S"),
	// 		Mode: to.Ptr(armdeployments.DeploymentModeComplete),
	// 		OnErrorDeployment: &armdeployments.OnErrorDeploymentExtended{
	// 			Type: to.Ptr(armdeployments.OnErrorDeploymentTypeSpecificDeployment),
	// 			DeploymentName: to.Ptr("name-of-deployment-to-use"),
	// 		},
	// 		Parameters: map[string]any{
	// 		},
	// 		Providers: []*armdeployments.Provider{
	// 			{
	// 				Namespace: to.Ptr("Microsoft.Network"),
	// 				ResourceTypes: []*armdeployments.ProviderResourceType{
	// 					{
	// 						Locations: []*string{
	// 							to.Ptr("centralus")},
	// 							ResourceType: to.Ptr("virtualNetworks"),
	// 						},
	// 						{
	// 							Locations: []*string{
	// 								to.Ptr("centralus")},
	// 								ResourceType: to.Ptr("virtualNetworks/subnets"),
	// 						}},
	// 				}},
	// 				ProvisioningState: to.Ptr(armdeployments.ProvisioningStateSucceeded),
	// 				TemplateLink: &armdeployments.TemplateLink{
	// 					ContentVersion: to.Ptr("1.0.0.0"),
	// 					URI: to.Ptr("https://example.com/exampleTemplate.json"),
	// 				},
	// 				Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T00:00:00.000Z"); return t}()),
	// 			},
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { DeploymentsClient } = require("@azure/arm-resourcesdeployments");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to You can provide the template and parameters directly in the request or link to JSON files.
 *
 * @summary You can provide the template and parameters directly in the request or link to JSON files.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json
 */
async function createADeploymentThatWillRedeployAnotherDeploymentOnFailure() {
  const subscriptionId =
    process.env["RESOURCES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["RESOURCES_RESOURCE_GROUP"] || "my-resource-group";
  const deploymentName = "my-deployment";
  const parameters = {
    properties: {
      mode: "Complete",
      onErrorDeployment: {
        type: "SpecificDeployment",
        deploymentName: "name-of-deployment-to-use",
      },
      parameters: {},
      templateLink: { uri: "https://example.com/exampleTemplate.json" },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new DeploymentsClient(credential, subscriptionId);
  const result = await client.deployments.beginCreateOrUpdateAndWait(
    resourceGroupName,
    deploymentName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json",
      "contentVersion": "1.0.0.0"
    },
    "parameters": {},
    "mode": "Complete",
    "provisioningState": "Accepted",
    "timestamp": "2019-03-01T00:00:00.0000000Z",
    "duration": "PT0.8204881S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Network",
        "resourceTypes": [
          {
            "resourceType": "virtualNetworks",
            "locations": [
              "centralus"
            ]
          },
          {
            "resourceType": "virtualNetworks/subnets",
            "locations": [
              "centralus"
            ]
          }
        ]
      }
    ],
    "dependencies": [
      {
        "dependsOn": [
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks",
            "resourceName": "VNet1"
          }
        ],
        "id": "{resourceid}",
        "resourceType": "Microsoft.Network/virtualNetworks/subnets",
        "resourceName": "VNet1/Subnet1"
      },
      {
        "dependsOn": [
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks",
            "resourceName": "VNet1"
          },
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks/subnets",
            "resourceName": "VNet1/Subnet1"
          }
        ],
        "id": "{resourceid}",
        "resourceType": "Microsoft.Network/virtualNetworks/subnets",
        "resourceName": "VNet1/Subnet2"
      }
    ],
    "onErrorDeployment": {
      "type": "SpecificDeployment",
      "deploymentName": "name-of-deployment-to-use"
    }
  }
}

Status code:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json",
      "contentVersion": "1.0.0.0"
    },
    "parameters": {},
    "mode": "Complete",
    "provisioningState": "Accepted",
    "timestamp": "2019-03-01T00:00:00.0000000Z",
    "duration": "PT0.8204881S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Network",
        "resourceTypes": [
          {
            "resourceType": "virtualNetworks",
            "locations": [
              "centralus"
            ]
          },
          {
            "resourceType": "virtualNetworks/subnets",
            "locations": [
              "centralus"
            ]
          }
        ]
      }
    ],
    "dependencies": [
      {
        "dependsOn": [
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks",
            "resourceName": "VNet1"
          }
        ],
        "id": "{resourceid}",
        "resourceType": "Microsoft.Network/virtualNetworks/subnets",
        "resourceName": "VNet1/Subnet1"
      },
      {
        "dependsOn": [
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks",
            "resourceName": "VNet1"
          },
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks/subnets",
            "resourceName": "VNet1/Subnet1"
          }
        ],
        "id": "{resourceid}",
        "resourceType": "Microsoft.Network/virtualNetworks/subnets",
        "resourceName": "VNet1/Subnet2"
      }
    ],
    "onErrorDeployment": {
      "type": "SpecificDeployment",
      "deploymentName": "name-of-deployment-to-use"
    }
  }
}

Create a deployment that will redeploy the last successful deployment on failure

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment?api-version=2025-04-01

{
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json"
    },
    "parameters": {},
    "mode": "Complete",
    "onErrorDeployment": {
      "type": "LastSuccessful"
    }
  }
}


import com.azure.resourcemanager.resources.fluent.models.DeploymentInner;
import com.azure.resourcemanager.resources.models.DeploymentMode;
import com.azure.resourcemanager.resources.models.DeploymentProperties;
import com.azure.resourcemanager.resources.models.OnErrorDeployment;
import com.azure.resourcemanager.resources.models.OnErrorDeploymentType;
import com.azure.resourcemanager.resources.models.TemplateLink;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Deployments CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/
     * PutDeploymentWithOnErrorDeploymentLastSuccessful.json
     */
    /**
     * Sample code: Create a deployment that will redeploy the last successful deployment on failure.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createADeploymentThatWillRedeployTheLastSuccessfulDeploymentOnFailure(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().deploymentClient().getDeployments().createOrUpdate("my-resource-group",
            "my-deployment",
            new DeploymentInner().withProperties(new DeploymentProperties()
                .withTemplateLink(new TemplateLink().withUri("https://example.com/exampleTemplate.json"))
                .withParameters(mapOf()).withMode(DeploymentMode.COMPLETE)
                .withOnErrorDeployment(new OnErrorDeployment().withType(OnErrorDeploymentType.LAST_SUCCESSFUL))),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource.deployments import DeploymentsMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource-deployments
# USAGE
    python put_deployment_with_on_error_deployment_last_successful.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DeploymentsMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.deployments.begin_create_or_update(
        resource_group_name="my-resource-group",
        deployment_name="my-deployment",
        parameters={
            "properties": {
                "mode": "Complete",
                "onErrorDeployment": {"type": "LastSuccessful"},
                "parameters": {},
                "templateLink": {"uri": "https://example.com/exampleTemplate.json"},
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armdeployments_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armdeployments"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/edacc3b43f9603efa119eabb6013d952d1dbe7d6/specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json
func ExampleClient_BeginCreateOrUpdate_createADeploymentThatWillRedeployTheLastSuccessfulDeploymentOnFailure() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdeployments.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewClient().BeginCreateOrUpdate(ctx, "my-resource-group", "my-deployment", armdeployments.Deployment{
		Properties: &armdeployments.DeploymentProperties{
			Mode: to.Ptr(armdeployments.DeploymentModeComplete),
			OnErrorDeployment: &armdeployments.OnErrorDeployment{
				Type: to.Ptr(armdeployments.OnErrorDeploymentTypeLastSuccessful),
			},
			Parameters: map[string]*armdeployments.DeploymentParameter{},
			TemplateLink: &armdeployments.TemplateLink{
				URI: to.Ptr("https://example.com/exampleTemplate.json"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DeploymentExtended = armdeployments.DeploymentExtended{
	// 	Name: to.Ptr("my-deployment"),
	// 	Type: to.Ptr("Microsoft.Resources/deployments"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment"),
	// 	Properties: &armdeployments.DeploymentPropertiesExtended{
	// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		Dependencies: []*armdeployments.Dependency{
	// 			{
	// 				DependsOn: []*armdeployments.BasicDependency{
	// 					{
	// 						ID: to.Ptr("{resourceid}"),
	// 						ResourceName: to.Ptr("VNet1"),
	// 						ResourceType: to.Ptr("Microsoft.Network/virtualNetworks"),
	// 				}},
	// 				ID: to.Ptr("{resourceid}"),
	// 				ResourceName: to.Ptr("VNet1/Subnet1"),
	// 				ResourceType: to.Ptr("Microsoft.Network/virtualNetworks/subnets"),
	// 			},
	// 			{
	// 				DependsOn: []*armdeployments.BasicDependency{
	// 					{
	// 						ID: to.Ptr("{resourceid}"),
	// 						ResourceName: to.Ptr("VNet1"),
	// 						ResourceType: to.Ptr("Microsoft.Network/virtualNetworks"),
	// 					},
	// 					{
	// 						ID: to.Ptr("{resourceid}"),
	// 						ResourceName: to.Ptr("VNet1/Subnet1"),
	// 						ResourceType: to.Ptr("Microsoft.Network/virtualNetworks/subnets"),
	// 				}},
	// 				ID: to.Ptr("{resourceid}"),
	// 				ResourceName: to.Ptr("VNet1/Subnet2"),
	// 				ResourceType: to.Ptr("Microsoft.Network/virtualNetworks/subnets"),
	// 		}},
	// 		Duration: to.Ptr("PT0.8204881S"),
	// 		Mode: to.Ptr(armdeployments.DeploymentModeComplete),
	// 		OnErrorDeployment: &armdeployments.OnErrorDeploymentExtended{
	// 			Type: to.Ptr(armdeployments.OnErrorDeploymentTypeLastSuccessful),
	// 			DeploymentName: to.Ptr("{nameOfLastSuccesfulDeployment}"),
	// 		},
	// 		Parameters: map[string]any{
	// 		},
	// 		Providers: []*armdeployments.Provider{
	// 			{
	// 				Namespace: to.Ptr("Microsoft.Network"),
	// 				ResourceTypes: []*armdeployments.ProviderResourceType{
	// 					{
	// 						Locations: []*string{
	// 							to.Ptr("centralus")},
	// 							ResourceType: to.Ptr("virtualNetworks"),
	// 						},
	// 						{
	// 							Locations: []*string{
	// 								to.Ptr("centralus")},
	// 								ResourceType: to.Ptr("virtualNetworks/subnets"),
	// 						}},
	// 				}},
	// 				ProvisioningState: to.Ptr(armdeployments.ProvisioningStateSucceeded),
	// 				TemplateLink: &armdeployments.TemplateLink{
	// 					ContentVersion: to.Ptr("1.0.0.0"),
	// 					URI: to.Ptr("https://example.com/exampleTemplate.json"),
	// 				},
	// 				Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T00:00:00.000Z"); return t}()),
	// 			},
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { DeploymentsClient } = require("@azure/arm-resourcesdeployments");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to You can provide the template and parameters directly in the request or link to JSON files.
 *
 * @summary You can provide the template and parameters directly in the request or link to JSON files.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json
 */
async function createADeploymentThatWillRedeployTheLastSuccessfulDeploymentOnFailure() {
  const subscriptionId =
    process.env["RESOURCES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["RESOURCES_RESOURCE_GROUP"] || "my-resource-group";
  const deploymentName = "my-deployment";
  const parameters = {
    properties: {
      mode: "Complete",
      onErrorDeployment: { type: "LastSuccessful" },
      parameters: {},
      templateLink: { uri: "https://example.com/exampleTemplate.json" },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new DeploymentsClient(credential, subscriptionId);
  const result = await client.deployments.beginCreateOrUpdateAndWait(
    resourceGroupName,
    deploymentName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json",
      "contentVersion": "1.0.0.0"
    },
    "parameters": {},
    "mode": "Complete",
    "provisioningState": "Accepted",
    "timestamp": "2019-03-01T00:00:00.0000000Z",
    "duration": "PT0.8204881S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Network",
        "resourceTypes": [
          {
            "resourceType": "virtualNetworks",
            "locations": [
              "centralus"
            ]
          },
          {
            "resourceType": "virtualNetworks/subnets",
            "locations": [
              "centralus"
            ]
          }
        ]
      }
    ],
    "dependencies": [
      {
        "dependsOn": [
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks",
            "resourceName": "VNet1"
          }
        ],
        "id": "{resourceid}",
        "resourceType": "Microsoft.Network/virtualNetworks/subnets",
        "resourceName": "VNet1/Subnet1"
      },
      {
        "dependsOn": [
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks",
            "resourceName": "VNet1"
          },
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks/subnets",
            "resourceName": "VNet1/Subnet1"
          }
        ],
        "id": "{resourceid}",
        "resourceType": "Microsoft.Network/virtualNetworks/subnets",
        "resourceName": "VNet1/Subnet2"
      }
    ],
    "onErrorDeployment": {
      "type": "LastSuccessful",
      "deploymentName": "{nameOfLastSuccesfulDeployment}"
    }
  }
}

Status code:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json",
      "contentVersion": "1.0.0.0"
    },
    "parameters": {},
    "mode": "Complete",
    "provisioningState": "Accepted",
    "timestamp": "2019-03-01T00:00:00.0000000Z",
    "duration": "PT0.8204881S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Network",
        "resourceTypes": [
          {
            "resourceType": "virtualNetworks",
            "locations": [
              "centralus"
            ]
          },
          {
            "resourceType": "virtualNetworks/subnets",
            "locations": [
              "centralus"
            ]
          }
        ]
      }
    ],
    "dependencies": [
      {
        "dependsOn": [
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks",
            "resourceName": "VNet1"
          }
        ],
        "id": "{resourceid}",
        "resourceType": "Microsoft.Network/virtualNetworks/subnets",
        "resourceName": "VNet1/Subnet1"
      },
      {
        "dependsOn": [
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks",
            "resourceName": "VNet1"
          },
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks/subnets",
            "resourceName": "VNet1/Subnet1"
          }
        ],
        "id": "{resourceid}",
        "resourceType": "Microsoft.Network/virtualNetworks/subnets",
        "resourceName": "VNet1/Subnet2"
      }
    ],
    "onErrorDeployment": {
      "type": "LastSuccessful",
      "deploymentName": "{nameOfLastSuccesfulDeployment}"
    }
  }
}

Create deployment using external inputs

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000001/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment?api-version=2025-04-01

{
  "properties": {
    "template": {
      "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
      "contentVersion": "1.0.0.0",
      "parameters": {
        "inputObj": {
          "type": "object"
        }
      },
      "resources": [],
      "outputs": {
        "inputObj": {
          "type": "object",
          "value": "[parameters('inputObj')]"
        }
      }
    },
    "parameters": {
      "inputObj": {
        "expression": "[createObject('foo', externalInputs('fooValue'))]"
      }
    },
    "externalInputDefinitions": {
      "fooValue": {
        "kind": "sys.envVar",
        "config": "FOO_VALUE"
      }
    },
    "externalInputs": {
      "fooValue": {
        "value": "baz"
      }
    },
    "mode": "Incremental"
  }
}


import com.azure.core.management.serializer.SerializerFactory;
import com.azure.core.util.serializer.SerializerEncoding;
import com.azure.resourcemanager.resources.fluent.models.DeploymentInner;
import com.azure.resourcemanager.resources.models.DeploymentExternalInput;
import com.azure.resourcemanager.resources.models.DeploymentExternalInputDefinition;
import com.azure.resourcemanager.resources.models.DeploymentMode;
import com.azure.resourcemanager.resources.models.DeploymentParameter;
import com.azure.resourcemanager.resources.models.DeploymentProperties;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Deployments CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/
     * PutDeploymentWithExternalInputs.json
     */
    /**
     * Sample code: Create deployment using external inputs.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createDeploymentUsingExternalInputs(com.azure.resourcemanager.AzureResourceManager azure)
        throws IOException {
        azure.genericResources().manager().deploymentClient().getDeployments().createOrUpdate("my-resource-group",
            "my-deployment",
            new DeploymentInner().withProperties(new DeploymentProperties()
                .withTemplate(SerializerFactory.createDefaultManagementSerializerAdapter().deserialize(
                    "{\"$schema\":\"https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#\",\"contentVersion\":\"1.0.0.0\",\"outputs\":{\"inputObj\":{\"type\":\"object\",\"value\":\"[parameters('inputObj')]\"}},\"parameters\":{\"inputObj\":{\"type\":\"object\"}},\"resources\":[]}",
                    Object.class, SerializerEncoding.JSON))
                .withParameters(mapOf("inputObj",
                    new DeploymentParameter().withExpression("[createObject('foo', externalInputs('fooValue'))]")))
                .withExternalInputs(mapOf("fooValue", new DeploymentExternalInput().withValue("baz")))
                .withExternalInputDefinitions(mapOf("fooValue",
                    new DeploymentExternalInputDefinition().withKind("sys.envVar").withConfig("FOO_VALUE")))
                .withMode(DeploymentMode.INCREMENTAL)),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource.deployments import DeploymentsMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource-deployments
# USAGE
    python put_deployment_with_external_inputs.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DeploymentsMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000001",
    )

    response = client.deployments.begin_create_or_update(
        resource_group_name="my-resource-group",
        deployment_name="my-deployment",
        parameters={
            "properties": {
                "externalInputDefinitions": {"fooValue": {"config": "FOO_VALUE", "kind": "sys.envVar"}},
                "externalInputs": {"fooValue": {"value": "baz"}},
                "mode": "Incremental",
                "parameters": {"inputObj": {"expression": "[createObject('foo', externalInputs('fooValue'))]"}},
                "template": {
                    "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
                    "contentVersion": "1.0.0.0",
                    "outputs": {"inputObj": {"type": "object", "value": "[parameters('inputObj')]"}},
                    "parameters": {"inputObj": {"type": "object"}},
                    "resources": [],
                },
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentWithExternalInputs.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armdeployments_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armdeployments"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/edacc3b43f9603efa119eabb6013d952d1dbe7d6/specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentWithExternalInputs.json
func ExampleClient_BeginCreateOrUpdate_createDeploymentUsingExternalInputs() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdeployments.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewClient().BeginCreateOrUpdate(ctx, "my-resource-group", "my-deployment", armdeployments.Deployment{
		Properties: &armdeployments.DeploymentProperties{
			ExternalInputDefinitions: map[string]*armdeployments.DeploymentExternalInputDefinition{
				"fooValue": {
					Config: "FOO_VALUE",
					Kind:   to.Ptr("sys.envVar"),
				},
			},
			ExternalInputs: map[string]*armdeployments.DeploymentExternalInput{
				"fooValue": {
					Value: "baz",
				},
			},
			Mode: to.Ptr(armdeployments.DeploymentModeIncremental),
			Parameters: map[string]*armdeployments.DeploymentParameter{
				"inputObj": {
					Expression: to.Ptr("[createObject('foo', externalInputs('fooValue'))]"),
				},
			},
			Template: map[string]any{
				"$schema":        "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
				"contentVersion": "1.0.0.0",
				"outputs": map[string]any{
					"inputObj": map[string]any{
						"type":  "object",
						"value": "[parameters('inputObj')]",
					},
				},
				"parameters": map[string]any{
					"inputObj": map[string]any{
						"type": "object",
					},
				},
				"resources": []any{},
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DeploymentExtended = armdeployments.DeploymentExtended{
	// 	Name: to.Ptr("my-deployment"),
	// 	Type: to.Ptr("Microsoft.Resources/deployments"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment"),
	// 	Properties: &armdeployments.DeploymentPropertiesExtended{
	// 		CorrelationID: to.Ptr("ef613b6c-f76e-48fd-9da7-28884243c5e5"),
	// 		Dependencies: []*armdeployments.Dependency{
	// 		},
	// 		Mode: to.Ptr(armdeployments.DeploymentModeIncremental),
	// 		OutputResources: []*armdeployments.ResourceReference{
	// 		},
	// 		Outputs: map[string]any{
	// 			"inputObj":map[string]any{
	// 				"type": "Object",
	// 				"value":map[string]any{
	// 					"foo": "baz",
	// 				},
	// 			},
	// 		},
	// 		Parameters: map[string]any{
	// 			"inputObj":map[string]any{
	// 				"type": "Object",
	// 				"value":map[string]any{
	// 					"foo": "baz",
	// 				},
	// 			},
	// 		},
	// 		Providers: []*armdeployments.Provider{
	// 		},
	// 		ProvisioningState: to.Ptr(armdeployments.ProvisioningStateSucceeded),
	// 		TemplateHash: to.Ptr("17686481789412793580"),
	// 		Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-04-09T14:36:48.204Z"); return t}()),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { DeploymentsClient } = require("@azure/arm-resourcesdeployments");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to You can provide the template and parameters directly in the request or link to JSON files.
 *
 * @summary You can provide the template and parameters directly in the request or link to JSON files.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentWithExternalInputs.json
 */
async function createDeploymentUsingExternalInputs() {
  const subscriptionId =
    process.env["RESOURCES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000001";
  const resourceGroupName = process.env["RESOURCES_RESOURCE_GROUP"] || "my-resource-group";
  const deploymentName = "my-deployment";
  const parameters = {
    properties: {
      externalInputDefinitions: {
        fooValue: { config: "FOO_VALUE", kind: "sys.envVar" },
      },
      externalInputs: { fooValue: { value: "baz" } },
      mode: "Incremental",
      parameters: {
        inputObj: {
          expression: "[createObject('foo', externalInputs('fooValue'))]",
        },
      },
      template: {
        $schema: "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
        contentVersion: "1.0.0.0",
        outputs: {
          inputObj: { type: "object", value: "[parameters('inputObj')]" },
        },
        parameters: { inputObj: { type: "object" } },
        resources: [],
      },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new DeploymentsClient(credential, subscriptionId);
  const result = await client.deployments.beginCreateOrUpdateAndWait(
    resourceGroupName,
    deploymentName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "properties": {
    "templateHash": "17686481789412793580",
    "parameters": {
      "inputObj": {
        "type": "Object",
        "value": {
          "foo": "baz"
        }
      }
    },
    "mode": "Incremental",
    "provisioningState": "Succeeded",
    "timestamp": "2025-04-09T14:36:48.2047169Z",
    "correlationId": "ef613b6c-f76e-48fd-9da7-28884243c5e5",
    "providers": [],
    "dependencies": [],
    "outputs": {
      "inputObj": {
        "type": "Object",
        "value": {
          "foo": "baz"
        }
      }
    },
    "outputResources": []
  }
}

Status code:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "properties": {
    "templateHash": "17686481789412793580",
    "parameters": {
      "inputObj": {
        "type": "Object",
        "value": {
          "foo": "baz"
        }
      }
    },
    "mode": "Incremental",
    "provisioningState": "Accepted",
    "timestamp": "2025-04-09T14:36:47.6637583Z",
    "duration": "PT0.0009164S",
    "correlationId": "ef613b6c-f76e-48fd-9da7-28884243c5e5",
    "providers": [],
    "dependencies": []
  }
}

Definitions

Name	Description
Alias	The alias type.
AliasPath	The type of the paths for alias.
AliasPathAttributes	The attributes of the token that the alias path is referring to.
AliasPathMetadata
AliasPathTokenType	The type of the token that the alias path is referring to.
AliasPattern	The type of the pattern for an alias path.
AliasPatternType	The type of alias pattern
AliasType	The type of the alias.
ApiProfile
BasicDependency	Deployment dependency information.
CloudError	An error response for a resource management request.
DebugSetting	The debug setting.
Dependency	Deployment dependency information.
Deployment	Deployment operation parameters.
DeploymentDiagnosticsDefinition
DeploymentExtended	Deployment information.
DeploymentExtensionConfigItem
DeploymentExtensionDefinition
DeploymentExternalInput	Deployment external input for parameterization.
DeploymentExternalInputDefinition	Deployment external input definition for parameterization.
DeploymentIdentity	The Managed Identity configuration for a deployment.
DeploymentIdentityType	The identity type.
DeploymentMode	The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources.
DeploymentParameter	Deployment parameter for the template.
DeploymentProperties	Deployment properties.
DeploymentPropertiesExtended	Deployment properties with additional details.
ErrorAdditionalInfo	The resource management error additional info.
ErrorResponse	Error Response
ExpressionEvaluationOptions	Specifies whether template expressions are evaluated within the scope of the parent template or nested template.
ExpressionEvaluationOptionsScopeType	The scope to be used for evaluation of parameters, variables and functions in a nested template.
ExtensionConfigPropertyType
KeyVaultParameterReference	Azure Key Vault parameter reference.
KeyVaultReference	Azure Key Vault reference.
Level	Denotes the additional response level.
OnErrorDeployment	Deployment on error behavior.
OnErrorDeploymentExtended	Deployment on error behavior with additional details.
OnErrorDeploymentType	The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.
ParametersLink	Entity representing the reference to the deployment parameters.
Provider	Resource provider information.
ProviderAuthorizationConsentState	The provider authorization consent state.
ProviderExtendedLocation	The provider extended ___location.
ProviderResourceType	Resource type managed by the resource provider.
ProvisioningState	Denotes the state of provisioning.
ResourceReference	The resource Id model.
TemplateLink	Entity representing the reference to the template.
UserAssignedIdentity	User assigned identity properties
ValidationLevel	The level of validation performed on the deployment.
ZoneMapping

Alias

Object

The alias type.

Name	Type	Description
defaultMetadata	AliasPathMetadata	The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata
defaultPath	string	The default path for an alias.
defaultPattern	AliasPattern	The default pattern for an alias.
name	string	The alias name.
paths	AliasPath[]	The paths for an alias.
type	AliasType	The type of the alias.

AliasPath

Object

The type of the paths for alias.

Name	Type	Description
apiVersions	string[]	The API versions.
metadata	AliasPathMetadata	The metadata of the alias path. If missing, fall back to the default metadata of the alias.
path	string	The path of an alias.
pattern	AliasPattern	The pattern for an alias path.

AliasPathAttributes

Enumeration

The attributes of the token that the alias path is referring to.

Value	Description
None	The token that the alias path is referring to has no attributes.
Modifiable	The token that the alias path is referring to is modifiable by policies with 'modify' effect.

AliasPathMetadata

Object

Name	Type	Description
attributes	AliasPathAttributes	The attributes of the token that the alias path is referring to.
type	AliasPathTokenType	The type of the token that the alias path is referring to.

AliasPathTokenType

Enumeration

The type of the token that the alias path is referring to.

Value	Description
NotSpecified	The token type is not specified.
Any	The token type can be anything.
String	The token type is string.
Object	The token type is object.
Array	The token type is array.
Integer	The token type is integer.
Number	The token type is number.
Boolean	The token type is boolean.

AliasPattern

Object

The type of the pattern for an alias path.

Name	Type	Description
phrase	string	The alias pattern phrase.
type	AliasPatternType	The type of alias pattern
variable	string	The alias pattern variable.

AliasPatternType

Enumeration

The type of alias pattern

Value	Description
NotSpecified	NotSpecified is not allowed.
Extract	Extract is the only allowed value.

AliasType

Enumeration

The type of the alias.

Value	Description
NotSpecified	Alias type is unknown (same as not providing alias type).
PlainText	Alias value is not secret.
Mask	Alias value is secret.

ApiProfile

Object

Name	Type	Description
apiVersion	string	The API version.
profileVersion	string	The profile version.

BasicDependency

Object

Deployment dependency information.

Name	Type	Description
id	string	The ID of the dependency.
resourceName	string	The dependency resource name.
resourceType	string	The dependency resource type.

CloudError

Object

An error response for a resource management request.

Name	Type	Description
error	ErrorResponse	Error Response Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)

DebugSetting

Object

The debug setting.

Name	Type	Description
detailLevel	string	Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations.

Dependency

Object

Deployment dependency information.

Name	Type	Description
dependsOn	BasicDependency[]	The list of dependencies.
id	string	The ID of the dependency.
resourceName	string	The dependency resource name.
resourceType	string	The dependency resource type.

Deployment

Object

Deployment operation parameters.

Name	Type	Description
identity	DeploymentIdentity	The Managed Identity configuration for a deployment.
___location	string	The ___location to store the deployment data.
properties	DeploymentProperties	The deployment properties.
tags	object	Deployment tags

DeploymentDiagnosticsDefinition

Object

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
level	Level	Denotes the additional response level.
message	string	The error message.
target	string	The error target.

DeploymentExtended

Object

Deployment information.

Name	Type	Description
id	string	The ID of the deployment.
___location	string	the ___location of the deployment.
name	string	The name of the deployment.
properties	DeploymentPropertiesExtended	Deployment properties.
tags	object	Deployment tags
type	string	The type of the deployment.

DeploymentExtensionConfigItem

Object

Name	Type	Description
keyVaultReference	KeyVaultParameterReference	The Azure Key Vault reference used to retrieve the secret value of the extension config property.
type	ExtensionConfigPropertyType	The value type of the extension config property.
value		The value of the extension config property.

DeploymentExtensionDefinition

Object

Name	Type	Description
alias	string	The alias of the extension as defined in the deployment template.
config	<string, DeploymentExtensionConfigItem>	The extension configuration.
configId	string	The extension configuration ID. It uniquely identifies a deployment control plane within an extension.
name	string	The extension name.
version	string	The extension version.

DeploymentExternalInput

Object

Deployment external input for parameterization.

Name	Type	Description
value		External input value.

DeploymentExternalInputDefinition

Object

Deployment external input definition for parameterization.

Name	Type	Description
config		Configuration for the external input.
kind	string	The kind of external input.

DeploymentIdentity

Object

The Managed Identity configuration for a deployment.

Name	Type	Description
type	DeploymentIdentityType	The identity type.
userAssignedIdentities	<string, UserAssignedIdentity>	The set of user assigned identities associated with the resource.

DeploymentIdentityType

Enumeration

The identity type.

Value	Description
None
UserAssigned

DeploymentMode

Enumeration

The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources.

Value	Description
Incremental
Complete

DeploymentParameter

Object

Deployment parameter for the template.

Name	Type	Description
expression	string	Input expression to the parameter.
reference	KeyVaultParameterReference	Azure Key Vault parameter reference.
value		Input value to the parameter .

DeploymentProperties

Object

Deployment properties.

Name	Type	Description
debugSetting	DebugSetting	The debug setting of the deployment.
expressionEvaluationOptions	ExpressionEvaluationOptions	Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer.
extensionConfigs	object	The configurations to use for deployment extensions. The keys of this object are deployment extension aliases as defined in the deployment template.
externalInputDefinitions	<string, DeploymentExternalInputDefinition>	External input definitions, used by external tooling to define expected external input values.
externalInputs	<string, DeploymentExternalInput>	External input values, used by external tooling for parameter evaluation.
mode	DeploymentMode	The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources.
onErrorDeployment	OnErrorDeployment	The deployment on error behavior.
parameters	<string, DeploymentParameter>	Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string.
parametersLink	ParametersLink	The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both.
template	object	The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both.
templateLink	TemplateLink	The URI of the template. Use either the templateLink property or the template property, but not both.
validationLevel	ValidationLevel	The validation level of the deployment

DeploymentPropertiesExtended

Object

Deployment properties with additional details.

Name	Type	Description
correlationId	string	The correlation ID of the deployment.
debugSetting	DebugSetting	The debug setting of the deployment.
dependencies	Dependency[]	The list of deployment dependencies.
diagnostics	DeploymentDiagnosticsDefinition[]	Contains diagnostic information collected during validation process.
duration	string	The duration of the template deployment.
error	ErrorResponse	Error Response The deployment error.
extensions	DeploymentExtensionDefinition[]	The extensions used in this deployment.
mode	DeploymentMode	The deployment mode. Possible values are Incremental and Complete.
onErrorDeployment	OnErrorDeploymentExtended	The deployment on error behavior.
outputResources	ResourceReference[]	Array of provisioned resources.
outputs	object	Key/value pairs that represent deployment output.
parameters	object	Deployment parameters.
parametersLink	ParametersLink	The URI referencing the parameters.
providers	Provider[]	The list of resource providers needed for the deployment.
provisioningState	ProvisioningState	Denotes the state of provisioning.
templateHash	string	The hash produced for the template.
templateLink	TemplateLink	The URI referencing the template.
timestamp	string (date-time)	The timestamp of the template deployment.
validatedResources	ResourceReference[]	Array of validated resources.
validationLevel	ValidationLevel	The validation level of the deployment

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorResponse

Object

Error Response

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorResponse[]	The error details.
message	string	The error message.
target	string	The error target.

ExpressionEvaluationOptions

Object

Specifies whether template expressions are evaluated within the scope of the parent template or nested template.

Name	Type	Description
scope	ExpressionEvaluationOptionsScopeType	The scope to be used for evaluation of parameters, variables and functions in a nested template.

ExpressionEvaluationOptionsScopeType

Enumeration

The scope to be used for evaluation of parameters, variables and functions in a nested template.

Value	Description
NotSpecified
Outer
Inner

ExtensionConfigPropertyType

Enumeration

Value	Description
String	Property type representing a string value.
Int	Property type representing an integer value.
Bool	Property type representing a boolean value.
Array	Property type representing an array value.
Object	Property type representing an object value.
SecureString	Property type representing a secure string value.
SecureObject	Property type representing a secure object value.

KeyVaultParameterReference

Object

Azure Key Vault parameter reference.

Name	Type	Description
keyVault	KeyVaultReference	Azure Key Vault reference.
secretName	string	Azure Key Vault secret name.
secretVersion	string	Azure Key Vault secret version.

KeyVaultReference

Object

Azure Key Vault reference.

Name	Type	Description
id	string	Azure Key Vault resource id.

Level

Enumeration

Denotes the additional response level.

Value	Description
Warning
Info
Error

OnErrorDeployment

Object

Deployment on error behavior.

Name	Type	Description
deploymentName	string	The deployment to be used on error case.
type	OnErrorDeploymentType	The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.

OnErrorDeploymentExtended

Object

Deployment on error behavior with additional details.

Name	Type	Description
deploymentName	string	The deployment to be used on error case.
provisioningState	string	The state of the provisioning for the on error deployment.
type	OnErrorDeploymentType	The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.

OnErrorDeploymentType

Enumeration

The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.

Value	Description
LastSuccessful
SpecificDeployment

ParametersLink

Object

Entity representing the reference to the deployment parameters.

Name	Type	Description
contentVersion	string	If included, must match the ContentVersion in the template.
uri	string	The URI of the parameters file.

Provider

Object

Resource provider information.

Name	Type	Description
id	string	The provider ID.
namespace	string	The namespace of the resource provider.
providerAuthorizationConsentState	ProviderAuthorizationConsentState	The provider authorization consent state.
registrationPolicy	string	The registration policy of the resource provider.
registrationState	string	The registration state of the resource provider.
resourceTypes	ProviderResourceType[]	The collection of provider resource types.

ProviderAuthorizationConsentState

Enumeration

The provider authorization consent state.

Value	Description
NotSpecified
Required
NotRequired
Consented

ProviderExtendedLocation

Object

The provider extended ___location.

Name	Type	Description
extendedLocations	string[]	The extended locations for the azure ___location.
___location	string	The azure ___location.
type	string	The extended ___location type.

ProviderResourceType

Object

Resource type managed by the resource provider.

Name	Type	Description
aliases	Alias[]	The aliases that are supported by this resource type.
apiProfiles	ApiProfile[]	The API profiles for the resource provider.
apiVersions	string[]	The API version.
capabilities	string	The additional capabilities offered by this resource type.
defaultApiVersion	string	The default API version.
locationMappings	ProviderExtendedLocation[]	The ___location mappings that are supported by this resource type.
locations	string[]	The collection of locations where this resource type can be created.
properties	object	The properties.
resourceType	string	The resource type.
zoneMappings	ZoneMapping[]

ProvisioningState

Enumeration

Denotes the state of provisioning.

Value	Description
NotSpecified
Accepted
Running
Ready
Creating
Created
Deleting
Deleted
Canceled
Failed
Succeeded
Updating

ResourceReference

Object

The resource Id model.

Name	Type	Description
apiVersion	string	The API version the resource was deployed with.
extension	DeploymentExtensionDefinition	The extension the resource was deployed with.
id	string	The fully qualified Azure resource ID.
identifiers	object	The extensible resource identifiers.
resourceType	string	The resource type.

TemplateLink

Object

Entity representing the reference to the template.

Name	Type	Description
contentVersion	string	If included, must match the ContentVersion in the template.
id	string	The resource id of a Template Spec. Use either the id or uri property, but not both.
queryString	string	The query string (for example, a SAS token) to be used with the templateLink URI.
relativePath	string	The relativePath property can be used to deploy a linked template at a ___location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs
uri	string	The URI of the template to deploy. Use either the uri or id property, but not both.

UserAssignedIdentity

Object

User assigned identity properties

Name	Type	Description
clientId	string (uuid)	The client ID of the assigned identity.
principalId	string (uuid)	The principal ID of the assigned identity.

ValidationLevel

Enumeration

The level of validation performed on the deployment.

Value	Description
Template	Static analysis of the template is performed.
Provider	Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource.
ProviderNoRbac	Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource.

ZoneMapping

Object

Name	Type	Description
___location	string	The ___location of the zone mapping.
zones	string[]

Share via

Deployments - Create Or Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Create a deployment that will deploy a template with a uri and queryString

Sample request

Sample response

Create a deployment that will deploy a templateSpec with the given resourceId

Sample request

Sample response

Create a deployment that will redeploy another deployment on failure

Sample request

Sample response

Create a deployment that will redeploy the last successful deployment on failure

Sample request

Sample response

Create deployment using external inputs

Sample request

Sample response

Definitions

Alias

AliasPath

AliasPathAttributes

AliasPathMetadata

AliasPathTokenType

AliasPattern

AliasPatternType

AliasType

ApiProfile

BasicDependency

CloudError

DebugSetting

Dependency

Deployment

DeploymentDiagnosticsDefinition

DeploymentExtended

DeploymentExtensionConfigItem

DeploymentExtensionDefinition

DeploymentExternalInput

DeploymentExternalInputDefinition

DeploymentIdentity

DeploymentIdentityType

DeploymentMode

DeploymentParameter

DeploymentProperties

DeploymentPropertiesExtended

ErrorAdditionalInfo

ErrorResponse

ExpressionEvaluationOptions

ExpressionEvaluationOptionsScopeType

ExtensionConfigPropertyType

KeyVaultParameterReference

KeyVaultReference

Level

OnErrorDeployment

OnErrorDeploymentExtended

OnErrorDeploymentType

ParametersLink

Provider

ProviderAuthorizationConsentState

ProviderExtendedLocation

ProviderResourceType

ProvisioningState

ResourceReference

TemplateLink

UserAssignedIdentity

ValidationLevel

ZoneMapping