Deployments - Create Or Update At Scope
Déploie des ressources dans une étendue donnée.
Vous pouvez fournir le modèle et les paramètres directement dans la requête ou le lien vers des fichiers JSON.
PUT https://management.azure.com/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2021-04-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
deployment
|
path | True |
string |
Le nom du déploiement. Modèle d’expression régulière: |
scope
|
path | True |
string |
Étendue des ressources. |
api-version
|
query | True |
string |
Version de l’API à utiliser pour cette opération. |
Corps de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
properties | True |
Propriétés de déploiement. |
|
location |
string |
Emplacement où stocker les données de déploiement. |
|
tags |
object |
Balises de déploiement |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
OK : retourne des informations sur le déploiement, y compris l’approvisionnement status. |
|
201 Created |
Créé : retourne des informations sur le déploiement, y compris l’approvisionnement des status. |
|
Other Status Codes |
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 |
Exemples
Create deployment at a given scope.
Exemple de requête
PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment?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"
}
}
Exemple de réponse
{
"id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment",
"name": "my-deployment",
"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.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
"resourceType": "Microsoft.Authorization/policyDefinitions",
"resourceName": "policy-definition-name"
}
],
"id": "/providers/Microsoft.Management/managementGroups/my-management-group-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.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment",
"name": "my-deployment",
"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.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
"resourceType": "Microsoft.Authorization/policyDefinitions",
"resourceName": "policy-definition-name"
}
],
"id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock",
"resourceType": "Microsoft.Authorization/policyAssignments",
"resourceName": "location-lock"
}
]
},
"tags": {
"tagKey1": "tag-value-1",
"tagKey2": "tag-value-2"
}
}
Définitions
Nom | Description |
---|---|
Alias |
Type d’alias. |
Alias |
Type des chemins d’accès pour alias. |
Alias |
Attributs du jeton auquel le chemin d’alias fait référence. |
Alias |
|
Alias |
Type du jeton auquel le chemin d’alias fait référence. |
Alias |
Type du modèle d’un chemin d’alias. |
Alias |
Type de modèle d’alias |
Alias |
Type de l'alias. |
Api |
|
Basic |
Informations sur les dépendances de déploiement. |
Cloud |
Réponse d’erreur pour une demande de gestion des ressources. |
Debug |
Paramètre de débogage. |
Dependency |
Informations sur les dépendances de déploiement. |
Deployment |
Paramètres de l’opération de déploiement. |
Deployment |
Informations relatives au déploiement. |
Deployment |
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. |
Deployment |
Propriétés de déploiement. |
Deployment |
Propriétés de déploiement avec des détails supplémentaires. |
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
Error |
Réponse d’erreur |
Expression |
Spécifie si les expressions de modèle sont évaluées dans l’étendue du modèle parent ou du modèle imbriqué. |
Expression |
Étendue à utiliser pour l’évaluation des paramètres, des variables et des fonctions dans un modèle imbriqué. |
On |
Déploiement sur le comportement d’erreur. |
On |
Déploiement sur le comportement d’erreur avec des détails supplémentaires. |
On |
Type de comportement de déploiement sur erreur. Les valeurs possibles sont LastSuccessful et SpecificDeployment. |
Parameters |
Entité représentant la référence aux paramètres de déploiement. |
Provider |
Informations sur le fournisseur de ressources. |
Provider |
État du consentement d’autorisation du fournisseur. |
Provider |
Emplacement étendu du fournisseur. |
Provider |
Type de ressource géré par le fournisseur de ressources. |
Provisioning |
Indique l’état de l’approvisionnement. |
Resource |
Modèle d’ID de ressource. |
Template |
Entité représentant la référence au modèle. |
Zone |
Alias
Type d’alias.
Nom | Type | Description |
---|---|---|
defaultMetadata |
Métadonnées de chemin d’alias par défaut. S’applique au chemin par défaut et à n’importe quel chemin d’alias qui n’a pas de métadonnées |
|
defaultPath |
string |
Chemin par défaut d’un alias. |
defaultPattern |
Modèle par défaut pour un alias. |
|
name |
string |
Nom de l’alias. |
paths |
Chemins d’accès d’un alias. |
|
type |
Type de l'alias. |
AliasPath
Type des chemins d’accès pour alias.
Nom | Type | Description |
---|---|---|
apiVersions |
string[] |
Versions de l’API. |
metadata |
Métadonnées du chemin d’alias. En cas d’absence, revenez aux métadonnées par défaut de l’alias. |
|
path |
string |
Chemin d’accès d’un alias. |
pattern |
Modèle d’un chemin d’alias. |
AliasPathAttributes
Attributs du jeton auquel 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 effet « modifier ». |
None |
string |
Le jeton auquel le chemin d’alias fait référence n’a aucun attribut. |
AliasPathMetadata
Nom | Type | Description |
---|---|---|
attributes |
Attributs du jeton auquel le chemin d’alias fait référence. |
|
type |
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 objet. |
String |
string |
Le type de jeton est string. |
AliasPattern
Type du modèle d’un chemin d’alias.
Nom | Type | Description |
---|---|---|
phrase |
string |
Expression de modèle d’alias. |
type |
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 secrète. |
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 |
Réponse d’erreur |
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 |
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. |
Deployment
Paramètres de l’opération de déploiement.
Nom | Type | Description |
---|---|---|
location |
string |
Emplacement où stocker les données de déploiement. |
properties |
Propriétés de déploiement. |
|
tags |
object |
Balises de déploiement |
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 |
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 |
DeploymentProperties
Propriétés de déploiement.
Nom | Type | Description |
---|---|---|
debugSetting |
Paramètre de débogage du déploiement. |
|
expressionEvaluationOptions |
Spécifie si les expressions de modèle sont évaluées dans l’étendue du modèle parent ou du modèle imbriqué. Applicable uniquement aux modèles imbriqués. Si elle n’est pas spécifiée, la valeur par défaut est externe. |
|
mode |
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. |
|
onErrorDeployment |
Déploiement sur le comportement d’erreur. |
|
parameters |
object |
Paires nom et valeur qui définissent les paramètres de déploiement du modèle. Vous utilisez cet élément lorsque vous souhaitez fournir les valeurs de paramètre directement dans la demande plutôt que de créer un lien vers un fichier de paramètres existant. Utilisez la propriété parametersLink ou la propriété parameters, mais pas les deux. Il peut s’agir d’un JObject ou d’une chaîne JSON bien formée. |
parametersLink |
URI du fichier de paramètres. Vous utilisez cet élément pour établir un lien vers un fichier de paramètres existant. Utilisez la propriété parametersLink ou la propriété parameters, mais pas les deux. |
|
template |
object |
Contenu du modèle. Vous utilisez cet élément lorsque vous souhaitez transmettre la syntaxe du modèle directement dans la demande plutôt que de créer un lien vers un modèle existant. Il peut s’agir d’un JObject ou d’une chaîne JSON bien formée. Utilisez la propriété templateLink ou la propriété template, mais pas les deux. |
templateLink |
URI du modèle. Utilisez la propriété templateLink ou la propriété template, mais pas les deux. |
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 |
Paramètre de débogage du déploiement. |
|
dependencies |
Liste des dépendances de déploiement. |
|
duration |
string |
Durée du déploiement du modèle. |
error |
Réponse d’erreur |
|
mode |
Mode de déploiement. Les valeurs possibles sont Incrémentielle et Complète. |
|
onErrorDeployment |
Déploiement sur le comportement d’erreur. |
|
outputResources |
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 |
URI référençant les paramètres. |
|
providers |
Provider[] |
Liste des fournisseurs de ressources nécessaires au déploiement. |
provisioningState |
Indique l’état de l’approvisionnement. |
|
templateHash |
string |
Hachage produit pour le modèle. |
templateLink |
URI référençant le modèle. |
|
timestamp |
string |
Horodatage du déploiement du modèle. |
validatedResources |
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 |
Informations supplémentaires sur l’erreur. |
|
code |
string |
Code d'erreur. |
details |
Détails de l’erreur. |
|
message |
string |
Message d’erreur. |
target |
string |
Cible d’erreur. |
ExpressionEvaluationOptions
Spécifie si les expressions de modèle sont évaluées dans l’étendue du modèle parent ou du modèle imbriqué.
Nom | Type | Description |
---|---|---|
scope |
Étendue à utiliser pour l’évaluation des paramètres, des variables et des fonctions dans un modèle imbriqué. |
ExpressionEvaluationOptionsScopeType
Étendue à utiliser pour l’évaluation des paramètres, des variables et des fonctions dans un modèle imbriqué.
Nom | Type | Description |
---|---|---|
Inner |
string |
|
NotSpecified |
string |
|
Outer |
string |
OnErrorDeployment
Déploiement sur le comportement d’erreur.
Nom | Type | Description |
---|---|---|
deploymentName |
string |
Déploiement à utiliser en cas d’erreur. |
type |
Type de comportement de déploiement sur erreur. Les valeurs possibles sont LastSuccessful et SpecificDeployment. |
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 |
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 |
É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 |
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 |
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 |
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 |
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[] |