Compartir a través de


Deployments - Get

Obtiene una implementación.

GET 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

minLength: 1
maxLength: 64
pattern: ^[-\w\._\(\)]+$

Nombre de la implementación.

resourceGroupName
path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+$

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

subscriptionId
path True

string

Identificador de suscripción de Microsoft Azure.

api-version
query True

string

Versión de la API que se va a usar para esta operación.

Respuestas

Nombre Tipo Description
200 OK

DeploymentExtended

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

Other Status Codes

CloudError

Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de 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 suplantar la cuenta de usuario

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 dependencia de implementación.

CloudError

Respuesta de error para una solicitud de administración de recursos.

DebugSetting

Configuración de depuración.

Dependency

Información de dependencia de implementación.

DeploymentExtended

Información de implementación.

DeploymentMode

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

DeploymentPropertiesExtended

Propiedades de implementación con detalles adicionales.

ErrorAdditionalInfo

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

ErrorResponse

Respuesta de error

OnErrorDeploymentExtended

Implementación en el comportamiento del error 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 del proveedor de recursos.

ProviderAuthorizationConsentState

Estado de consentimiento de autorización del proveedor.

ProviderExtendedLocation

Ubicación extendida del proveedor.

ProviderResourceType

Tipo de recurso administrado por 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 de 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.

Valor Description
Modifiable

El token al que hace referencia la ruta de acceso del alias es modificable mediante directivas con efecto "modify".

None

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.

Valor Description
Any

El tipo de token puede ser cualquier cosa.

Array

El tipo de token es array.

Boolean

El tipo de token es booleano.

Integer

El tipo de token es entero.

NotSpecified

No se especifica el tipo de token.

Number

El tipo de token es number.

Object

El tipo de token es object.

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

Valor Description
Extract

Extract es el único valor permitido.

NotSpecified

No se permite NotSpecified.

AliasType

Tipo del alias.

Valor Description
Mask

El valor del alias es secreto.

NotSpecified

El tipo de alias es desconocido (igual que no proporciona el tipo de alias).

PlainText

El valor del alias no es secreto.

ApiProfile

Nombre Tipo Description
apiVersion

string

La versión de la API.

profileVersion

string

La versión del perfil.

BasicDependency

Información de dependencia de 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

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 no es ninguno. Al establecer este valor, considere cuidadosamente el tipo de información que está pasando durante la implementación. Al registrar información sobre la solicitud o respuesta, podría exponer datos confidenciales que se recuperan a través de las operaciones de implementación.

Dependency

Información de dependencia de implementación.

Nombre Tipo Description
dependsOn

BasicDependency[]

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.

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

Tipo de la implementación.

DeploymentMode

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

Valor Description
Complete
Incremental

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 (date-time)

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

Detalles del error.

message

string

Mensaje de error.

target

string

Destino del error.

OnErrorDeploymentExtended

Implementación en el comportamiento del error 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 de errores.

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.

Valor Description
LastSuccessful
SpecificDeployment

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 del proveedor de recursos.

Nombre Tipo Description
id

string

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

Valor Description
Consented
NotRequired
NotSpecified
Required

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

La versión de la API.

capabilities

string

Las funcionalidades adicionales que ofrece este tipo de recurso.

defaultApiVersion

string

Versión predeterminada de la API.

locationMappings

ProviderExtendedLocation[]

Asignaciones de ubicación compatibles con este tipo de recurso.

locations

string[]

Colección de ubicaciones donde se puede crear este tipo de recurso.

properties

object

Propiedades.

resourceType

string

Tipo de recurso.

zoneMappings

ZoneMapping[]

ProvisioningState

Indica el estado del aprovisionamiento.

Valor Description
Accepted
Canceled
Created
Creating
Deleted
Deleting
Failed
NotSpecified
Ready
Running
Succeeded
Updating

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, esto hará referencia a un artefacto en TemplateSpec. Si el elemento primario estaba vinculado con un URI, la implementación secundaria será una combinación de los URI primarios y relativePath.

uri

string

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