Deployments - Get At Tenant Scope

Service:

Resource Management

Version d'API:

2021-04-01

Obtient un déploiement.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
deploymentName	path	True	string minLength: 1 maxLength: 64 pattern: ^[-\w\._\(\)]+$	Nom du déploiement.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	DeploymentExtended	OK : retourne des informations sur le déploiement, y compris l’état d’approvisionnement.
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Définitions

Nom	Description
Alias	Type d’alias.
AliasPath	Type des chemins d’accès pour l’alias.
AliasPathAttributes	Attributs du jeton auquel le chemin d’accès de l’alias fait référence.
AliasPathMetadata
AliasPathTokenType	Type du jeton auquel le chemin d’accès de l’alias fait référence.
AliasPattern	Type du modèle pour un chemin d’alias.
AliasPatternType	Type de modèle d’alias
AliasType	Type de l’alias.
ApiProfile
BasicDependency	Informations sur les dépendances de déploiement.
CloudError	Réponse d’erreur pour une demande de gestion des ressources.
DebugSetting	Paramètre de débogage.
Dependency	Informations sur les dépendances de déploiement.
DeploymentExtended	Informations de déploiement.
DeploymentMode	Mode utilisé pour déployer des ressources. Cette valeur peut être incrémentielle ou terminée. En mode incrémentiel, les ressources sont déployées sans supprimer les ressources existantes qui ne sont pas incluses dans le modèle. En mode Complet, les ressources sont déployées et les ressources existantes dans le groupe de ressources qui ne sont pas incluses dans le modèle sont supprimées. Veillez à utiliser le mode Complet, car vous pouvez supprimer involontairement des ressources.
DeploymentPropertiesExtended	Propriétés de déploiement avec des détails supplémentaires.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorResponse	Réponse d’erreur
OnErrorDeploymentExtended	Déploiement sur le comportement des erreurs avec des détails supplémentaires.
OnErrorDeploymentType	Déploiement sur le type de comportement d’erreur. Les valeurs possibles sont LastSuccessful et SpecificDeployment.
ParametersLink	Entité représentant la référence aux paramètres de déploiement.
Provider	Informations du fournisseur de ressources.
ProviderAuthorizationConsentState	État du consentement d’autorisation du fournisseur.
ProviderExtendedLocation	Emplacement étendu du fournisseur.
ProviderResourceType	Type de ressource géré par le fournisseur de ressources.
ProvisioningState	Indique l’état de l’approvisionnement.
ResourceReference	Modèle ID de ressource.
TemplateLink	Entité représentant la référence au modèle.
ZoneMapping

Alias

Object

Type d’alias.

Nom	Type	Description
defaultMetadata	AliasPathMetadata	Métadonnées de chemin d’accès d’alias par défaut. S’applique au chemin d’accès par défaut et à tout chemin d’alias qui n’a pas de métadonnées
defaultPath	string	Chemin d’accès par défaut d’un alias.
defaultPattern	AliasPattern	Modèle par défaut d’un alias.
name	string	Nom de l’alias.
paths	AliasPath[]	Chemins d’accès d’un alias.
type	AliasType	Type de l’alias.

AliasPath

Object

Type des chemins d’accès pour l’alias.

Nom	Type	Description
apiVersions	string[]	Versions de l’API.
metadata	AliasPathMetadata	Métadonnées du chemin d’accès de l’alias. Si elle est manquante, revenez aux métadonnées par défaut de l’alias.
path	string	Chemin d’accès d’un alias.
pattern	AliasPattern	Modèle pour un chemin d’alias.

AliasPathAttributes

Énumération

Attributs du jeton auquel le chemin d’accès de l’alias fait référence.

Valeur	Description
Modifiable	Le jeton auquel le chemin d’accès de l’alias fait référence est modifiable par les stratégies avec l’effet « modifier ».
None	Jeton auquel le chemin d’accès de l’alias fait référence n’a aucun attribut.

AliasPathMetadata

Object

Nom	Type	Description
attributes	AliasPathAttributes	Attributs du jeton auquel le chemin d’accès de l’alias fait référence.
type	AliasPathTokenType	Type du jeton auquel le chemin d’accès de l’alias fait référence.

AliasPathTokenType

Énumération

