Lab Plans - Create Or Update

Service:: Lab Services

Version d'API:: 2023-06-07

Met à jour ou crée une ressource Lab Plan.
Opération de création ou de mise à jour d’une ressource Lab Plan.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans/{labPlanName}?api-version=2023-06-07

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
labPlanName	path	True	string minLength: 1 maxLength: 100	Nom du plan de laboratoire qui l’identifie de manière unique dans le groupe de ressources contenant. Utilisé dans les URI de ressource et dans l’interface utilisateur.
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.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
location	True	string	Emplacement géographique où réside la ressource
identity		Identity	Informations sur l’identité managée
properties.allowedRegions		string[]	Régions autorisées pour que le créateur du labo utilise lors de la création de laboratoires à l’aide de ce plan de laboratoire.
properties.defaultAutoShutdownProfile		AutoShutdownProfile	Profil d’arrêt du labo par défaut. Cela peut être modifié sur une ressource lab et fournit uniquement un profil par défaut.
properties.defaultConnectionProfile		ConnectionProfile	Profil de connexion lab par défaut. Cela peut être modifié sur une ressource lab et fournit uniquement un profil par défaut.
properties.defaultNetworkProfile		LabPlanNetworkProfile	Profil réseau du plan lab. Pour appliquer des stratégies réseau de laboratoire, elles doivent être définies ici et ne peuvent pas être modifiées lorsqu’il existe des laboratoires existants associés à ce plan de laboratoire.
properties.linkedLmsInstance		string minLength: 3 maxLength: 2000	Url de base de l’instance lms sur laquelle ce plan de laboratoire peut lier les listes de laboratoires.
properties.sharedGalleryId		string minLength: 3 maxLength: 2000	ID de ressource de la galerie d’images partagées attachée à ce plan de laboratoire. Lors de l’enregistrement d’une image de machine virtuelle de modèle de laboratoire, elle est conservée dans cette galerie. Les images partagées de la galerie peuvent être mises à la disposition des utilisateurs lors de la création de laboratoires.
properties.supportInfo		SupportInfo	Informations de contact et instructions du support technique pour les utilisateurs du plan lab. Ces informations sont affichées aux propriétaires de laboratoire et aux utilisateurs de machines virtuelles pour tous les laboratoires du plan de laboratoire.
tags		object	Balises de ressource.

Réponses

Nom	Type	Description
200 OK	LabPlan	La mise à jour a réussi ; la réponse contient le plan lab.
201 Created	LabPlan	La création a réussi ; la réponse contient le plan lab.
202 Accepted	LabPlan	La mise à jour a réussi et a une longue opération ; la réponse contient le plan lab.
Other Status Codes	ErrorResponse	Réponse d’erreur par défaut.

Exemples

putLabPlan

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labPlans/testlabplan?api-version=2023-06-07

{
  "location": "westus",
  "properties": {
    "defaultConnectionProfile": {
      "webSshAccess": "None",
      "webRdpAccess": "None",
      "clientSshAccess": "Public",
      "clientRdpAccess": "Public"
    },
    "defaultAutoShutdownProfile": {
      "shutdownOnDisconnect": "Enabled",
      "shutdownWhenNotConnected": "Enabled",
      "shutdownOnIdle": "UserAbsence",
      "disconnectDelay": "PT5M",
      "noConnectDelay": "PT5M",
      "idleDelay": "PT5M"
    },
    "defaultNetworkProfile": {
      "subnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"
    },
    "sharedGalleryId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Compute/galleries/testsig",
    "supportInfo": {
      "url": "help.contoso.com",
      "email": "help@contoso.com",
      "phone": "+1-202-555-0123",
      "instructions": "Contact support for help."
    }
  }
}

Exemple de réponse

