Partager via


Lab Plans - Create Or Update

Mises à 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

Nom du plan lab 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

Nom du groupe de ressources. Le nom ne respecte pas la casse.

subscriptionId
path True

string

ID de l’abonnement cible.

api-version
query True

string

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 le créateur de labo à utiliser lors de la création de labos à l’aide de ce plan de labo.

properties.defaultAutoShutdownProfile

AutoShutdownProfile

Profil d’arrêt de laboratoire 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 de réseau lab, elles doivent être définies ici et ne peuvent pas être modifiées quand des labos existants sont associés à ce plan de labo.

properties.linkedLmsInstance

string

URL de base des lms instance ce plan de labo peut lier des listes de laboratoires.

properties.sharedGalleryId

string

ID de ressource du Shared Image Gallery attaché à ce plan de labo. 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 à disposition pour être utilisées lors de la création de nouveaux labos.

properties.supportInfo

SupportInfo

Informations de contact et instructions de support pour les utilisateurs du plan lab. Ces informations sont affichées aux propriétaires de laboratoires et aux utilisateurs de machines virtuelles pour tous les labos du plan lab.

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 opération de longue durée ; la réponse contient le plan lab.

Other Status Codes

ErrorResponse

Réponse d’erreur par défaut.

Exemples

putLabPlan

Exemple de requête

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

{
  "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."
    }
  }
}
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."
    }
  }
}
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 la gestion de 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

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 lab agissent comme un conteneur d’autorisations pour la création de labos 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 labo, mais ces valeurs par défaut peuvent toujours être remplacées.

LabPlanNetworkProfile

Profil pour la gestion de 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 l’échec de la dernière 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 d’inactivité.

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

Profil pour la gestion de l’arrêt des machines virtuelles.

Nom Type Valeur par défaut Description
disconnectDelay

string

Durée pendant laquelle une machine virtuelle reste en cours d’exécution après la déconnexion d’un utilisateur si ce comportement est activé.

idleDelay

string

Durée d’inactivité d’une machine virtuelle avant son arrêt si ce comportement est activé.

noConnectDelay

string

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

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

shutdownOnIdle

shutdownOnIdleMode

None

Indique si une machine virtuelle sera arrêtée lorsqu’elle est inactive pendant un certain temps.

shutdownWhenNotConnected

EnableState

Disabled

Indique si une machine virtuelle sera arrêtée quand elle n’a pas été connectée après un certain temps.

ConnectionProfile

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 au client via RDP.

clientSshAccess

ConnectionType

None

Niveau d’accès activé pour l’accès au 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

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

Nom Type Description
None

string

Private

string

Public

string

createdByType

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

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

EnableState

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

Nom Type Description
Disabled

string

Enabled

string

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.

ErrorDetail

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

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet error.

Identity

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

Les plans lab agissent comme un conteneur d’autorisations pour la création de labos 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 labo, 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 le créateur de labo à utiliser lors de la création de labos à l’aide de ce plan de labo.

properties.defaultAutoShutdownProfile

AutoShutdownProfile

Profil d’arrêt de laboratoire 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 de réseau lab, elles doivent être définies ici et ne peuvent pas être modifiées quand des labos existants sont associés à ce plan de labo.

properties.linkedLmsInstance

string

URL de base des lms instance ce plan de labo peut lier des listes de laboratoires.

properties.provisioningState

ProvisioningState

État d’approvisionnement actuel du plan lab.

properties.resourceOperationError

ResourceOperationError

Détails de l’erreur de la dernière opération effectuée sur le plan lab.

properties.sharedGalleryId

string

ID de ressource du Shared Image Gallery attaché à ce plan de labo. 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 à disposition pour être utilisées lors de la création de nouveaux labos.

properties.supportInfo

SupportInfo

Informations de contact et instructions de support pour les utilisateurs du plan lab. Ces informations sont affichées aux propriétaires de laboratoires et aux utilisateurs de machines virtuelles pour tous les labos du plan lab.

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

Profil pour la gestion de la mise en réseau pour les plans Lab.

Nom Type Description
subnetId

string

ID de ressource de sous-réseau externe

ProvisioningState

État d’approvisionnement actuel du plan lab.

Nom Type Description
Creating

string

La ressource est en cours de création.

Deleting

string

La ressource est en cours de suppression.

Failed

string

L’opération précédente sur la ressource a échoué, laissant la ressource dans un état non sain.

Locked

string

La ressource est verrouillée et les modifications sont actuellement bloquées. Cela peut être dû à une maintenance ou à une opération planifiée. L’état revient à réussite une fois l’opération de verrouillage terminée.

Succeeded

string

La ressource est dans un état sain après l’opération de création ou de mise à jour.

Updating

string

De nouvelles valeurs de propriété sont appliquées à la ressource.

ResourceIdentityType

Type d’identité.

Nom Type Description
SystemAssigned

string

ResourceOperationError

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

Nom Type Description
action

string

Action d’opération qui a échoué

code

string

Code qui correspond au type d’échec d’opération

message

string

Message d’échec de l’opération

timestamp

string

Dateheure de l’heure à laquelle l’erreur s’est produite

shutdownOnIdleMode

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

Nom Type Description
LowUsage

string

La machine virtuelle est considérée comme inactive lorsque l’utilisateur est absent et que la consommation des ressources (processeur et disque) est faible.

None

string

La machine virtuelle ne sera pas arrêtée lorsqu’elle est inactive.

UserAbsence

string

La machine virtuelle est considérée comme inactive lorsqu’il n’y a pas d’entrée au clavier ou à la souris.

SupportInfo

Informations de contact et instructions du support technique.

Nom Type Description
email

string

Adresse e-mail du contact du support.

instructions

string

Instructions de support.

phone

string

Numéro de téléphone du contact du support technique.

url

string

Adresse web du support.

systemData

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

Nom Type Description
createdAt

string

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

Horodatage de la dernière modification de la 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.