Type du jeton auquel le chemin d’accès de l’alias fait référence.

Valeur	Description
Any	Le type de jeton peut être n’importe quoi.
Array	Le type de jeton est tableau.
Boolean	Le type de jeton est booléen.
Integer	Le type de jeton est entier.
NotSpecified	Le type de jeton n’est pas spécifié.
Number	Le type de jeton est number.
Object	Le type de jeton est objet.
String	Le type de jeton est chaîne.

AliasPattern

Object

Type du modèle pour un chemin d’alias.

Nom	Type	Description
phrase	string	Expression de modèle d’alias.
type	AliasPatternType	Type de modèle d’alias
variable	string	Variable de modèle d’alias.

AliasPatternType

Énumération

Type de modèle d’alias

Valeur	Description
Extract	L’extraction est la seule valeur autorisée.
NotSpecified	NotSpecified n’est pas autorisé.

AliasType

Énumération

Type de l’alias.

Valeur	Description
Mask	La valeur de l’alias est secrète.
NotSpecified	Le type d’alias est inconnu (identique au type d’alias non fourni).
PlainText	La valeur de l’alias n’est pas secrète.

ApiProfile

Object

Nom	Type	Description
apiVersion	string	Version de l’API.
profileVersion	string	Version du profil.

BasicDependency

Object

Informations sur les dépendances de déploiement.

Nom	Type	Description
id	string	ID de la dépendance.
resourceName	string	Nom de la ressource de dépendance.
resourceType	string	Type de ressource de dépendance.

CloudError

Object

Réponse d’erreur pour une demande de gestion des ressources.

Nom	Type	Description
error	ErrorResponse	Réponse d’erreur Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.)

DebugSetting

Object

Paramètre de débogage.

Nom	Type	Description
detailLevel	string	Spécifie le type d’informations à consigner pour le débogage. Les valeurs autorisées ne sont aucune, requestContent, responseContent ou requestContent et responseContent séparées par une virgule. La valeur par défaut n’est aucune. Lors de la définition de cette valeur, tenez soigneusement compte du type d’informations que vous transmettez pendant le déploiement. En journalisant des informations sur la demande ou la réponse, vous pouvez potentiellement exposer des données sensibles récupérées par le biais des opérations de déploiement.

Dependency

Object

Informations sur les dépendances de déploiement.

Nom	Type	Description
dependsOn	BasicDependency[]	Liste des dépendances.
id	string	ID de la dépendance.
resourceName	string	Nom de la ressource de dépendance.
resourceType	string	Type de ressource de dépendance.

DeploymentExtended

Object

Informations de déploiement.

Nom	Type	Description
id	string	ID du déploiement.
location	string	emplacement du déploiement.
name	string	Nom du déploiement.
properties	DeploymentPropertiesExtended	Propriétés de déploiement.
tags	object	Balises de déploiement
type	string	Type du déploiement.

DeploymentMode

Énumération

Mode utilisé pour déployer des ressources. Cette valeur peut être incrémentielle ou terminée. En mode incrémentiel, les ressources sont déployées sans supprimer les ressources existantes qui ne sont pas incluses dans le modèle. En mode Complet, les ressources sont déployées et les ressources existantes dans le groupe de ressources qui ne sont pas incluses dans le modèle sont supprimées. Veillez à utiliser le mode Complet, car vous pouvez supprimer involontairement des ressources.

Valeur	Description
Complete
Incremental

DeploymentPropertiesExtended

Object

Propriétés de déploiement avec des détails supplémentaires.

