Deployments - Create Or Update

Tjänst:: Resource Management

API-version:: 2025-04-01

Distribuerar resurser till en resursgrupp.
Du kan ange mallen och parametrarna direkt i begäran eller länka till JSON-filer.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
deploymentName	path	True	string minLength: 1 maxLength: 64 pattern: ^[-\w\._]+$	Namnet på utplaceringen.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Namnet på resursgruppen som resurserna ska distribueras till. Namnet är skiftlägesokänsligt. Resursgruppen måste redan finnas.
subscriptionId	path	True	string	Prenumerations-ID för Microsoft Azure.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
properties	True	DeploymentProperties	Distributionsegenskaperna.
identity		DeploymentIdentity	Konfigurationen av hanterad identitet för en distribution.
location		string	Platsen där distributionsdata ska lagras.
tags		object	Distributionstaggar

Svar

Name	Typ	Description
200 OK	DeploymentExtended	OK – Returnerar information om distributionen, inklusive etableringsstatus.
201 Created	DeploymentExtended	Skapad – Returnerar information om distributionen, inklusive etableringsstatus.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Exempelbegäran

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

Exempelsvar

Statuskod:: 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"
      }
    ]
  }
}

Statuskod:: 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

Exempelbegäran

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

Exempelsvar

Statuskod:: 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"
      }
    ]
  }
}

Statuskod:: 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

Exempelbegäran

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

Exempelsvar

Statuskod:: 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"
    }
  }
}

Statuskod:: 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

Exempelbegäran

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

Exempelsvar

Statuskod:: 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}"
    }
  }
}

Statuskod:: 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

Exempelbegäran

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

Exempelsvar

Statuskod:: 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": []
  }
}

Statuskod:: 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": []
  }
}

Definitioner

Name	Description
Alias	Aliastypen.
AliasPath	Typ av sökvägar för alias.
AliasPathAttributes	Attributen för token som aliassökvägen refererar till.
AliasPathMetadata
AliasPathTokenType	Typen av token som aliassökvägen refererar till.
AliasPattern	Typ av mönster för en aliassökväg.
AliasPatternType	Typ av aliasmönster
AliasType	Typ av alias.
ApiProfile
BasicDependency	Information om distributionsberoende.
CloudError	Ett felsvar för en resurshanteringsbegäran.
DebugSetting	Felsökningsinställningen.
Dependency	Information om distributionsberoende.
Deployment	Parametrar för distributionsåtgärd.
DeploymentDiagnosticsDefinition
DeploymentExtended	Distributionsinformation.
DeploymentExtensionConfigItem
DeploymentExtensionDefinition
DeploymentExternalInput	Externa indata för distribution för parametrering.
DeploymentExternalInputDefinition	Definition av externa indata för distribution för parametrisering.
DeploymentIdentity	Konfigurationen av hanterad identitet för en distribution.
DeploymentIdentityType	Identitetstypen.
DeploymentMode	Läget som används för att distribuera resurser. Det här värdet kan vara antingen Inkrementellt eller Slutfört. I inkrementellt läge distribueras resurser utan att befintliga resurser som inte ingår i mallen tas bort. I fullständigt läge distribueras resurser och befintliga resurser i resursgruppen som inte ingår i mallen tas bort. Var försiktig när du använder Slutfört läge eftersom du oavsiktligt kan ta bort resurser.
DeploymentParameter	Distributionsparameter för mallen.
DeploymentProperties	Distributionsegenskaper.
DeploymentPropertiesExtended	Distributionsegenskaper med ytterligare information.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorResponse	Felsvar
ExpressionEvaluationOptions	Anger om malluttryck utvärderas inom omfånget för den överordnade mallen eller den kapslade mallen.
ExpressionEvaluationOptionsScopeType	Det omfång som ska användas för utvärdering av parametrar, variabler och funktioner i en kapslad mall.
ExtensionConfigPropertyType
KeyVaultParameterReference	Parameterreferens för Azure Key Vault.
KeyVaultReference	Azure Key Vault-referens.
Level	Anger den ytterligare svarsnivån.
OnErrorDeployment	Distribution på felbeteende.
OnErrorDeploymentExtended	Distribution av felbeteende med ytterligare information.
OnErrorDeploymentType	Distributionen på felbeteendetypen. Möjliga värden är LastSuccessful och SpecificDeployment.
ParametersLink	Entitet som representerar referensen till distributionsparametrarna.
Provider	Information om resursprovider.
ProviderAuthorizationConsentState	Tillstånd för providerauktoriseringsmedgivande.
ProviderExtendedLocation	Providerns utökade plats.
ProviderResourceType	Resurstyp som hanteras av resursprovidern.
ProvisioningState	Anger etableringstillståndet.
ResourceReference	Resurs-ID-modellen.
TemplateLink	Entitet som representerar referensen till mallen.
UserAssignedIdentity	Användartilldelade identitetsegenskaper
ValidationLevel	Valideringsnivån som utförs på distributionen.
ZoneMapping