Code d’état:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labPlans/testlabplan",
  "name": "testlabplan",
  "type": "Microsoft.LabServices/LabPlan",
  "location": "westus",
  "systemData": {
    "createdBy": "identity123",
    "createdByType": "User",
    "createdAt": "2020-05-01T10:00:00Z",
    "lastModifiedBy": "identity123",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-01T09:12:28Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "defaultConnectionProfile": {
      "webSshAccess": "None",
      "webRdpAccess": "None",
      "clientSshAccess": "Public",
      "clientRdpAccess": "Public"
    },
    "defaultAutoShutdownProfile": {
      "shutdownOnDisconnect": "Enabled",
      "shutdownWhenNotConnected": "Enabled",
      "shutdownOnIdle": "UserAbsence",
      "disconnectDelay": "PT5M",
      "noConnectDelay": "PT5M",
      "idleDelay": "PT5M"
    },
    "defaultNetworkProfile": {
      "subnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"
    },
    "sharedGalleryId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Compute/galleries/testsig",
    "supportInfo": {
      "url": "help.contoso.com",
      "email": "help@contoso.com",
      "phone": "+1-202-555-0123",
      "instructions": "Contact support for help."
    }
  }
}

Code d’état:: 201

Location: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.LabServices/operationresults/a64149d8-84cb-4566-ab8e-b4ee1a074174

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labPlans/testlabplan",
  "name": "testlabplan",
  "type": "Microsoft.LabServices/LabPlan",
  "location": "westus",
  "systemData": {
    "createdBy": "identity123",
    "createdByType": "User",
    "createdAt": "2020-05-01T10:00:00Z",
    "lastModifiedBy": "identity123",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-01T09:12:28Z"
  },
  "properties": {
    "provisioningState": "Creating",
    "defaultConnectionProfile": {
      "webSshAccess": "None",
      "webRdpAccess": "None",
      "clientSshAccess": "Public",
      "clientRdpAccess": "Public"
    },
    "defaultAutoShutdownProfile": {
      "shutdownOnDisconnect": "Enabled",
      "shutdownWhenNotConnected": "Enabled",
      "shutdownOnIdle": "UserAbsence",
      "disconnectDelay": "PT5M",
      "noConnectDelay": "PT5M",
      "idleDelay": "PT5M"
    },
    "defaultNetworkProfile": {
      "subnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"
    },
    "sharedGalleryId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Compute/galleries/testsig",
    "supportInfo": {
      "url": "help.contoso.com",
      "email": "help@contoso.com",
      "phone": "+1-202-555-0123",
      "instructions": "Contact support for help."
    }
  }
}

Code d’état:: 202

Location: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.LabServices/operationresults/a64149d8-84cb-4566-ab8e-b4ee1a074174

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labPlans/testlabplan",
  "name": "testlabplan",
  "type": "Microsoft.LabServices/LabPlan",
  "location": "westus",
  "systemData": {
    "createdBy": "identity123",
    "createdByType": "User",
    "createdAt": "2020-05-01T10:00:00Z",
    "lastModifiedBy": "identity123",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-01T09:12:28Z"
  },
  "properties": {
    "provisioningState": "Updating",
    "defaultConnectionProfile": {
      "webSshAccess": "None",
      "webRdpAccess": "None",
      "clientSshAccess": "Public",
      "clientRdpAccess": "Public"
    },
    "defaultAutoShutdownProfile": {
      "shutdownOnDisconnect": "Enabled",
      "shutdownWhenNotConnected": "Enabled",
      "shutdownOnIdle": "UserAbsence",
      "disconnectDelay": "PT5M",
      "noConnectDelay": "PT5M",
      "idleDelay": "PT5M"
    },
    "defaultNetworkProfile": {
      "subnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"
    },
    "sharedGalleryId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Compute/galleries/testsig",
    "supportInfo": {
      "url": "help.contoso.com",
      "email": "help@contoso.com",
      "phone": "+1-202-555-0123",
      "instructions": "Contact support for help."
    }
  }
}

Définitions

