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	Le nom du déploiement. Modèle d’expression régulière: ^[-\w\._\(\)]+$
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’approvisionnement status.
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

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 alias.
AliasPathAttributes	Attributs du jeton auxquels le chemin d’alias fait référence.
AliasPathMetadata
AliasPathTokenType	Type du jeton auquel le chemin d’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 relatives au déploiement.
DeploymentMode	Mode utilisé pour déployer des ressources. Cette valeur peut être Incrémentielle ou Complète. En mode incrémentiel, les ressources sont déployées sans supprimer de ressources existantes non incluses dans le modèle. En mode Complet, les ressources sont déployées et les ressources existantes du groupe de ressources qui ne sont pas incluses dans le modèle sont supprimées. Soyez prudent lorsque vous utilisez 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 d’erreur avec des détails supplémentaires.
OnErrorDeploymentType	Type de comportement de déploiement sur erreur. Les valeurs possibles sont LastSuccessful et SpecificDeployment.
ParametersLink	Entité représentant la référence aux paramètres de déploiement.
Provider	Informations sur le 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 d’ID de ressource.
TemplateLink	Entité représentant la référence au modèle.
ZoneMapping

Alias

Type d’alias.

Nom	Type	Description
defaultMetadata	AliasPathMetadata	Métadonnées de chemin 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 par défaut d’un alias.
defaultPattern	AliasPattern	Modèle par défaut pour un alias.
name	string	Nom de l’alias.
paths	AliasPath[]	Chemins d’accès d’un alias.
type	AliasType	Type de l'alias.

AliasPath

Type des chemins d’accès pour alias.

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

AliasPathAttributes

Attributs du jeton auxquels le chemin d’alias fait référence.

Nom	Type	Description
Modifiable	string	Le jeton auquel le chemin d’alias fait référence est modifiable par les stratégies avec l’effet « modify ».
None	string	Le jeton auquel le chemin d’alias fait référence n’a pas d’attributs.

AliasPathMetadata

Nom	Type	Description
attributes	AliasPathAttributes	Attributs du jeton auxquels le chemin d’alias fait référence.
type	AliasPathTokenType	Type du jeton auquel le chemin d’alias fait référence.

AliasPathTokenType

Type du jeton auquel le chemin d’alias fait référence.

Nom	Type	Description
Any	string	Le type de jeton peut être n’importe quoi.
Array	string	Le type de jeton est tableau.
Boolean	string	Le type de jeton est booléen.
Integer	string	Le type de jeton est entier.
NotSpecified	string	Le type de jeton n’est pas spécifié.
Number	string	Le type de jeton est number.
Object	string	Le type de jeton est object.
String	string	Le type de jeton est string.

AliasPattern

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

Type de modèle d’alias

Nom	Type	Description
Extract	string	Extraire est la seule valeur autorisée.
NotSpecified	string	NotSpecified n’est pas autorisé.

AliasType

Type de l'alias.

Nom	Type	Description
Mask	string	La valeur de l’alias est secret.
NotSpecified	string	Le type d’alias est inconnu (identique à ne pas fournir de type d’alias).
PlainText	string	La valeur de l’alias n’est pas un secret.

ApiProfile

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

BasicDependency

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

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 pour retourner les détails de l’erreur concernant les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.)

DebugSetting

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 sont none, requestContent, responseContent ou requestContent et responseContent séparées par une virgule. La valeur par défaut est aucune gestion. Lorsque vous définissez cette valeur, examinez soigneusement le type d’informations que vous transmettez pendant le déploiement. En enregistrant des informations sur la requête ou la réponse, vous risquez d’exposer des données sensibles récupérées au cours des opérations de déploiement.

Dependency

Informations sur les dépendances de déploiement.

Nom	Type	Description
dependsOn	BasicDependency[]	Liste de 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

Informations relatives au déploiement.

Nom	Type	Description
id	string	ID du déploiement.
location	string	emplacement du déploiement.
name	string	Le 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

Mode utilisé pour déployer des ressources. Cette valeur peut être Incrémentielle ou Complète. En mode incrémentiel, les ressources sont déployées sans supprimer de ressources existantes non incluses dans le modèle. En mode Complet, les ressources sont déployées et les ressources existantes du groupe de ressources qui ne sont pas incluses dans le modèle sont supprimées. Soyez prudent lorsque vous utilisez le mode Complet, car vous pouvez supprimer involontairement des ressources.

Nom	Type	Description
Complete	string
Incremental	string

DeploymentPropertiesExtended

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émentielle et Complète.
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	Horodatage du déploiement du modèle.
validatedResources	ResourceReference[]	Tableau de ressources validées.

ErrorAdditionalInfo

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

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

ErrorResponse

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

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

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

OnErrorDeploymentType

Type de comportement de déploiement sur erreur. Les valeurs possibles sont LastSuccessful et SpecificDeployment.

Nom	Type	Description
LastSuccessful	string
SpecificDeployment	string

ParametersLink

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

Informations sur le 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

État du consentement d’autorisation du fournisseur.

Nom	Type	Description
Consented	string
NotRequired	string
NotSpecified	string
Required	string

ProviderExtendedLocation

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

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

Indique l’état de l’approvisionnement.

Nom	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

Modèle d’ID de ressource.

Nom	Type	Description
id	string	ID de ressource complet.

TemplateLink

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 la propriété id ou uri, mais pas les deux.
queryString	string	Chaîne de requête (par exemple, un jeton SAS) à 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, cela fait 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 la propriété uri ou id, mais pas les deux.

ZoneMapping

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