---
title: "PUT /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}"
method: PUT
path: "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}"
tags: ["Deployments"]
---

# PUT /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}

`PUT /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}`

Create a named template deployment using a template.

## Path parameters

- `resourceGroupName` string, required
- `deploymentName` string, required
- `subscriptionId` string, required

## Query parameters

- `api-version` string, required

## Request body

- Deployment — Deployment operation parameters.
  - `properties` DeploymentProperties — Deployment properties.
    - `templateLink` TemplateLink, required — Entity representing the reference to the template.
      - `uri` 'https://raw.githubusercontent.com/stankovski/azure-rest-api-specs/master/arm-compute/quickstart-templates/vm-simple-linux.json', required — URI referencing the template.
    - `parameters` DeploymentParameters
      - `adminUsername` object
        - `value` string, required — Username for the Virtual Machine.
      - `adminPassword` object
        - `value` string, password, required — Password for the Virtual Machine.
      - `dnsLabelPrefix` object
        - `value` string, required — Unique DNS Name for the Public IP used to access the Virtual Machine.
      - `osVersion` object — Deployment operation parameters.
        - `value` '12.04.5-LTS' | '14.04.2-LTS' | '15.10', required — The OS version for the VM. This will pick a fully patched image of this given OS version.
    - `mode` 'Incremental', required — Gets or sets the deployment mode.

## Response `200`

OK

- DeploymentExtended — Deployment information.
  - `id` string — Gets or sets the ID of the deployment.
  - `name` string, required — Gets or sets the name of the deployment.
  - `properties` DeploymentPropertiesExtended — Deployment properties with additional details.
    - `provisioningState` string — Gets or sets the state of the provisioning.
    - `correlationId` string — Gets or sets the correlation ID of the deployment.
    - `timestamp` string, date-time — Gets or sets the timestamp of the template deployment.
    - `outputs` object — Gets or sets key/value pairs that represent deployment output.
    - `providers` Provider[] — Gets the list of resource providers needed for the deployment.
      - `id` string — Gets or sets the provider id.
      - `namespace` string — Gets or sets the namespace of the provider.
      - `registrationState` string — Gets or sets the registration state of the provider.
      - `resourceTypes` ProviderResourceType[] — Gets or sets the collection of provider resource types.
        - `resourceType` string — Gets or sets the resource type.
        - `locations` string[] — Gets or sets the collection of locations where this resource type can be created in.
        - `apiVersions` string[] — Gets or sets the api version.
        - `properties` object — Gets or sets the properties.
    - `dependencies` Dependency[] — Gets the list of deployment dependencies.
      - `dependsOn` BasicDependency[] — Gets the list of dependencies.
        - `id` string — Gets or sets the ID of the dependency.
        - `resourceType` string — Gets or sets the dependency resource type.
        - `resourceName` string — Gets or sets the dependency resource name.
      - `id` string — Gets or sets the ID of the dependency.
      - `resourceType` string — Gets or sets the dependency resource type.
      - `resourceName` string — Gets or sets the dependency resource name.
    - `template` object — Gets or sets the template content. Use only one of Template or TemplateLink.
    - `templateLink` TemplateLink — Entity representing the reference to the template.
      - `uri` 'https://raw.githubusercontent.com/stankovski/azure-rest-api-specs/master/arm-compute/quickstart-templates/vm-simple-linux.json', required — URI referencing the template.
    - `parameters` object — Deployment parameters. Use only one of Parameters or ParametersLink.
    - `parametersLink` ParametersLink — Entity representing the reference to the deployment parameters.
      - `uri` string, required — URI referencing the template.
      - `contentVersion` string — If included it must match the ContentVersion in the template.
    - `mode` 'Incremental' | 'Complete' — Gets or sets the deployment mode.

## Other responses

- `201` — Created

---

[API](https://skmtc.dev/azure/apis/computemanagementconvenienceclient.md) · [All operations](https://skmtc.dev/azure/apis/computemanagementconvenienceclient/llms.txt) · [OpenAPI document](https://skmtc.dev/azure/apis/computemanagementconvenienceclient/revisions/bd700fd8740d?raw)