Deployments - Get

Servicio:

Resource Management

Versión de la API:

2021-04-01

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	Nombre de la implementación. Patrón de Regex: ^[-\w\._\(\)]+$
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas. 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.

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

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	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.
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 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	El 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 la ruta de acceso de alias predeterminada. 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 mediante 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 cadena.

AliasPattern

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

Nombre	Tipo	Description
phrase	string	La 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	Extract 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 del 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

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 son none, 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.

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

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 de error.
outputResources	ResourceReference[]	Matriz de recursos aprovisionados.
outputs	object	Pares clave-valor que representan la salida de 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.

OnErrorDeploymentExtended

Implementación en el comportamiento del error con detalles adicionales.

Nombre	Tipo	Description
deploymentName	string	Implementación que se usará en caso de error.
provisioningState	string	El 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	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	La 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	La 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	La 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

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