Nom	Type	Description
correlationId	string	ID de corrélation du déploiement.
debugSetting	DebugSetting	Paramètre de débogage du déploiement.
dependencies	Dependency[]	Liste des dépendances de déploiement.
duration	string	Durée du déploiement du modèle.
error	ErrorResponse	Réponse d’erreur Erreur de déploiement.
mode	DeploymentMode	Mode de déploiement. Les valeurs possibles sont Incrémentielles et Terminées.
onErrorDeployment	OnErrorDeploymentExtended	Déploiement sur le comportement d’erreur.
outputResources	ResourceReference[]	Tableau de ressources approvisionnées.
outputs	object	Paires clé/valeur qui représentent la sortie du déploiement.
parameters	object	Paramètres de déploiement.
parametersLink	ParametersLink	URI référençant les paramètres.
providers	Provider[]	Liste des fournisseurs de ressources nécessaires au déploiement.
provisioningState	ProvisioningState	Indique l’état de l’approvisionnement.
templateHash	string	Hachage produit pour le modèle.
templateLink	TemplateLink	URI référençant le modèle.
timestamp	string (date-time)	Horodatage du déploiement du modèle.
validatedResources	ResourceReference[]	Tableau de ressources validées.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorResponse[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

OnErrorDeploymentExtended

Object

Déploiement sur le comportement des erreurs avec des détails supplémentaires.

Nom	Type	Description
deploymentName	string	Déploiement à utiliser dans le cas d’erreur.
provisioningState	string	État du provisionnement pour le déploiement d’erreurs.
type	OnErrorDeploymentType	Déploiement sur le type de comportement d’erreur. Les valeurs possibles sont LastSuccessful et SpecificDeployment.

OnErrorDeploymentType

Énumération

Déploiement sur le type de comportement d’erreur. Les valeurs possibles sont LastSuccessful et SpecificDeployment.

Valeur	Description
LastSuccessful
SpecificDeployment

ParametersLink

Object

Entité représentant la référence aux paramètres de déploiement.

Nom	Type	Description
contentVersion	string	S’il est inclus, doit correspondre à ContentVersion dans le modèle.
uri	string	URI du fichier de paramètres.

Provider

Object

Informations du fournisseur de ressources.

Nom	Type	Description
id	string	ID du fournisseur.
namespace	string	Espace de noms du fournisseur de ressources.
providerAuthorizationConsentState	ProviderAuthorizationConsentState	État du consentement d’autorisation du fournisseur.
registrationPolicy	string	Stratégie d’inscription du fournisseur de ressources.
registrationState	string	État d’inscription du fournisseur de ressources.
resourceTypes	ProviderResourceType[]	Collection de types de ressources de fournisseur.

ProviderAuthorizationConsentState

Énumération

État du consentement d’autorisation du fournisseur.

Valeur	Description
Consented
NotRequired
NotSpecified
Required

ProviderExtendedLocation

Object

Emplacement étendu du fournisseur.

Nom	Type	Description
extendedLocations	string[]	Emplacements étendus pour l’emplacement Azure.
location	string	Emplacement Azure.
type	string	Type d’emplacement étendu.

ProviderResourceType

Object

Type de ressource géré par le fournisseur de ressources.

Nom	Type	Description
aliases	Alias[]	Alias pris en charge par ce type de ressource.
apiProfiles	ApiProfile[]	Profils d’API pour le fournisseur de ressources.
apiVersions	string[]	Version de l’API.
capabilities	string	Fonctionnalités supplémentaires offertes par ce type de ressource.
defaultApiVersion	string	Version de l’API par défaut.
locationMappings	ProviderExtendedLocation[]	Mappages d’emplacements pris en charge par ce type de ressource.
locations	string[]	Collection d’emplacements où ce type de ressource peut être créé.
properties	object	Propriétés.
resourceType	string	Type de ressource.
zoneMappings	ZoneMapping[]

ProvisioningState

Énumération

Indique l’état de l’approvisionnement.

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

ResourceReference

Object

Modèle ID de ressource.

Nom	Type	Description
id	string	ID de ressource complet.

TemplateLink

Object

Entité représentant la référence au modèle.

Nom	Type	Description
contentVersion	string	S’il est inclus, doit correspondre à ContentVersion dans le modèle.
id	string	ID de ressource d’une spécification de modèle. Utilisez l’ID ou la propriété uri, mais pas les deux.
queryString	string	Chaîne de requête (par exemple, un jeton SAP) à utiliser avec l’URI templateLink.
relativePath	string	La propriété relativePath peut être utilisée pour déployer un modèle lié à un emplacement par rapport au parent. Si le modèle parent a été lié à un TemplateSpec, il référence un artefact dans templateSpec. Si le parent a été lié à un URI, le déploiement enfant est une combinaison des URI parent et relativePath
uri	string	URI du modèle à déployer. Utilisez l’URI ou la propriété ID, mais pas les deux.

ZoneMapping

Object

Nom	Type	Description
location	string	Emplacement du mappage de zone.
zones	string[]