Alias

Objekt

Aliastypen.

Name	Typ	Description
defaultMetadata	AliasPathMetadata	Standardmetadata för aliassökväg. Gäller för standardsökvägen och för alla aliassökvägar som inte har metadata
defaultPath	string	Standardsökvägen för ett alias.
defaultPattern	AliasPattern	Standardmönstret för ett alias.
name	string	Aliasnamnet.
paths	AliasPath[]	Sökvägarna för ett alias.
type	AliasType	Typ av alias.

AliasPath

Objekt

Typ av sökvägar för alias.

Name	Typ	Description
apiVersions	string[]	API-versionerna.
metadata	AliasPathMetadata	Metadata för aliassökvägen. Om det saknas återgår du till standardmetadata för aliaset.
path	string	Sökvägen till ett alias.
pattern	AliasPattern	Mönstret för en aliassökväg.

AliasPathAttributes

Uppräkning

Attributen för token som aliassökvägen refererar till.

Värde	Description
None	Den token som aliassökvägen refererar till har inga attribut.
Modifiable	Den token som aliassökvägen refererar till kan ändras av principer med "ändra"-effekt.

AliasPathMetadata

Objekt

Name	Typ	Description
attributes	AliasPathAttributes	Attributen för token som aliassökvägen refererar till.
type	AliasPathTokenType	Typen av token som aliassökvägen refererar till.

AliasPathTokenType

Uppräkning

Typen av token som aliassökvägen refererar till.

Värde	Description
NotSpecified	Tokentypen har inte angetts.
Any	Tokentypen kan vara vad som helst.
String	Tokentypen är sträng.
Object	Tokentypen är objekt.
Array	Tokentypen är matris.
Integer	Tokentypen är heltal.
Number	Tokentypen är tal.
Boolean	Tokentypen är boolesk.

AliasPattern

Objekt

Typ av mönster för en aliassökväg.

Name	Typ	Description
phrase	string	Frasen aliasmönster.
type	AliasPatternType	Typ av aliasmönster
variable	string	Aliasmönstervariabeln.

AliasPatternType

Uppräkning

Typ av aliasmönster

Värde	Description
NotSpecified	NotSpecified tillåts inte.
Extract	Extrahering är det enda tillåtna värdet.

AliasType

Uppräkning

Typ av alias.

Värde	Description
NotSpecified	Aliastypen är okänd (samma som att inte ange aliastyp).
PlainText	Aliasvärdet är inte hemligt.
Mask	Aliasvärdet är hemligt.

ApiProfile

Objekt

Name	Typ	Description
apiVersion	string	API-versionen.
profileVersion	string	Profilversionen.

BasicDependency

Objekt

Information om distributionsberoende.

Name	Typ	Description
id	string	Beroendets ID.
resourceName	string	Namnet på beroenderesursen.
resourceType	string	Beroenderesurstypen.

