Deployments - Create Or Update

Servicio:

Resource Management

Versión de la API:

2021-04-01

Implementa recursos en un grupo de recursos.
Puede proporcionar la plantilla y los parámetros directamente en la solicitud o vínculo a archivos JSON.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
deploymentName	path	True	string	Nombre de la implementación. Patrón de Regex: ^[-\w\._\(\)]+$
resourceGroupName	path	True	string	Nombre del grupo de recursos en el que se van a implementar los recursos. El nombre distingue mayúsculas de minúsculas. El grupo de recursos ya debe existir. Patrón de Regex: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Identificador de suscripción de Microsoft Azure.
api-version	query	True	string	Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties	True	DeploymentProperties	Propiedades de implementación.
location		string	Ubicación para almacenar los datos de implementación.
tags		object	Etiquetas de implementación

Respuestas

Nombre	Tipo	Description
200 OK	DeploymentExtended	Aceptar: devuelve información sobre la implementación, incluido el estado de aprovisionamiento.
201 Created	DeploymentExtended	Creado: devuelve información sobre la implementación, incluido el estado de aprovisionamiento.
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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 a deployment that will deploy a template with a uri and queryString

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000001/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment?api-version=2021-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"
  }
}

Go

package armresources_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/armresources"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4fd842fb73656039ec94ce367bcedee25a57bd18/specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PutDeploymentResourceGroup.json
func ExampleDeploymentsClient_BeginCreateOrUpdate_createADeploymentThatWillDeployATemplateWithAUriAndQueryString() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDeploymentsClient().BeginCreateOrUpdate(ctx, "my-resource-group", "my-deployment", armresources.Deployment{
		Properties: &armresources.DeploymentProperties{
			Mode:       to.Ptr(armresources.DeploymentModeIncremental),
			Parameters: map[string]any{},
			TemplateLink: &armresources.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 = armresources.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: &armresources.DeploymentPropertiesExtended{
	// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		Dependencies: []*armresources.Dependency{
	// 		},
	// 		Duration: to.Ptr("PT22.8356799S"),
	// 		Mode: to.Ptr(armresources.DeploymentModeIncremental),
	// 		OutputResources: []*armresources.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: []*armresources.Provider{
	// 			{
	// 				Namespace: to.Ptr("Microsoft.Storage"),
	// 				ResourceTypes: []*armresources.ProviderResourceType{
	// 					{
	// 						Locations: []*string{
	// 							to.Ptr("eastus")},
	// 							ResourceType: to.Ptr("storageAccounts"),
	// 					}},
	// 			}},
	// 			ProvisioningState: to.Ptr(armresources.ProvisioningStateSucceeded),
	// 			TemplateHash: to.Ptr("0000000000000000000"),
	// 			TemplateLink: &armresources.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

JavaScript

const { ResourceManagementClient } = require("@azure/arm-resources");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * 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/stable/2021-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 ResourceManagementClient(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

Respuesta de muestra

status code:

200

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

status code:

201

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

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

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000001/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment?api-version=2021-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"
  }
}

Go

package armresources_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/armresources"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4fd842fb73656039ec94ce367bcedee25a57bd18/specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json
func ExampleDeploymentsClient_BeginCreateOrUpdate_createADeploymentThatWillDeployATemplateSpecWithTheGivenResourceId() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDeploymentsClient().BeginCreateOrUpdate(ctx, "my-resource-group", "my-deployment", armresources.Deployment{
		Properties: &armresources.DeploymentProperties{
			Mode:       to.Ptr(armresources.DeploymentModeIncremental),
			Parameters: map[string]any{},
			TemplateLink: &armresources.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 = armresources.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: &armresources.DeploymentPropertiesExtended{
	// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		Dependencies: []*armresources.Dependency{
	// 		},
	// 		Duration: to.Ptr("PT22.8356799S"),
	// 		Mode: to.Ptr(armresources.DeploymentModeIncremental),
	// 		OutputResources: []*armresources.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: []*armresources.Provider{
	// 			{
	// 				Namespace: to.Ptr("Microsoft.Storage"),
	// 				ResourceTypes: []*armresources.ProviderResourceType{
	// 					{
	// 						Locations: []*string{
	// 							to.Ptr("eastus")},
	// 							ResourceType: to.Ptr("storageAccounts"),
	// 					}},
	// 			}},
	// 			ProvisioningState: to.Ptr(armresources.ProvisioningStateSucceeded),
	// 			TemplateHash: to.Ptr("0000000000000000000"),
	// 			TemplateLink: &armresources.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

JavaScript

const { ResourceManagementClient } = require("@azure/arm-resources");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * 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/stable/2021-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 ResourceManagementClient(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

Respuesta de muestra

status code:

200

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

status code:

201

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

Create a deployment that will redeploy another deployment on failure

Solicitud de ejemplo

HTTP

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

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

Go

package armresources_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/armresources"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4fd842fb73656039ec94ce367bcedee25a57bd18/specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json
func ExampleDeploymentsClient_BeginCreateOrUpdate_createADeploymentThatWillRedeployAnotherDeploymentOnFailure() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDeploymentsClient().BeginCreateOrUpdate(ctx, "my-resource-group", "my-deployment", armresources.Deployment{
		Properties: &armresources.DeploymentProperties{
			Mode: to.Ptr(armresources.DeploymentModeComplete),
			OnErrorDeployment: &armresources.OnErrorDeployment{
				Type:           to.Ptr(armresources.OnErrorDeploymentTypeSpecificDeployment),
				DeploymentName: to.Ptr("name-of-deployment-to-use"),
			},
			Parameters: map[string]any{},
			TemplateLink: &armresources.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 = armresources.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: &armresources.DeploymentPropertiesExtended{
	// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		Dependencies: []*armresources.Dependency{
	// 			{
	// 				DependsOn: []*armresources.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: []*armresources.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(armresources.DeploymentModeComplete),
	// 		OnErrorDeployment: &armresources.OnErrorDeploymentExtended{
	// 			Type: to.Ptr(armresources.OnErrorDeploymentTypeSpecificDeployment),
	// 			DeploymentName: to.Ptr("name-of-deployment-to-use"),
	// 		},
	// 		Parameters: map[string]any{
	// 		},
	// 		Providers: []*armresources.Provider{
	// 			{
	// 				Namespace: to.Ptr("Microsoft.Network"),
	// 				ResourceTypes: []*armresources.ProviderResourceType{
	// 					{
	// 						Locations: []*string{
	// 							to.Ptr("centralus")},
	// 							ResourceType: to.Ptr("virtualNetworks"),
	// 						},
	// 						{
	// 							Locations: []*string{
	// 								to.Ptr("centralus")},
	// 								ResourceType: to.Ptr("virtualNetworks/subnets"),
	// 						}},
	// 				}},
	// 				ProvisioningState: to.Ptr(armresources.ProvisioningStateSucceeded),
	// 				TemplateLink: &armresources.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

JavaScript

const { ResourceManagementClient } = require("@azure/arm-resources");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * 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/stable/2021-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 ResourceManagementClient(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

Respuesta de muestra

status code:

200

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

status code:

201

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

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

Solicitud de ejemplo

HTTP

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

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

Go

package armresources_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/armresources"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4fd842fb73656039ec94ce367bcedee25a57bd18/specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json
func ExampleDeploymentsClient_BeginCreateOrUpdate_createADeploymentThatWillRedeployTheLastSuccessfulDeploymentOnFailure() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDeploymentsClient().BeginCreateOrUpdate(ctx, "my-resource-group", "my-deployment", armresources.Deployment{
		Properties: &armresources.DeploymentProperties{
			Mode: to.Ptr(armresources.DeploymentModeComplete),
			OnErrorDeployment: &armresources.OnErrorDeployment{
				Type: to.Ptr(armresources.OnErrorDeploymentTypeLastSuccessful),
			},
			Parameters: map[string]any{},
			TemplateLink: &armresources.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 = armresources.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: &armresources.DeploymentPropertiesExtended{
	// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		Dependencies: []*armresources.Dependency{
	// 			{
	// 				DependsOn: []*armresources.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: []*armresources.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(armresources.DeploymentModeComplete),
	// 		OnErrorDeployment: &armresources.OnErrorDeploymentExtended{
	// 			Type: to.Ptr(armresources.OnErrorDeploymentTypeLastSuccessful),
	// 			DeploymentName: to.Ptr("{nameOfLastSuccesfulDeployment}"),
	// 		},
	// 		Parameters: map[string]any{
	// 		},
	// 		Providers: []*armresources.Provider{
	// 			{
	// 				Namespace: to.Ptr("Microsoft.Network"),
	// 				ResourceTypes: []*armresources.ProviderResourceType{
	// 					{
	// 						Locations: []*string{
	// 							to.Ptr("centralus")},
	// 							ResourceType: to.Ptr("virtualNetworks"),
	// 						},
	// 						{
	// 							Locations: []*string{
	// 								to.Ptr("centralus")},
	// 								ResourceType: to.Ptr("virtualNetworks/subnets"),
	// 						}},
	// 				}},
	// 				ProvisioningState: to.Ptr(armresources.ProvisioningStateSucceeded),
	// 				TemplateLink: &armresources.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

JavaScript

const { ResourceManagementClient } = require("@azure/arm-resources");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * 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/stable/2021-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 ResourceManagementClient(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

Respuesta de muestra

status code:

200

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

status code:

201

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

Definiciones

Nombre	Description
Alias	Tipo de alias.
AliasPath	Tipo de las rutas de acceso para alias.
AliasPathAttributes	Atributos del token al que hace referencia la ruta de acceso del alias.
AliasPathMetadata
AliasPathTokenType	Tipo del token al que hace referencia la ruta de acceso del alias.
AliasPattern	Tipo del patrón para una ruta de acceso de alias.
AliasPatternType	Tipo de patrón de alias
AliasType	Tipo del alias.
ApiProfile
BasicDependency	Información de dependencias de la implementación.
CloudError	Una respuesta de error para una solicitud de administración de recursos.
DebugSetting	Configuración de depuración.
Dependency	Información de dependencias de la implementación.
Deployment	Parámetros de operación de implementación.
DeploymentExtended	Información de implementación.
DeploymentMode	Modo que se usa para implementar recursos. Este valor puede ser Incremental o Complete. En el modo Incremental, los recursos se implementan sin eliminar los recursos existentes que no están incluidos en la plantilla. En el modo Completo, los recursos se implementan y se eliminan los recursos existentes del grupo de recursos que no están incluidos en la plantilla. Tenga cuidado al usar el modo Completo, ya que puede eliminar accidentalmente los recursos.
DeploymentProperties	Propiedades de implementación.
DeploymentPropertiesExtended	Propiedades de implementación con detalles adicionales.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorResponse	Respuesta de error
ExpressionEvaluationOptions	Especifica si las expresiones de plantilla se evalúan dentro del ámbito de la plantilla primaria o de la plantilla anidada.
ExpressionEvaluationOptionsScopeType	Ámbito que se va a usar para la evaluación de parámetros, variables y funciones en una plantilla anidada.
OnErrorDeployment	Implementación en el comportamiento del error.
OnErrorDeploymentExtended	Implementación en el comportamiento de errores con detalles adicionales.
OnErrorDeploymentType	La implementación en el tipo de comportamiento de error. Los valores posibles son LastSuccessful y SpecificDeployment.
ParametersLink	Entidad que representa la referencia a los parámetros de implementación.
Provider	Información de proveedor de recursos.
ProviderAuthorizationConsentState	Estado de consentimiento de autorización del proveedor.
ProviderExtendedLocation	Ubicación extendida del proveedor.
ProviderResourceType	Tipo de recurso que administra el proveedor de recursos.
ProvisioningState	Indica el estado del aprovisionamiento.
ResourceReference	Modelo de identificador de recurso.
TemplateLink	Entidad que representa la referencia a la plantilla.
ZoneMapping

Alias

Tipo de alias.

Nombre	Tipo	Description
defaultMetadata	AliasPathMetadata	Metadatos de ruta de acceso de alias predeterminados. Se aplica a la ruta de acceso predeterminada y a cualquier ruta de acceso de alias que no tenga metadatos.
defaultPath	string	Ruta de acceso predeterminada para un alias.
defaultPattern	AliasPattern	Patrón predeterminado para un alias.
name	string	Nombre del alias.
paths	AliasPath[]	Rutas de acceso de un alias.
type	AliasType	Tipo del alias.

AliasPath

Tipo de las rutas de acceso para alias.

Nombre	Tipo	Description
apiVersions	string[]	Las versiones de la API.
metadata	AliasPathMetadata	Metadatos de la ruta de acceso del alias. Si falta, vuelva a los metadatos predeterminados del alias.
path	string	Ruta de acceso de un alias.
pattern	AliasPattern	Patrón de una ruta de acceso de alias.

AliasPathAttributes

Atributos del token al que hace referencia la ruta de acceso del alias.

Nombre	Tipo	Description
Modifiable	string	El token al que hace referencia la ruta de acceso del alias es modificable por las directivas con efecto "modify".
None	string	El token al que hace referencia la ruta de acceso del alias no tiene atributos.

AliasPathMetadata

Nombre	Tipo	Description
attributes	AliasPathAttributes	Atributos del token al que hace referencia la ruta de acceso del alias.
type	AliasPathTokenType	Tipo del token al que hace referencia la ruta de acceso del alias.

AliasPathTokenType

Tipo del token al que hace referencia la ruta de acceso del alias.

Nombre	Tipo	Description
Any	string	El tipo de token puede ser cualquier cosa.
Array	string	El tipo de token es array.
Boolean	string	El tipo de token es booleano.
Integer	string	El tipo de token es entero.
NotSpecified	string	No se especifica el tipo de token.
Number	string	El tipo de token es number.
Object	string	El tipo de token es object.
String	string	El tipo de token es string.

AliasPattern

Tipo del patrón para una ruta de acceso de alias.

Nombre	Tipo	Description
phrase	string	Frase de patrón de alias.
type	AliasPatternType	Tipo de patrón de alias
variable	string	Variable de patrón de alias.

AliasPatternType

Tipo de patrón de alias

Nombre	Tipo	Description
Extract	string	Extraer es el único valor permitido.
NotSpecified	string	No se permite NotSpecified.

AliasType

Tipo del alias.

Nombre	Tipo	Description
Mask	string	El valor del alias es secreto.
NotSpecified	string	El tipo de alias es desconocido (igual que no proporcionar el tipo de alias).
PlainText	string	El valor de alias no es secreto.

ApiProfile

Nombre	Tipo	Description
apiVersion	string	Versión de la API.
profileVersion	string	La versión del perfil.

BasicDependency

Información de dependencias de la implementación.

Nombre	Tipo	Description
id	string	Identificador de la dependencia.
resourceName	string	Nombre del recurso de dependencia.
resourceType	string	Tipo de recurso de dependencia.

CloudError

Una respuesta de error para una solicitud de administración de recursos.

Nombre	Tipo	Description
error	ErrorResponse	Respuesta de error Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

DebugSetting

Configuración de depuración.

Nombre	Tipo	Description
detailLevel	string	Especifica el tipo de información que se va a registrar para la depuración. Los valores permitidos no son ninguno, requestContent, responseContent o requestContent y responseContent separados por una coma. El valor predeterminado es none. Al establecer este valor, tenga en cuenta cuidadosamente el tipo de información que está pasando durante la implementación. Al registrar información sobre la solicitud o la respuesta, se podrían exponer datos confidenciales que se recuperan en las operaciones de implementación.

Dependency

Información de dependencias de la implementación.

Nombre	Tipo	Description
dependsOn	BasicDependency[]	La lista de dependencias.
id	string	Identificador de la dependencia.
resourceName	string	Nombre del recurso de dependencia.
resourceType	string	Tipo de recurso de dependencia.

Deployment

Parámetros de operación de implementación.

Nombre	Tipo	Description
location	string	Ubicación para almacenar los datos de implementación.
properties	DeploymentProperties	Propiedades de implementación.
tags	object	Etiquetas de implementación

DeploymentExtended

Información de implementación.

Nombre	Tipo	Description
id	string	Identificador de la implementación.
location	string	la ubicación de la implementación.
name	string	Nombre de la implementación.
properties	DeploymentPropertiesExtended	Propiedades de implementación.
tags	object	Etiquetas de implementación
type	string	El tipo de la implementación.

DeploymentMode

Modo que se usa para implementar recursos. Este valor puede ser Incremental o Complete. En el modo Incremental, los recursos se implementan sin eliminar los recursos existentes que no están incluidos en la plantilla. En el modo Completo, los recursos se implementan y se eliminan los recursos existentes del grupo de recursos que no están incluidos en la plantilla. Tenga cuidado al usar el modo Completo, ya que puede eliminar accidentalmente los recursos.

Nombre	Tipo	Description
Complete	string
Incremental	string

DeploymentProperties

Propiedades de implementación.

Nombre	Tipo	Description
debugSetting	DebugSetting	Configuración de depuración de la implementación.
expressionEvaluationOptions	ExpressionEvaluationOptions	Especifica si las expresiones de plantilla se evalúan dentro del ámbito de la plantilla primaria o de la plantilla anidada. Solo se aplica a las plantillas anidadas. Si no se especifica, el valor predeterminado es externo.
mode	DeploymentMode	Modo que se usa para implementar recursos. Este valor puede ser Incremental o Complete. En el modo Incremental, los recursos se implementan sin eliminar los recursos existentes que no están incluidos en la plantilla. En el modo Completo, los recursos se implementan y se eliminan los recursos existentes del grupo de recursos que no están incluidos en la plantilla. Tenga cuidado al usar el modo Completo, ya que puede eliminar accidentalmente los recursos.
onErrorDeployment	OnErrorDeployment	Implementación en el comportamiento del error.
parameters	object	Pares de nombre y valor que definen los parámetros de implementación de la plantilla. Use este elemento cuando desee proporcionar los valores de parámetro directamente en la solicitud en lugar de vincular a un archivo de parámetros existente. Use la propiedad parametersLink o la propiedad parameters, pero no ambas. Puede ser un JObject o una cadena JSON bien formada.
parametersLink	ParametersLink	Identificador URI del archivo de parámetros. Este elemento se usa para vincular a un archivo de parámetros existente. Use la propiedad parametersLink o la propiedad parameters, pero no ambas.
template	object	Contenido de la plantilla. Use este elemento cuando desee pasar la sintaxis de plantilla directamente en la solicitud en lugar de vincularla a una plantilla existente. Puede ser una cadena JSON con formato correcto o JObject. Use la propiedad templateLink o la propiedad template, pero no ambas.
templateLink	TemplateLink	URI de la plantilla. Use la propiedad templateLink o la propiedad template, pero no ambas.

DeploymentPropertiesExtended

Propiedades de implementación con detalles adicionales.

Nombre	Tipo	Description
correlationId	string	Identificador de correlación de la implementación.
debugSetting	DebugSetting	Configuración de depuración de la implementación.
dependencies	Dependency[]	Lista de dependencias de implementación.
duration	string	Duración de la implementación de la plantilla.
error	ErrorResponse	Respuesta de error Error de implementación.
mode	DeploymentMode	Modo de implementación. Los valores posibles son Incremental y Complete.
onErrorDeployment	OnErrorDeploymentExtended	Implementación en el comportamiento del error.
outputResources	ResourceReference[]	Matriz de recursos aprovisionados.
outputs	object	Pares clave-valor que representan la salida de la implementación.
parameters	object	Parámetros de implementación.
parametersLink	ParametersLink	Identificador URI que hace referencia a los parámetros.
providers	Provider[]	Lista de proveedores de recursos necesarios para la implementación.
provisioningState	ProvisioningState	Indica el estado del aprovisionamiento.
templateHash	string	Hash generado para la plantilla.
templateLink	TemplateLink	Identificador URI que hace referencia a la plantilla.
timestamp	string	Marca de tiempo de la implementación de la plantilla.
validatedResources	ResourceReference[]	Matriz de recursos validados.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorResponse[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ExpressionEvaluationOptions

Especifica si las expresiones de plantilla se evalúan dentro del ámbito de la plantilla primaria o de la plantilla anidada.

Nombre	Tipo	Description
scope	ExpressionEvaluationOptionsScopeType	Ámbito que se va a usar para la evaluación de parámetros, variables y funciones en una plantilla anidada.

ExpressionEvaluationOptionsScopeType

Ámbito que se va a usar para la evaluación de parámetros, variables y funciones en una plantilla anidada.

Nombre	Tipo	Description
Inner	string
NotSpecified	string
Outer	string

OnErrorDeployment

Implementación en el comportamiento del error.

Nombre	Tipo	Description
deploymentName	string	Implementación que se va a usar en caso de error.
type	OnErrorDeploymentType	La implementación en el tipo de comportamiento de error. Los valores posibles son LastSuccessful y SpecificDeployment.

OnErrorDeploymentExtended

Implementación en el comportamiento de errores con detalles adicionales.

Nombre	Tipo	Description
deploymentName	string	Implementación que se va a usar en caso de error.
provisioningState	string	Estado del aprovisionamiento para la implementación en caso de error.
type	OnErrorDeploymentType	La implementación en el tipo de comportamiento de error. Los valores posibles son LastSuccessful y SpecificDeployment.

OnErrorDeploymentType

La implementación en el tipo de comportamiento de error. Los valores posibles son LastSuccessful y SpecificDeployment.

Nombre	Tipo	Description
LastSuccessful	string
SpecificDeployment	string

ParametersLink

Entidad que representa la referencia a los parámetros de implementación.

Nombre	Tipo	Description
contentVersion	string	Si se incluye, debe coincidir con ContentVersion en la plantilla.
uri	string	Identificador URI del archivo de parámetros.

Provider

Información de proveedor de recursos.

Nombre	Tipo	Description
id	string	La identificación del proveedor.
namespace	string	Espacio de nombres del proveedor de recursos.
providerAuthorizationConsentState	ProviderAuthorizationConsentState	Estado de consentimiento de autorización del proveedor.
registrationPolicy	string	Directiva de registro del proveedor de recursos.
registrationState	string	Estado de registro del proveedor de recursos.
resourceTypes	ProviderResourceType[]	Colección de tipos de recursos de proveedor.

ProviderAuthorizationConsentState

Estado de consentimiento de autorización del proveedor.

Nombre	Tipo	Description
Consented	string
NotRequired	string
NotSpecified	string
Required	string

ProviderExtendedLocation

Ubicación extendida del proveedor.

Nombre	Tipo	Description
extendedLocations	string[]	Ubicaciones extendidas para la ubicación de Azure.
location	string	Ubicación de Azure.
type	string	Tipo de ubicación extendida.

ProviderResourceType

Tipo de recurso que administra el proveedor de recursos.

Nombre	Tipo	Description
aliases	Alias[]	Alias admitidos por este tipo de recurso.
apiProfiles	ApiProfile[]	Perfiles de API para el proveedor de recursos.
apiVersions	string[]	Versión de la API.
capabilities	string	Las funcionalidades adicionales que ofrece este tipo de recurso.
defaultApiVersion	string	Versión de API predeterminada.
locationMappings	ProviderExtendedLocation[]	Asignaciones de ubicación admitidas por este tipo de recurso.
locations	string[]	Colección de ubicaciones donde se puede crear este tipo de recurso.
properties	object	Propiedades.
resourceType	string	El tipo de recurso.
zoneMappings	ZoneMapping[]

ProvisioningState

Indica el estado del aprovisionamiento.

Nombre	Tipo	Description
Accepted	string
Canceled	string
Created	string
Creating	string
Deleted	string
Deleting	string
Failed	string
NotSpecified	string
Ready	string
Running	string
Succeeded	string
Updating	string

ResourceReference

Modelo de identificador de recurso.

Nombre	Tipo	Description
id	string	Identificador de recurso completo.

TemplateLink

Entidad que representa la referencia a la plantilla.

Nombre	Tipo	Description
contentVersion	string	Si se incluye, debe coincidir con ContentVersion en la plantilla.
id	string	Identificador de recurso de una especificación de plantilla. Use la propiedad id o uri, pero no ambas.
queryString	string	Cadena de consulta (por ejemplo, un token de SAS) que se va a usar con el URI templateLink.
relativePath	string	La propiedad relativePath se puede usar para implementar una plantilla vinculada en una ubicación relativa al elemento primario. Si la plantilla primaria estaba vinculada a templateSpec, se hará referencia a un artefacto en TemplateSpec. Si el elemento primario estaba vinculado a un URI, la implementación secundaria será una combinación de los URI primarios y relativePath.
uri	string	URI de la plantilla que se va a implementar. Use la propiedad URI o id, pero no ambas.

ZoneMapping

Nombre	Tipo	Description
location	string	Ubicación de la asignación de zona.
zones	string[]