Deployments - Create Or Update At Tenant Scope

Implementa recursos en el ámbito del inquilino.
Puede proporcionar la plantilla y los parámetros directamente en la solicitud o vínculo a archivos JSON.

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

Parámetros de identificador URI

Name In Required Type Description
deploymentName
path True
  • string

Nombre de la implementación.

Regex pattern: ^[-\w\._\(\)]+$

api-version
query True
  • string

Versión de API que se usará para la operación.

Cuerpo de la solicitud

Name Required Type Description
location True
  • string

Ubicación para almacenar los datos de implementación.

properties True

Propiedades de implementación.

tags
  • object

Etiquetas de implementación

Respuestas

Name Type Description
200 OK

Aceptar: devuelve información sobre la implementación, incluido el estado de aprovisionamiento.

201 Created

Creado: devuelve información sobre la implementación, incluido el estado de aprovisionamiento.

Other Status Codes

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

Create deployment at tenant scope.

Sample Request

PUT https://management.azure.com/providers/Microsoft.Resources/deployments/tenant-dep01?api-version=2021-04-01

{
  "location": "eastus",
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json"
    },
    "parameters": {},
    "mode": "Incremental"
  },
  "tags": {
    "tagKey1": "tag-value-1",
    "tagKey2": "tag-value-2"
  }
}

Sample Response

{
  "id": "/providers/Microsoft.Resources/deployments/tenant-dep01",
  "name": "tenant-dep01",
  "type": "Microsoft.Resources/deployments",
  "location": "eastus",
  "properties": {
    "parameters": {},
    "mode": "Incremental",
    "provisioningState": "Accepted",
    "timestamp": "2019-04-24T22:52:38.7895563Z",
    "duration": "PT1.2970875S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Authorization",
        "resourceTypes": [
          {
            "resourceType": "policyDefinitions",
            "locations": [
              null
            ]
          },
          {
            "resourceType": "policyAssignments",
            "locations": [
              null
            ]
          }
        ]
      },
      {
        "namespace": "Microsoft.Resources",
        "resourceTypes": [
          {
            "resourceType": "deployments",
            "locations": [
              "eastus"
            ]
          }
        ]
      }
    ],
    "dependencies": [
      {
        "dependsOn": [
          {
            "id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
            "resourceType": "Microsoft.Authorization/policyDefinitions",
            "resourceName": "policy-definition-name"
          }
        ],
        "id": "/providers/Microsoft.Authorization/policyAssignments/location-lock",
        "resourceType": "Microsoft.Authorization/policyAssignments",
        "resourceName": "location-lock"
      }
    ]
  },
  "tags": {
    "tagKey1": "tag-value-1",
    "tagKey2": "tag-value-2"
  }
}
{
  "id": "/providers/Microsoft.Resources/deployments/tenant-dep01",
  "name": "tenant-dep01",
  "type": "Microsoft.Resources/deployments",
  "location": "eastus",
  "properties": {
    "parameters": {},
    "mode": "Incremental",
    "provisioningState": "Accepted",
    "timestamp": "2019-04-24T22:52:38.7895563Z",
    "duration": "PT1.2970875S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Authorization",
        "resourceTypes": [
          {
            "resourceType": "policyDefinitions",
            "locations": [
              null
            ]
          },
          {
            "resourceType": "policyAssignments",
            "locations": [
              null
            ]
          }
        ]
      },
      {
        "namespace": "Microsoft.Resources",
        "resourceTypes": [
          {
            "resourceType": "deployments",
            "locations": [
              "eastus"
            ]
          }
        ]
      }
    ],
    "dependencies": [
      {
        "dependsOn": [
          {
            "id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
            "resourceType": "Microsoft.Authorization/policyDefinitions",
            "resourceName": "policy-definition-name"
          }
        ],
        "id": "/providers/Microsoft.Authorization/policyAssignments/location-lock",
        "resourceType": "Microsoft.Authorization/policyAssignments",
        "resourceName": "location-lock"
      }
    ]
  },
  "tags": {
    "tagKey1": "tag-value-1",
    "tagKey2": "tag-value-2"
  }
}

Definiciones

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.

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.

ScopedDeployment

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

TemplateLink

Entidad que representa la referencia a la plantilla.

ZoneMapping

Alias

Tipo de alias.

Name Type Description
defaultMetadata

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

Patrón predeterminado para un alias.