CloudError

Objekt

Ett felsvar för en resurshanteringsbegäran.

Name	Typ	Description
error	ErrorResponse	Felsvar Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.)

DebugSetting

Objekt

Felsökningsinställningen.

Name	Typ	Description
detailLevel	string	Anger vilken typ av information som ska loggas för felsökning. De tillåtna värdena är inga, requestContent, responseContent eller både requestContent och responseContent avgränsade med ett kommatecken. Standardvärdet är ingen. När du anger det här värdet bör du noga överväga vilken typ av information du skickar in under distributionen. Genom att logga information om begäran eller svaret kan du potentiellt exponera känsliga data som hämtas via distributionsåtgärderna.

Dependency

Objekt

Information om distributionsberoende.

Name	Typ	Description
dependsOn	BasicDependency[]	Listan över beroenden.
id	string	Beroendets ID.
resourceName	string	Namnet på beroenderesursen.
resourceType	string	Beroenderesurstypen.

Deployment

Objekt

Parametrar för distributionsåtgärd.

Name	Typ	Description
identity	DeploymentIdentity	Konfigurationen av hanterad identitet för en distribution.
location	string	Platsen där distributionsdata ska lagras.
properties	DeploymentProperties	Distributionsegenskaperna.
tags	object	Distributionstaggar

DeploymentDiagnosticsDefinition

Objekt

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
level	Level	Anger den ytterligare svarsnivån.
message	string	Felmeddelandet.
target	string	Felmålet.

DeploymentExtended

Objekt

Distributionsinformation.

Name	Typ	Description
id	string	ID:t för distributionen.
location	string	distributionens plats.
name	string	Namnet på utplaceringen.
properties	DeploymentPropertiesExtended	Distributionsegenskaper.
tags	object	Distributionstaggar
type	string	Typ av distribution.

DeploymentExtensionConfigItem

Objekt

Name	Typ	Description
keyVaultReference	KeyVaultParameterReference	Azure Key Vault-referensen som används för att hämta det hemliga värdet för egenskapen extension config.
type	ExtensionConfigPropertyType	Värdetypen för tilläggskonfigurationsegenskapen.
value		Värdet för egenskapen extension config.

DeploymentExtensionDefinition

Objekt

Name	Typ	Description
alias	string	Aliaset för tillägget enligt definitionen i distributionsmallen.
config	<string, DeploymentExtensionConfigItem>	Tilläggskonfigurationen.
configId	string	Konfigurations-ID:t för tillägget. Den identifierar unikt ett distributionskontrollplan i ett tillägg.
name	string	Tilläggsnamnet.
version	string	Tilläggsversionen.

DeploymentExternalInput

Objekt

Externa indata för distribution för parametrering.

Name	Typ	Description
value		Externt ingångsvärde.

DeploymentExternalInputDefinition

Objekt

Definition av externa indata för distribution för parametrisering.

Name	Typ	Description
config		Konfiguration för den externa ingången.
kind	string	Den typ av extern input.

DeploymentIdentity

Objekt

Konfigurationen av hanterad identitet för en distribution.

Name	Typ	Description
type	DeploymentIdentityType	Identitetstypen.
userAssignedIdentities	<string, UserAssignedIdentity>	Uppsättningen användartilldelade identiteter som är associerade med resursen.

DeploymentIdentityType

Uppräkning

Identitetstypen.

Värde	Description
None
UserAssigned

DeploymentMode

Uppräkning

Läget som används för att distribuera resurser. Det här värdet kan vara antingen Inkrementellt eller Slutfört. I inkrementellt läge distribueras resurser utan att befintliga resurser som inte ingår i mallen tas bort. I fullständigt läge distribueras resurser och befintliga resurser i resursgruppen som inte ingår i mallen tas bort. Var försiktig när du använder Slutfört läge eftersom du oavsiktligt kan ta bort resurser.