Nom	Description
AutoShutdownProfile	Profil pour savoir comment gérer l’arrêt des machines virtuelles.
ConnectionProfile	Profil de connexion pour la façon dont les utilisateurs se connectent aux machines virtuelles lab.
ConnectionType	Niveau d’accès activé pour l’accès web via SSH.
createdByType	Type d’identité qui a créé la ressource.
EnableState	Indique si l’arrêt lors de la déconnexion est activé
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
Identity	Identité de la ressource.
LabPlan	Les plans de laboratoire agissent en tant que conteneur d’autorisations pour créer des laboratoires via labs.azure.com. En outre, ils peuvent fournir un ensemble de configurations par défaut qui s’appliqueront au moment de la création d’un laboratoire, mais ces valeurs par défaut peuvent toujours être remplacées.
LabPlanNetworkProfile	Profil pour savoir comment gérer la mise en réseau pour les plans lab.
ProvisioningState	État d’approvisionnement actuel du plan lab.
ResourceIdentityType	Type d’identité.
ResourceOperationError	Détails de l’erreur de la dernière défaillance de l’opération sur cette ressource
shutdownOnIdleMode	Définit s’il faut arrêter la machine virtuelle en cas d’inactivité et les critères de détection inactive.
SupportInfo	Informations de contact et instructions du support technique.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

AutoShutdownProfile

Object

Profil pour savoir comment gérer l’arrêt des machines virtuelles.

Nom	Type	Valeur par défaut	Description
disconnectDelay	string (duration)		Durée pendant laquelle une machine virtuelle reste en cours d’exécution après qu’un utilisateur se déconnecte si ce comportement est activé.
idleDelay	string (duration)		Durée d’inactivité d’une machine virtuelle avant son arrêt si ce comportement est activé.
noConnectDelay	string (duration)		Durée pendant laquelle une machine virtuelle reste en cours d’exécution avant son arrêt si aucune connexion n’est établie et que ce comportement est activé.
shutdownOnDisconnect	EnableState	Disabled	Indique si l’arrêt lors de la déconnexion est activé
shutdownOnIdle	shutdownOnIdleMode	None	Indique si une machine virtuelle est arrêtée lorsqu’elle est inactive pendant une période de temps.
shutdownWhenNotConnected	EnableState	Disabled	Indique si une machine virtuelle est arrêtée lorsqu’elle n’a pas été connectée après une période donnée.

ConnectionProfile

Object

Profil de connexion pour la façon dont les utilisateurs se connectent aux machines virtuelles lab.

Nom	Type	Valeur par défaut	Description
clientRdpAccess	ConnectionType	None	Niveau d’accès activé pour l’accès client via RDP.
clientSshAccess	ConnectionType	None	Niveau d’accès activé pour l’accès client via SSH.
webRdpAccess	ConnectionType	None	Niveau d’accès activé pour l’accès web via RDP.
webSshAccess	ConnectionType	None	Niveau d’accès activé pour l’accès web via SSH.

ConnectionType

Énumération

Niveau d’accès activé pour l’accès web via SSH.

Valeur	Description
Public
Private
None

createdByType

Énumération

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

Valeur	Description
User
Application
ManagedIdentity
Key

EnableState

Énumération

Indique si l’arrêt lors de la déconnexion est activé

Valeur	Description
Enabled
Disabled

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.

ErrorDetail

Object

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

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

Identity

Object

Identité de la ressource.

Nom	Type	Description
principalId	string	ID principal de l’identité de ressource.
tenantId	string	ID de locataire de la ressource.
type	ResourceIdentityType	Type d’identité.

LabPlan

Object

