Environments - Create Or Update

Service:: Dev Test Labs

Version d'API:: 2018-09-15

Créez ou remplacez un environnement existant. Cette opération peut prendre un certain temps.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}?api-version=2018-09-15

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
labName	path	True	string	Nom du labo.
name	path	True	string	Nom de l’environnement.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string minLength: 1	ID de l’abonnement cible.
userName	path	True	string	Nom du profil utilisateur.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
location	string	La géolocalisation de l’endroit où se trouve la ressource
properties.armTemplateDisplayName	string	Nom complet du modèle Azure Resource Manager qui a produit l’environnement.
properties.deploymentProperties	EnvironmentDeploymentProperties	Propriétés de déploiement de l’environnement.
tags	object	Balises de ressource.

Réponses

Nom	Type	Description
200 OK	DtlEnvironment	Réussite de l’opération de mise à jour de la ressource 'DtlEnvironment'
201 Created	DtlEnvironment	Réussite de l’opération de création de la ressource 'DtlEnvironment' En-têtes Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Nom

Type

Description

200 OK

DtlEnvironment

Réussite de l’opération de mise à jour de la ressource 'DtlEnvironment'

201 Created

DtlEnvironment

Réussite de l’opération de création de la ressource 'DtlEnvironment'

En-têtes

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Réponse d’erreur inattendue.

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

Environments_CreateOrUpdate

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/users/@me/environments/{environmentName}?api-version=2018-09-15

{
  "properties": {
    "deploymentProperties": {
      "armTemplateId": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/artifactSources/{artifactSourceName}/armTemplates/{armTemplateName}",
      "parameters": []
    }
  }
}

Exemple de réponse

Code d’état:: 200

{
  "name": "{environmentName}",
  "type": "Microsoft.DevTestLab/labs/users/environments",
  "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/users/{uniqueIdentifier}/environments/{environmentName}",
  "location": "{location}",
  "properties": {
    "createdByUser": "user@contoso.com",
    "deploymentProperties": {
      "armTemplateId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/artifactSources/{artifactSourceName}/armTemplates/{armTemplateName}"
    },
    "provisioningState": "Succeeded",
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "tags": {
    "tagName1": "tagValue1"
  }
}

Code d’état:: 201

{
  "name": "{environmentName}",
  "type": "Microsoft.DevTestLab/labs/users/environments",
  "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/users/{uniqueIdentifier}/environments/{environmentName}",
  "location": "{location}",
  "properties": {
    "createdByUser": "user@contoso.com",
    "deploymentProperties": {
      "armTemplateId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/artifactSources/{artifactSourceName}/armTemplates/{armTemplateName}"
    },
    "provisioningState": "Creating",
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "tags": {
    "tagName1": "tagValue1"
  }
}

Définitions

Nom	Description
ArmTemplateParameterProperties	Propriétés d’un paramètre de modèle Azure Resource Manager.
createdByType	Type d’identité qui a créé la ressource.
DtlEnvironment	Environnement, qui est essentiellement un déploiement de modèle ARM.
EnvironmentDeploymentProperties	Propriétés d’un déploiement d’environnement.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

ArmTemplateParameterProperties

Objet

Propriétés d’un paramètre de modèle Azure Resource Manager.

Nom	Type	Description
name	string	Nom du paramètre de modèle.
value	string	Valeur du paramètre de modèle.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

DtlEnvironment

Objet

Environnement, qui est essentiellement un déploiement de modèle ARM.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	La géolocalisation de l’endroit où se trouve la ressource
name	string	Nom de la ressource
properties.armTemplateDisplayName	string	Nom complet du modèle Azure Resource Manager qui a produit l’environnement.
properties.createdByUser	string	Le créateur de l’environnement.
properties.deploymentProperties	EnvironmentDeploymentProperties	Propriétés de déploiement de l’environnement.
properties.provisioningState	string	État d’approvisionnement de la ressource.
properties.resourceGroupId	string	Identificateur du groupe de ressources contenant les ressources de l’environnement.
properties.uniqueIdentifier	string	Identificateur immuable unique d’une ressource (GUID).
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

EnvironmentDeploymentProperties

Objet

Propriétés d’un déploiement d’environnement.

Nom	Type	Description
armTemplateId	string	Identificateur du modèle Azure Resource Manager.
parameters	ArmTemplateParameterProperties[]	Paramètres du modèle Azure Resource Manager.

ErrorAdditionalInfo

Objet

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.

ErrorDetail

Objet

Détail de l’erreur.

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

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Partager via

Environments - Create Or Update

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

Environments_CreateOrUpdate

Exemple de requête

Exemple de réponse

Définitions

ArmTemplateParameterProperties

createdByType

DtlEnvironment

EnvironmentDeploymentProperties

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

systemData