Compartir a través de


Deployments - Create Or Update At Subscription Scope

Implementa recursos en el ámbito de la suscripción.
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}/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\._\(\)]+$

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 templateSpec with the given resourceId

Solicitud de ejemplo

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

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

Respuesta de muestra

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "location": "eastus",
  "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:51:58.6288067Z",
    "duration": "PT1.2637681S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [],
    "dependencies": [],
    "outputResources": []
  }
}
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "location": "eastus",
  "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:51:58.6288067Z",
    "duration": "PT1.2637681S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [],
    "dependencies": []
  }
}

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

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.

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[]