Les plans de laboratoire agissent en tant que conteneur d’autorisations pour créer des laboratoires via labs.azure.com. En outre, ils peuvent fournir un ensemble de configurations par défaut qui s’appliqueront au moment de la création d’un laboratoire, mais ces valeurs par défaut peuvent toujours être remplacées.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Informations sur l’identité managée
location	string	Emplacement géographique où réside la ressource
name	string	Nom de la ressource
properties.allowedRegions	string[]	Régions autorisées pour que le créateur du labo utilise lors de la création de laboratoires à l’aide de ce plan de laboratoire.
properties.defaultAutoShutdownProfile	AutoShutdownProfile	Profil d’arrêt du labo par défaut. Cela peut être modifié sur une ressource lab et fournit uniquement un profil par défaut.
properties.defaultConnectionProfile	ConnectionProfile	Profil de connexion lab par défaut. Cela peut être modifié sur une ressource lab et fournit uniquement un profil par défaut.
properties.defaultNetworkProfile	LabPlanNetworkProfile	Profil réseau du plan lab. Pour appliquer des stratégies réseau de laboratoire, elles doivent être définies ici et ne peuvent pas être modifiées lorsqu’il existe des laboratoires existants associés à ce plan de laboratoire.
properties.linkedLmsInstance	string minLength: 3 maxLength: 2000	Url de base de l’instance lms sur laquelle ce plan de laboratoire peut lier les listes de laboratoires.
properties.provisioningState	ProvisioningState	État d’approvisionnement actuel du plan lab.
properties.resourceOperationError	ResourceOperationError	Détails de la dernière opération effectuée sur le plan lab.
properties.sharedGalleryId	string minLength: 3 maxLength: 2000	ID de ressource de la galerie d’images partagées attachée à ce plan de laboratoire. Lors de l’enregistrement d’une image de machine virtuelle de modèle de laboratoire, elle est conservée dans cette galerie. Les images partagées de la galerie peuvent être mises à la disposition des utilisateurs lors de la création de laboratoires.
properties.supportInfo	SupportInfo	Informations de contact et instructions du support technique pour les utilisateurs du plan lab. Ces informations sont affichées aux propriétaires de laboratoire et aux utilisateurs de machines virtuelles pour tous les laboratoires du plan de laboratoire.
systemData	systemData	Métadonnées relatives à la création et à la dernière modification du plan lab.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

LabPlanNetworkProfile

Object

Profil pour savoir comment gérer la mise en réseau pour les plans lab.

Nom	Type	Description
subnetId	string minLength: 3 maxLength: 2000	ID de ressource de sous-réseau externe

ProvisioningState

Énumération

État d’approvisionnement actuel du plan lab.

Valeur	Description
Creating	La ressource est en cours de création.
Updating	Les nouvelles valeurs de propriété sont appliquées à la ressource.
Deleting	La ressource est en cours de suppression.
Succeeded	La ressource est en état sain après la création ou l’opération de mise à jour.
Failed	L’opération précédente sur la ressource a échoué en laissant la ressource dans un état non sain.
Locked	La ressource est verrouillée et les modifications sont actuellement bloquées. Cela peut être dû à la maintenance ou à une opération planifiée. L’état revient à réussir une fois l’opération de verrouillage terminée.

ResourceIdentityType

Énumération

Type d’identité.

Valeur	Description
SystemAssigned

ResourceOperationError

Object

Détails de l’erreur de la dernière défaillance de l’opération sur cette ressource

Nom	Type	Description
action	string	Action d’opération ayant échoué
code	string	Code qui correspond au type d’échec de l’opération
message	string	Message d’échec de l’opération
timestamp	string (date-time)	Date et heure de la survenue de l’erreur

shutdownOnIdleMode

Énumération

Définit s’il faut arrêter la machine virtuelle en cas d’inactivité et les critères de détection inactive.

Valeur	Description
None	La machine virtuelle ne sera pas arrêtée lorsqu’elle est inactive.
UserAbsence	La machine virtuelle est considérée comme inactive lorsqu’il n’y a pas d’entrée de clavier ou de souris.
LowUsage	La machine virtuelle est considérée comme inactive lorsque l’utilisateur est absent et que la consommation de ressources (processeur et disque) est faible.

SupportInfo

Object

Informations de contact et instructions du support technique.

Nom	Type	Description
email	string minLength: 6 maxLength: 254	Adresse e-mail du contact de support.
instructions	string	Instructions de support.
phone	string minLength: 1 maxLength: 31	Numéro de téléphone du support technique.
url	string minLength: 3 maxLength: 2000	Prise en charge de l’adresse web.

systemData

Object

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

Lab Plans - Create Or Update

Paramètres URI

Corps de la demande

Réponses

Exemples

putLabPlan

Exemple de requête

Exemple de réponse

Définitions

AutoShutdownProfile

ConnectionProfile

ConnectionType

createdByType

EnableState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

LabPlan

LabPlanNetworkProfile

ProvisioningState

ResourceIdentityType

ResourceOperationError

shutdownOnIdleMode

SupportInfo

systemData