Värde	Description
Incremental
Complete

DeploymentParameter

Objekt

Distributionsparameter för mallen.

Name	Typ	Description
expression	string	Indatauttryck till parametern.
reference	KeyVaultParameterReference	Parameterreferens för Azure Key Vault.
value		Indatavärde till parametern .

DeploymentProperties

Objekt

Distributionsegenskaper.

Name	Typ	Description
debugSetting	DebugSetting	Felsökningsinställningen för distributionen.
expressionEvaluationOptions	ExpressionEvaluationOptions	Anger om malluttryck utvärderas inom omfånget för den överordnade mallen eller den kapslade mallen. Gäller endast för kapslade mallar. Om inget anges är standardvärdet yttre.
extensionConfigs	object	De konfigurationer som ska användas för distributionstillägg. Nycklarna för det här objektet är distributionstilläggsalias enligt definitionen i distributionsmallen.
externalInputDefinitions	<string, DeploymentExternalInputDefinition>	Definitioner av externa indata, som används av externa verktyg för att definiera förväntade externa indatavärden.
externalInputs	<string, DeploymentExternalInput>	Externa indatavärden som används av externa verktyg för parameterutvärdering.
mode	DeploymentMode	Läget som används för att distribuera resurser. Det här värdet kan vara antingen Inkrementellt eller Slutfört. I inkrementellt läge distribueras resurser utan att befintliga resurser som inte ingår i mallen tas bort. I fullständigt läge distribueras resurser och befintliga resurser i resursgruppen som inte ingår i mallen tas bort. Var försiktig när du använder Slutfört läge eftersom du oavsiktligt kan ta bort resurser.
onErrorDeployment	OnErrorDeployment	Distributionen på felbeteende.
parameters	<string, DeploymentParameter>	Namn- och värdepar som definierar distributionsparametrarna för mallen. Du använder det här elementet när du vill ange parametervärdena direkt i begäran i stället för att länka till en befintlig parameterfil. Använd antingen egenskapen parametersLink eller parameteregenskapen, men inte båda. Det kan vara en JObject- eller en välformulerad JSON-sträng.
parametersLink	ParametersLink	URI:n för parameterfilen. Du använder det här elementet för att länka till en befintlig parameterfil. Använd antingen egenskapen parametersLink eller parameteregenskapen, men inte båda.
template	object	Mallinnehållet. Du använder det här elementet när du vill skicka mallsyntaxen direkt i begäran i stället för att länka till en befintlig mall. Det kan vara en JObject- eller välformulerad JSON-sträng. Använd antingen egenskapen templateLink eller mallegenskapen, men inte båda.
templateLink	TemplateLink	Mallens URI. Använd antingen egenskapen templateLink eller mallegenskapen, men inte båda.
validationLevel	ValidationLevel	Valideringsnivån för distributionen

DeploymentPropertiesExtended

Objekt

Distributionsegenskaper med ytterligare information.