name
  • string

Nombre del alias.

paths

Rutas de acceso de un alias.

type

Tipo del alias.

AliasPath

Tipo de las rutas de acceso para alias.

Name Type Description
apiVersions
  • string[]

Las versiones de la API.

metadata

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

Patrón de una ruta de acceso de alias.

AliasPathAttributes

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

Name Type 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

Name Type Description
attributes

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

type

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.

Name Type 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.

Name Type Description
phrase
  • string

Frase de patrón de alias.

type

Tipo de patrón de alias

variable
  • string

Variable de patrón de alias.

AliasPatternType

Tipo de patrón de alias

Name Type Description
Extract
  • string

Extraer es el único valor permitido.

NotSpecified
  • string

No se permite NotSpecified.

AliasType

Tipo del alias.

Name Type 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

Name Type Description
apiVersion
  • string

Versión de la API.

profileVersion
  • string

La versión del perfil.

BasicDependency

Información de dependencias de la implementación.

Name Type 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.

Name Type Description
error

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.

Name Type 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.

Name Type Description
dependsOn

La lista de dependencias.

id
  • string

Identificador de la dependencia.

resourceName
  • string

Nombre del recurso de dependencia.

resourceType
  • string

Tipo de recurso de dependencia.

DeploymentExtended

Información de implementación.

Name Type 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

Propiedades de implementación.

tags
  • object

Etiquetas de implementación

type
  • string

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.

Name Type Description
Complete
  • string
Incremental
  • string

DeploymentProperties

Propiedades de implementación.

Name Type Description
debugSetting

Configuración de depuración de la implementación.

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

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

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

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

URI de la plantilla. Use la propiedad templateLink o la propiedad template, pero no ambas.

DeploymentPropertiesExtended

Propiedades de implementación con detalles adicionales.

Name Type Description
correlationId
  • string

Identificador de correlación de la implementación.

debugSetting

Configuración de depuración de la implementación.

dependencies

Lista de dependencias de implementación.

duration
  • string

Duración de la implementación de la plantilla.

error

Respuesta de error
Error de implementación.

mode

Modo de implementación. Los valores posibles son Incremental y Complete.

onErrorDeployment

Implementación en el comportamiento del error.

outputResources

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

Identificador URI que hace referencia a los parámetros.

providers

Lista de proveedores de recursos necesarios para la implementación.

provisioningState

Indica el estado del aprovisionamiento.

templateHash
  • string

Hash generado para la plantilla.

templateLink

Identificador URI que hace referencia a la plantilla.

timestamp
  • string

Marca de tiempo de la implementación de la plantilla.

validatedResources

Matriz de recursos validados.

ErrorAdditionalInfo

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

Name Type Description
info
  • object

Información adicional.

type
  • string

Tipo de información adicional.

ErrorResponse

Respuesta de error

Name Type Description
additionalInfo

Información adicional del error.

code
  • string

Código de error.

details

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.

Name Type Description
scope

Á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.

Name Type Description
Inner
  • string
NotSpecified
  • string
Outer
  • string

OnErrorDeployment

Implementación en el comportamiento del error.

Name Type Description
deploymentName
  • string

Implementación que se va a usar en caso de error.

type

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.

Name Type 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

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.

Name Type Description
LastSuccessful
  • string
SpecificDeployment
  • string

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

Name Type 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.

Name Type Description
id
  • string

La identificación del proveedor.

namespace
  • string

Espacio de nombres del proveedor de recursos.

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

Colección de tipos de recursos de proveedor.

ProviderAuthorizationConsentState

Estado de consentimiento de autorización del proveedor.

Name Type Description
Consented
  • string
NotRequired
  • string
NotSpecified
  • string
Required
  • string

ProviderExtendedLocation

Ubicación extendida del proveedor.

Name Type 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.

Name Type Description
aliases

Alias admitidos por este tipo de recurso.

apiProfiles

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

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

ProvisioningState

Indica el estado del aprovisionamiento.

Name Type 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.

Name Type Description
id
  • string

Identificador de recurso completo.

ScopedDeployment

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

Name Type Description
location
  • string

Ubicación para almacenar los datos de implementación.

properties

Propiedades de implementación.

tags
  • object

Etiquetas de implementación

Entidad que representa la referencia a la plantilla.

Name Type 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

Name Type Description
location
  • string

Ubicación de la asignación de zona.

zones
  • string[]