Name	Typ	Description
correlationId	string	Korrelations-ID för distributionen.
debugSetting	DebugSetting	Felsökningsinställningen för distributionen.
dependencies	Dependency[]	Listan över distributionsberoenden.
diagnostics	DeploymentDiagnosticsDefinition[]	Innehåller diagnostikinformation som samlats in under valideringsprocessen.
duration	string	Varaktigheten för malldistributionen.
error	ErrorResponse	Felsvar Distributionsfelet.
extensions	DeploymentExtensionDefinition[]	De tillägg som används i den här distributionen.
mode	DeploymentMode	Distributionsläget. Möjliga värden är Inkrementella och Slutför.
onErrorDeployment	OnErrorDeploymentExtended	Distributionen på felbeteende.
outputResources	ResourceReference[]	Matris med etablerade resurser.
outputs	object	Nyckel/värde-par som representerar distributionsutdata.
parameters	object	Distributionsparametrar.
parametersLink	ParametersLink	URI:n som refererar till parametrarna.
providers	Provider[]	Listan över resursprovidrar som behövs för distributionen.
provisioningState	ProvisioningState	Anger etableringstillståndet.
templateHash	string	Den hash som skapats för mallen.
templateLink	TemplateLink	URI:n som refererar till mallen.
timestamp	string (date-time)	Tidsstämpeln för malldistributionen.
validatedResources	ResourceReference[]	Matris med verifierade resurser.
validationLevel	ValidationLevel	Valideringsnivån för distributionen

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorResponse[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ExpressionEvaluationOptions

Objekt

Anger om malluttryck utvärderas inom omfånget för den överordnade mallen eller den kapslade mallen.

Name	Typ	Description
scope	ExpressionEvaluationOptionsScopeType	Det omfång som ska användas för utvärdering av parametrar, variabler och funktioner i en kapslad mall.

ExpressionEvaluationOptionsScopeType

Uppräkning

Det omfång som ska användas för utvärdering av parametrar, variabler och funktioner i en kapslad mall.

Värde	Description
NotSpecified
Outer
Inner

ExtensionConfigPropertyType

Uppräkning

Värde	Description
String	Egenskapstyp som representerar ett strängvärde.
Int	Egenskapstyp som representerar ett heltalsvärde.
Bool	Egenskapstyp som representerar ett booleskt värde.
Array	Egenskapstyp som representerar ett matrisvärde.
Object	Egenskapstyp som representerar ett objektvärde.
SecureString	Egenskapstyp som representerar ett säkert strängvärde.
SecureObject	Egenskapstyp som representerar ett säkert objektvärde.

KeyVaultParameterReference

Objekt

Parameterreferens för Azure Key Vault.

Name	Typ	Description
keyVault	KeyVaultReference	Azure Key Vault-referens.
secretName	string	Hemligt namn på Azure Key Vault.
secretVersion	string	Hemlig version av Azure Key Vault.

KeyVaultReference

Objekt

Azure Key Vault-referens.

Name	Typ	Description
id	string	Resurs-ID för Azure Key Vault.

Level

Uppräkning

Anger den ytterligare svarsnivån.

Värde	Description
Warning
Info
Error

OnErrorDeployment

Objekt

Distribution på felbeteende.

Name	Typ	Description
deploymentName	string	Distributionen som ska användas i felfall.
type	OnErrorDeploymentType	Distributionen på felbeteendetypen. Möjliga värden är LastSuccessful och SpecificDeployment.

OnErrorDeploymentExtended

Objekt

Distribution av felbeteende med ytterligare information.

Name	Typ	Description
deploymentName	string	Distributionen som ska användas i felfall.
provisioningState	string	Tillståndet för etableringen för on error-distributionen.
type	OnErrorDeploymentType	Distributionen på felbeteendetypen. Möjliga värden är LastSuccessful och SpecificDeployment.

OnErrorDeploymentType

Uppräkning

Distributionen på felbeteendetypen. Möjliga värden är LastSuccessful och SpecificDeployment.

Värde	Description
LastSuccessful
SpecificDeployment

ParametersLink

Objekt

Entitet som representerar referensen till distributionsparametrarna.

Name	Typ	Description
contentVersion	string	Om det ingår måste det matcha ContentVersion i mallen.
uri	string	URI:n för parameterfilen.

Provider

Objekt

Information om resursprovider.

Name	Typ	Description
id	string	Provider-ID:t.
namespace	string	Resursproviderns namnområde.
providerAuthorizationConsentState	ProviderAuthorizationConsentState	Tillstånd för providerauktoriseringsmedgivande.
registrationPolicy	string	Resursproviderns registreringsprincip.
registrationState	string	Resursproviderns registreringstillstånd.
resourceTypes	ProviderResourceType[]	Samlingen med providerresurstyper.

ProviderAuthorizationConsentState

Uppräkning

Tillstånd för providerauktoriseringsmedgivande.

Värde	Description
NotSpecified
Required
NotRequired
Consented

ProviderExtendedLocation

Objekt

Providerns utökade plats.

Name	Typ	Description
extendedLocations	string[]	De utökade platserna för azure-platsen.
location	string	Azure-platsen.
type	string	Den utökade platstypen.

ProviderResourceType

Objekt

Resurstyp som hanteras av resursprovidern.

Name	Typ	Description
aliases	Alias[]	De alias som stöds av den här resurstypen.
apiProfiles	ApiProfile[]	API-profilerna för resursprovidern.
apiVersions	string[]	API-versionen.
capabilities	string	De ytterligare funktioner som erbjuds av den här resurstypen.
defaultApiVersion	string	Standard-API-versionen.
locationMappings	ProviderExtendedLocation[]	Platsmappningar som stöds av den här resurstypen.
locations	string[]	Samlingen med platser där den här resurstypen kan skapas.
properties	object	Egenskaperna.
resourceType	string	Resurstypen.
zoneMappings	ZoneMapping[]

ProvisioningState

Uppräkning

Anger etableringstillståndet.

Värde	Description
NotSpecified
Accepted
Running
Ready
Creating
Created
Deleting
Deleted
Canceled
Failed
Succeeded
Updating

ResourceReference

Objekt

Resurs-ID-modellen.

Name	Typ	Description
apiVersion	string	Den API-version som resursen distribuerades med.
extension	DeploymentExtensionDefinition	Tillägget som resursen distribuerades med.
id	string	Det fullständigt kvalificerade Azure-resurs-ID:t.
identifiers	object	De utökningsbara resursidentifierarna.
resourceType	string	Resurstypen.

TemplateLink

Objekt

Entitet som representerar referensen till mallen.

Name	Typ	Description
contentVersion	string	Om det ingår måste det matcha ContentVersion i mallen.
id	string	Resurs-ID:t för en mallspecifikation. Använd antingen id- eller URI-egenskapen, men inte båda.
queryString	string	Frågesträngen (till exempel en SAS-token) som ska användas med templateLink-URI:n.
relativePath	string	Egenskapen relativePath kan användas för att distribuera en länkad mall på en plats i förhållande till den överordnade. Om den överordnade mallen var länkad till en TemplateSpec refererar den till en artefakt i TemplateSpec. Om den överordnade var länkad till en URI är den underordnade distributionen en kombination av överordnade och relativaPath-URI:er
uri	string	URI:n för mallen som ska distribueras. Använd antingen egenskapen URI eller ID, men inte båda.

UserAssignedIdentity

Objekt

Användartilldelade identitetsegenskaper

Name	Typ	Description
clientId	string (uuid)	Klient-ID för den tilldelade identiteten.
principalId	string (uuid)	Huvud-ID för den tilldelade identiteten.

ValidationLevel

Uppräkning

Valideringsnivån som utförs på distributionen.

Värde	Description
Template	Statisk analys av mallen utförs.
Provider	Statisk analys av mallen utförs och resursdeklarationer skickas till resursproviders för semantisk validering. Verifierar att anroparen har RBAC-skrivbehörighet för varje resurs.
ProviderNoRbac	Statisk analys av mallen utförs och resursdeklarationer skickas till resursproviders för semantisk validering. Hoppar över verifieringen av att anroparen har RBAC-skrivbehörighet för varje resurs.

ZoneMapping

Objekt

Name	Typ	Description
location	string	Platsen för zonmappningen.
zones	string[]

Dela via

Deployments - Create Or Update

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

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

Exempelbegäran

Exempelsvar

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

Exempelbegäran

Exempelsvar

Create a deployment that will redeploy another deployment on failure

Exempelbegäran

Exempelsvar

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

Exempelbegäran

Exempelsvar

Create deployment using external inputs

Exempelbegäran

Exempelsvar

Definitioner

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