Partager via

Restore Point Collections - Get

  • Référence
Service:
Compute
Version d'API:
2024-03-01

Opération permettant d’obtenir la collection de points de restauration.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}?api-version=2024-03-01
Avec des paramètres facultatifs: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}?$expand=restorePoints&api-version=2024-03-01

Paramètres URI

Nom Dans Obligatoire Type Description
resourceGroupName
 path True

string

Nom du groupe de ressources.
restorePointCollectionName
 path True

string

Nom de la collection de points de restauration.
subscriptionId
 path True

string

Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version
 query True

string

Version de l’API cliente.
$expand
 query

RestorePointCollectionExpandOptions

Expression de développement à appliquer à l’opération. Si expand=restorePoints, le serveur retourne tous les points de restauration contenus dans restorePointCollection.

Réponses

Nom Type Description
200 OK

RestorePointCollection

Ok
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

Exemples

Get a restore point collection, including the restore points contained in the restore point collection
Get a restore point collection (but not the restore points contained in the restore point collection)

Get a restore point collection, including the restore points contained in the restore point collection

Exemple de requête

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName?$expand=restorePoints&api-version=2024-03-01

Exemple de réponse

Code d’état:
200 
{
  "name": "rpcName",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName",
  "type": "Microsoft.Compute/restorePointCollections",
  "location": "westus",
  "tags": {
    "myTag1": "tagValue1"
  },
  "properties": {
    "source": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
      "location": "eastus"
    },
    "restorePointCollectionId": "59f04a5d-f783-4200-a1bd-d3f464e8c4b4",
    "provisioningState": "Succeeded",
    "restorePoints": [
      {
        "name": "restorePointName",
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName",
        "properties": {
          "excludeDisks": [
            {
              "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm8768_disk2_fe6ffde4f69b491ca33fb984d5bcd89f"
            }
          ],
          "sourceMetadata": {
            "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7",
            "hardwareProfile": {
              "vmSize": "Standard_B1s"
            },
            "storageProfile": {
              "osDisk": {
                "osType": "Windows",
                "name": "testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f",
                "caching": "ReadWrite",
                "managedDisk": {
                  "storageAccountType": "Standard_LRS",
                  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"
                },
                "diskRestorePoint": {
                  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
                }
              },
              "dataDisks": [
                {
                  "lun": 1,
                  "name": "testingexcludedisk_DataDisk_1",
                  "caching": "None",
                  "managedDisk": {
                    "storageAccountType": "Standard_LRS",
                    "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_DataDisk_1"
                  },
                  "diskRestorePoint": {
                    "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5"
                  }
                }
              ],
              "diskControllerType": "NVMe"
            },
            "osProfile": {
              "computerName": "computerName",
              "adminUsername": "admin",
              "windowsConfiguration": {
                "provisionVMAgent": true,
                "enableAutomaticUpdates": true
              },
              "secrets": [],
              "allowExtensionOperations": true,
              "requireGuestProvisionSignal": true
            },
            "diagnosticsProfile": {
              "bootDiagnostics": {
                "enabled": true
              }
            },
            "location": "westus"
          },
          "provisioningState": "Succeeded",
          "consistencyMode": "ApplicationConsistent",
          "timeCreated": "2021-01-27T20:35:05.8401519+00:00"
        }
      }
    ]
  }
}

Get a restore point collection (but not the restore points contained in the restore point collection)

Exemple de requête

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc?$expand=restorePoints&api-version=2024-03-01

Exemple de réponse

Code d’état:
200 
{
  "name": "myRpc",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc",
  "type": "Microsoft.Compute/restorePointCollections",
  "location": "westus",
  "tags": {
    "myTag1": "tagValue1"
  },
  "properties": {
    "source": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc",
      "location": "eastus"
    },
    "restorePointCollectionId": "59f04a5d-f783-4200-a1bd-d3f464e8c4b4",
    "provisioningState": "Succeeded"
  }
}

Définitions

Nom Description
AdditionalUnattendContent

Spécifie des informations au format XML supplémentaires qui peuvent être incluses dans le fichier Unattend.xml, qui est utilisé par le programme d’installation de Windows. Le contenu est défini en définissant le nom, le nom du composant et la passe dans laquelle le contenu est appliqué.
ApiEntityReference

Référence de l’entité API.
ApiError

Erreur d’API.
ApiErrorBase

Base d’erreurs de l’API.
BootDiagnostics

Diagnostics de démarrage est une fonctionnalité de débogage qui vous permet d’afficher la sortie de la console et la capture d’écran pour diagnostiquer les status de machines virtuelles. Vous pouvez facilement afficher la sortie de votre journal de console. Azure vous permet également de voir une capture d’écran de la machine virtuelle à partir de l’hyperviseur.
CachingTypes

Obtient le type de mise en cache.
CloudError

Réponse d’erreur du service de calcul.
ComponentNames

Nom du composant. Actuellement, la seule valeur autorisée est Microsoft-Windows-Shell-Setup.
ConsistencyModeTypes

ConsistencyMode du RestorePoint. Peut être spécifié dans l’entrée lors de la création d’un point de restauration. Pour l’instant, seul CrashConsistent est accepté en tant qu’entrée valide. Pour plus d’informations, reportez-vous à https://aka.ms/RestorePoints .
DiagnosticsProfile

Spécifie l’état des paramètres de diagnostic de démarrage. Version minimale de l’API : 2015-06-15.
DiskControllerTypes

Obtient le type de contrôleur de disque de la machine virtuelle capturée au moment de la création du point de restauration.
DiskEncryptionSetParameters

Décrit le paramètre de l’ID de ressource du jeu de chiffrement de disque géré par le client qui peut être spécifié pour le disque. Note: L’ID de ressource du jeu de chiffrement de disque ne peut être spécifié que pour le disque managé. Pour plus d’informations, reportez-vous https://aka.ms/mdssewithcmkoverview .
DiskEncryptionSettings

Décrit les paramètres de chiffrement d’un disque
DiskRestorePointAttributes

Détails du point de restauration de disque.
DiskRestorePointInstanceView

Vue instance d’un point de restauration de disque.
DiskRestorePointReplicationStatus

Vue instance d’un point de restauration de disque.
EncryptionIdentity

Spécifie l’identité managée utilisée par ADE pour obtenir le jeton d’accès pour les opérations de coffre de clés.
HardwareProfile

Spécifie les paramètres matériels de la machine virtuelle.
HyperVGenerationTypes

HyperVGeneration de la machine virtuelle source pour laquelle le point de restauration est capturé.
InnerError

Détails internes de l’erreur.
InstanceViewStatus

Vue d’instance status.
KeyVaultKeyReference

Décrit une référence à Key Vault Key
KeyVaultSecretReference

Décrit une référence à Key Vault Secret
LinuxConfiguration

Spécifie les paramètres du système d’exploitation Linux sur la machine virtuelle. Pour obtenir la liste des distributions Linux prises en charge, consultez Linux on Azure-Endorsed Distributions.
LinuxPatchAssessmentMode

Spécifie le mode d’évaluation des correctifs d’invité de machine virtuelle pour la machine virtuelle IaaS.

Les valeurs possibles sont les suivantes :

ImageDefault : vous contrôlez le minutage des évaluations des correctifs sur une machine virtuelle.

AutomaticByPlatform : la plateforme déclenche des évaluations périodiques des correctifs. La propriété provisionVMAgent doit être true.
LinuxPatchSettings

Spécifie les paramètres liés à la mise à jour corrective de l’invité de machine virtuelle sur Linux.
LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Spécifie le paramètre de redémarrage pour toutes les opérations d’installation du correctif AutomaticByPlatform.
LinuxVMGuestPatchAutomaticByPlatformSettings

Spécifie des paramètres supplémentaires à appliquer lorsque le mode de correctif AutomaticByPlatform est sélectionné dans les paramètres de correctif Linux.
LinuxVMGuestPatchMode

Spécifie le mode de mise à jour corrective de l’invité de machine virtuelle sur une machine virtuelle IaaS ou des machines virtuelles associées à un groupe de machines virtuelles identiques avec OrchestrationMode comme flexible.

Les valeurs possibles sont les suivantes :

ImageDefault : la configuration de mise à jour corrective par défaut de la machine virtuelle est utilisée.

AutomaticByPlatform : la machine virtuelle est automatiquement mise à jour par la plateforme. La propriété provisionVMAgent doit être true
ManagedDiskParameters

Paramètres d’un disque managé.
Mode

Spécifie le mode sur lequel ProxyAgent s’exécutera si la fonctionnalité est activée. ProxyAgent commence à auditer ou à surveiller, mais pas à appliquer le contrôle d’accès sur les demandes aux points de terminaison hôtes en mode Audit, tandis qu’en mode Appliquer, il applique le contrôle d’accès. La valeur par défaut est Mode d’application.
OperatingSystemType

Obtient le type de système d’exploitation.
OSProfile

Spécifie les paramètres du système d’exploitation de la machine virtuelle. Certains paramètres ne peuvent pas être modifiés une fois la machine virtuelle approvisionnée.
PassNames

Nom de passe. Actuellement, la seule valeur autorisée est OobeSystem.
PatchSettings

Spécifie les paramètres liés à la mise à jour corrective de l’invité de machine virtuelle sur Windows.
ProtocolTypes

Spécifie le protocole de l’écouteur WinRM. Les valeurs possibles sont : http,https.
ProxyAgentSettings

Spécifie les paramètres ProxyAgent lors de la création de la machine virtuelle. Version minimale de l’API : 01-03-2024.
RestorePoint

Détails du point de restauration.
RestorePointCollection

Créez ou mettez à jour des paramètres de collection point de restauration.
RestorePointCollectionExpandOptions

Expression de développement à appliquer à l’opération. Si expand=restorePoints, le serveur retourne tous les points de restauration contenus dans restorePointCollection.
RestorePointCollectionSourceProperties

Propriétés de la ressource source à partir de laquelle cette collection de points de restauration est créée.
RestorePointEncryption

Paramètres de chiffrement au repos pour le point de restauration de disque. Il s’agit d’une propriété facultative qui peut être spécifiée dans l’entrée lors de la création d’un point de restauration.
RestorePointEncryptionType

Type de clé utilisé pour chiffrer les données du point de restauration de disque.
RestorePointInstanceView

Vue instance d’un point de restauration.
RestorePointSourceMetadata

Décrit les propriétés de la machine virtuelle pour laquelle le point de restauration a été créé. Les propriétés fournies sont un sous-ensemble et les instantané des propriétés globales de la machine virtuelle capturées au moment de la création du point de restauration.
RestorePointSourceVMDataDisk

Décrit un disque de données.
RestorePointSourceVMOSDisk

Décrit un disque de système d’exploitation.
RestorePointSourceVMStorageProfile

Décrit le profil de stockage.
securityEncryptionTypes

Spécifie le type de chiffrement du disque managé. Il est défini sur DiskWithVMGuestState pour le chiffrement du disque managé, avec l’objet blob VMGuestState, VMGuestStateOnly pour le chiffrement uniquement de l’objet blob VMGuestState et NonPersistedTPM pour ne pas conserver l’état du microprogramme dans l’objet blob VMGuestState. Note: Il peut être défini uniquement pour les machines virtuelles confidentielles.
SecurityProfile

Spécifie les paramètres de profil de sécurité pour la machine virtuelle ou le groupe de machines virtuelles identiques.
SecurityTypes

Spécifie le SecurityType de la machine virtuelle. Elle doit être définie sur n’importe quelle valeur spécifiée pour activer UefiSettings. Le comportement par défaut est : UefiSettings ne sera pas activé, sauf si cette propriété est définie.
SettingNames

Spécifie le nom du paramètre auquel le contenu s'applique. Les valeurs possibles sont : FirstLogonCommands et AutoLogon.
SshConfiguration

Configuration SSH pour les machines virtuelles Linux s’exécutant sur Azure
SshPublicKey

Contient des informations sur la clé publique du certificat SSH et le chemin d’accès sur la machine virtuelle Linux où la clé publique est placée.
StatusLevelTypes

Code de niveau.
StorageAccountTypes

Spécifie le type de compte de stockage pour le disque managé. REMARQUE : UltraSSD_LRS ne peut être utilisé qu’avec des disques de données, il ne peut pas être utilisé avec le disque du système d’exploitation.
SubResource
UefiSettings

Spécifie les paramètres de sécurité tels que le démarrage sécurisé et vTPM utilisés lors de la création de la machine virtuelle. Version minimale de l’API : 01-12-2020.
VaultCertificate

Décrit une référence de certificat unique dans un Key Vault et l’emplacement où le certificat doit résider sur la machine virtuelle.
VaultSecretGroup

Décrit un ensemble de certificats qui se trouvent tous dans le même Key Vault.
VirtualMachineSizeTypes

Spécifie la taille de la machine virtuelle. Le type de données enum est actuellement déconseillé et sera supprimé d’ici le 23 décembre 2023. La méthode recommandée pour obtenir la liste des tailles disponibles consiste à utiliser les API suivantes : Répertorier toutes les tailles de machine virtuelle disponibles dans un groupe à haute disponibilité, Répertorier toutes les tailles de machine virtuelle disponibles dans une région, Répertorier toutes les tailles de machine virtuelle disponibles pour le redimensionnement. Pour plus d’informations sur les tailles des machines virtuelles, consultez Tailles des machines virtuelles. Les tailles de machine virtuelle disponibles dépendent de la région et du groupe à haute disponibilité.
VMDiskSecurityProfile

Spécifie les paramètres de profil de sécurité pour le disque managé. Note: Il ne peut être défini que pour les machines virtuelles confidentielles.
VMSizeProperties

Spécifie les paramètres de la propriété Taille de la machine virtuelle sur la machine virtuelle.
WindowsConfiguration

Spécifie les paramètres du système d’exploitation Windows sur la machine virtuelle.
WindowsPatchAssessmentMode

Spécifie le mode d’évaluation des correctifs de l’invité de machine virtuelle pour la machine virtuelle IaaS.

Les valeurs possibles sont les suivantes :

ImageDefault : vous contrôlez le minutage des évaluations des correctifs sur une machine virtuelle.

AutomaticByPlatform : la plateforme déclenche des évaluations périodiques des correctifs. La propriété provisionVMAgent doit être true.
WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Spécifie le paramètre de redémarrage pour toutes les opérations d’installation du correctif AutomaticByPlatform.
WindowsVMGuestPatchAutomaticByPlatformSettings

Spécifie des paramètres supplémentaires à appliquer lorsque le mode de correctif AutomaticByPlatform est sélectionné dans les paramètres de correctif Windows.
WindowsVMGuestPatchMode

Spécifie le mode de mise à jour corrective de l’invité de machine virtuelle sur une machine virtuelle IaaS ou des machines virtuelles associées à un groupe de machines virtuelles identiques avec OrchestrationMode comme flexible.

Les valeurs possibles sont les suivantes :

Manuel : vous contrôlez l’application des correctifs à une machine virtuelle. Pour ce faire, appliquez des correctifs manuellement à l’intérieur de la machine virtuelle. Dans ce mode, les mises à jour automatiques sont désactivées ; La propriété WindowsConfiguration.enableAutomaticUpdates doit avoir la valeur false

AutomaticByOS : la machine virtuelle est automatiquement mise à jour par le système d’exploitation. La propriété WindowsConfiguration.enableAutomaticUpdates doit être true.

AutomaticByPlatform : la machine virtuelle est automatiquement mise à jour par la plateforme. Les propriétés provisionVMAgent et WindowsConfiguration.enableAutomaticUpdates doivent être true
WinRMConfiguration

Décrit la configuration de la gestion à distance Windows de la machine virtuelle
WinRMListener

Décrit le protocole et l’empreinte numérique de l’écouteur Windows Remote Management

AdditionalUnattendContent

Spécifie des informations au format XML supplémentaires qui peuvent être incluses dans le fichier Unattend.xml, qui est utilisé par le programme d’installation de Windows. Le contenu est défini en définissant le nom, le nom du composant et la passe dans laquelle le contenu est appliqué.

Nom Type Description
componentName

ComponentNames

Nom du composant. Actuellement, la seule valeur autorisée est Microsoft-Windows-Shell-Setup.
content

string

Spécifie le contenu au format XML qui est ajouté au fichier unattend.xml pour le chemin d’accès et le composant spécifiés. Le code XML doit être inférieur à 4 Ko et doit inclure l’élément racine pour le paramètre ou la fonctionnalité en cours d’insertion.
passName

PassNames

Nom de passe. Actuellement, la seule valeur autorisée est OobeSystem.
settingName

SettingNames

Spécifie le nom du paramètre auquel le contenu s'applique. Les valeurs possibles sont : FirstLogonCommands et AutoLogon.

ApiEntityReference

Référence de l’entité API.

Nom Type Description
id

string

ID de ressource ARM sous la forme /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Erreur d’API.

Nom Type Description
code

string

Code d'erreur.
details

ApiErrorBase[]

Détails de l’erreur api
innererror

InnerError

Erreur interne de l’API
message

string

Message d’erreur.
target

string

Cible de l’erreur particulière.

ApiErrorBase

Base d’erreurs de l’API.

Nom Type Description
code

string

Code d'erreur.
message

string

Message d’erreur.
target

string

Cible de l’erreur particulière.

BootDiagnostics

Diagnostics de démarrage est une fonctionnalité de débogage qui vous permet d’afficher la sortie de la console et la capture d’écran pour diagnostiquer les status de machines virtuelles. Vous pouvez facilement afficher la sortie de votre journal de console. Azure vous permet également de voir une capture d’écran de la machine virtuelle à partir de l’hyperviseur.

Nom Type Description
enabled

boolean

Indique si le diagnostics de démarrage doit être activé sur la machine virtuelle.
storageUri

string

URI du compte de stockage à utiliser pour placer la sortie et la capture d’écran de la console. Si storageUri n’est pas spécifié lors de l’activation de la diagnostics de démarrage, le stockage managé est utilisé.

CachingTypes

Obtient le type de mise en cache.

Nom Type Description
None

string

ReadOnly

string

ReadWrite

string

CloudError

Réponse d’erreur du service de calcul.

Nom Type Description
error

ApiError

Erreur d’API.

ComponentNames

Nom du composant. Actuellement, la seule valeur autorisée est Microsoft-Windows-Shell-Setup.

Nom Type Description
Microsoft-Windows-Shell-Setup

string

ConsistencyModeTypes

ConsistencyMode du RestorePoint. Peut être spécifié dans l’entrée lors de la création d’un point de restauration. Pour l’instant, seul CrashConsistent est accepté en tant qu’entrée valide. Pour plus d’informations, reportez-vous à https://aka.ms/RestorePoints .

Nom Type Description
ApplicationConsistent

string

CrashConsistent

string

FileSystemConsistent

string

DiagnosticsProfile

Spécifie l’état des paramètres de diagnostic de démarrage. Version minimale de l’API : 2015-06-15.

Nom Type Description
bootDiagnostics

BootDiagnostics

Diagnostics de démarrage est une fonctionnalité de débogage qui vous permet d’afficher la sortie de la console et la capture d’écran pour diagnostiquer les status de machines virtuelles. REMARQUE : si storageUri est spécifié, vérifiez que le compte de stockage se trouve dans la même région et le même abonnement que la machine virtuelle. Vous pouvez facilement afficher la sortie de votre journal de console. Azure vous permet également de voir une capture d’écran de la machine virtuelle à partir de l’hyperviseur.

DiskControllerTypes

Obtient le type de contrôleur de disque de la machine virtuelle capturée au moment de la création du point de restauration.

Nom Type Description
NVMe

string

SCSI

string

DiskEncryptionSetParameters

Décrit le paramètre de l’ID de ressource du jeu de chiffrement de disque géré par le client qui peut être spécifié pour le disque. Note: L’ID de ressource du jeu de chiffrement de disque ne peut être spécifié que pour le disque managé. Pour plus d’informations, reportez-vous https://aka.ms/mdssewithcmkoverview .

Nom Type Description
id

string

ID de ressource

DiskEncryptionSettings

Décrit les paramètres de chiffrement d’un disque

Nom Type Description
diskEncryptionKey

KeyVaultSecretReference

Spécifie l’emplacement de la clé de chiffrement de disque, qui est un secret Key Vault.
enabled

boolean

Spécifie si le chiffrement de disque doit être activé sur la machine virtuelle.
keyEncryptionKey

KeyVaultKeyReference

Spécifie l’emplacement de la clé de chiffrement de clé dans Key Vault.

DiskRestorePointAttributes

Détails du point de restauration de disque.

Nom Type Description
encryption

RestorePointEncryption

Paramètres de chiffrement au repos pour le point de restauration de disque. Il s’agit d’une propriété facultative qui peut être spécifiée dans l’entrée lors de la création d’un point de restauration.
id

string

ID de ressource
sourceDiskRestorePoint

ApiEntityReference

ID de ressource du point de restauration du disque source.

DiskRestorePointInstanceView

Vue instance d’un point de restauration de disque.

Nom Type Description
id

string

ID du point de restauration de disque.
replicationStatus

DiskRestorePointReplicationStatus

La réplication du point de restauration de disque status informations.

DiskRestorePointReplicationStatus

Vue instance d’un point de restauration de disque.

Nom Type Description
completionPercent

integer

Pourcentage d’achèvement de la réplication.
status

InstanceViewStatus

La ressource status informations.

EncryptionIdentity

Spécifie l’identité managée utilisée par ADE pour obtenir le jeton d’accès pour les opérations de coffre de clés.

Nom Type Description
userAssignedIdentityResourceId

string

Spécifie l’ID de ressource ARM de l’une des identités utilisateur associées à la machine virtuelle.

HardwareProfile

Spécifie les paramètres matériels de la machine virtuelle.

Nom Type Description
vmSize

VirtualMachineSizeTypes

Spécifie la taille de la machine virtuelle. Le type de données enum est actuellement déconseillé et sera supprimé d’ici le 23 décembre 2023. La méthode recommandée pour obtenir la liste des tailles disponibles consiste à utiliser ces API : Répertorier toutes les tailles de machine virtuelle disponibles dans un groupe à haute disponibilité, Répertorier toutes les tailles de machine virtuelle disponibles dans une région, Répertorier toutes les tailles de machine virtuelle disponibles pour le redimensionnement. Pour plus d’informations sur les tailles des machines virtuelles, consultez Tailles des machines virtuelles. Les tailles de machine virtuelle disponibles dépendent de la région et du groupe à haute disponibilité.
vmSizeProperties

VMSizeProperties

Spécifie les propriétés permettant de personnaliser la taille de la machine virtuelle. Version minimale de l’api : 01/07/2021. Cette fonctionnalité est toujours en mode préversion et n’est pas prise en charge pour VirtualMachineScaleSet. Pour plus d’informations, suivez les instructions fournies dans Personnalisation de la machine virtuelle.

HyperVGenerationTypes

HyperVGeneration de la machine virtuelle source pour laquelle le point de restauration est capturé.

Nom Type Description
V1

string

V2

string

InnerError

Détails internes de l’erreur.

Nom Type Description
errordetail

string

Message d’erreur interne ou vidage d’exception.
exceptiontype

string

Type d'exception.

InstanceViewStatus

Vue d’instance status.

Nom Type Description
code

string

Code d'état.
displayStatus

string

Étiquette courte localisable pour le status.
level

StatusLevelTypes

Code de niveau.
message

string

Message de status détaillé, y compris pour les alertes et les messages d’erreur.
time

string

Heure du status.

KeyVaultKeyReference

Décrit une référence à Key Vault Key

Nom Type Description
keyUrl

string

URL référençant une clé de chiffrement de clé dans Key Vault.
sourceVault

SubResource

URL relative du Key Vault contenant la clé.

KeyVaultSecretReference

Décrit une référence à Key Vault Secret

Nom Type Description
secretUrl

string

URL référençant un secret dans un Key Vault.
sourceVault

SubResource

URL relative du Key Vault contenant le secret.

LinuxConfiguration

Spécifie les paramètres du système d’exploitation Linux sur la machine virtuelle. Pour obtenir la liste des distributions Linux prises en charge, consultez Linux on Azure-Endorsed Distributions.

Nom Type Description
disablePasswordAuthentication

boolean

Spécifie si l’authentification par mot de passe doit être désactivée.
enableVMAgentPlatformUpdates

boolean

Indique si le Mises à jour de la plateforme VMAgent est activé pour la machine virtuelle Linux. La valeur par défaut est false.
patchSettings

LinuxPatchSettings

[Fonctionnalité en préversion] Spécifie les paramètres liés à la mise à jour corrective de l’invité de machine virtuelle sur Linux.
provisionVMAgent

boolean

Indique si l'agent de machine virtuelle doit être configuré sur la machine virtuelle. Lorsque cette propriété n’est pas spécifiée dans le corps de la demande, le comportement par défaut consiste à lui affecter la valeur true. Cela garantit que l’agent de machine virtuelle est installé sur la machine virtuelle afin que les extensions puissent être ajoutées ultérieurement à la machine virtuelle.
ssh

SshConfiguration

Spécifie la configuration de la clé SSH pour un système d’exploitation Linux.

LinuxPatchAssessmentMode

Spécifie le mode d’évaluation des correctifs d’invité de machine virtuelle pour la machine virtuelle IaaS.

Les valeurs possibles sont les suivantes :

ImageDefault : vous contrôlez le minutage des évaluations des correctifs sur une machine virtuelle.

AutomaticByPlatform : la plateforme déclenche des évaluations périodiques des correctifs. La propriété provisionVMAgent doit être true.

Nom Type Description
AutomaticByPlatform

string

ImageDefault

string

LinuxPatchSettings

Spécifie les paramètres liés à la mise à jour corrective de l’invité de machine virtuelle sur Linux.

Nom Type Description
assessmentMode

LinuxPatchAssessmentMode

Spécifie le mode d’évaluation des correctifs d’invité de machine virtuelle pour la machine virtuelle IaaS.

Les valeurs possibles sont les suivantes :

ImageDefault : vous contrôlez le minutage des évaluations des correctifs sur une machine virtuelle.

AutomaticByPlatform : la plateforme déclenche des évaluations périodiques des correctifs. La propriété provisionVMAgent doit être true.
automaticByPlatformSettings

LinuxVMGuestPatchAutomaticByPlatformSettings

Spécifie des paramètres supplémentaires pour le mode de correctif AutomaticByPlatform dans la mise à jour corrective d’invité de machine virtuelle sur Linux.
patchMode

LinuxVMGuestPatchMode

Spécifie le mode de mise à jour corrective de l’invité de machine virtuelle sur une machine virtuelle IaaS ou des machines virtuelles associées à un groupe de machines virtuelles identiques avec OrchestrationMode comme flexible.

Les valeurs possibles sont les suivantes :

ImageDefault : la configuration de mise à jour corrective par défaut de la machine virtuelle est utilisée.

AutomaticByPlatform : la machine virtuelle est automatiquement mise à jour par la plateforme. La propriété provisionVMAgent doit être true

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Spécifie le paramètre de redémarrage pour toutes les opérations d’installation du correctif AutomaticByPlatform.

Nom Type Description
Always

string

IfRequired

string

Never

string

Unknown

string

LinuxVMGuestPatchAutomaticByPlatformSettings

Spécifie des paramètres supplémentaires à appliquer lorsque le mode de correctif AutomaticByPlatform est sélectionné dans les paramètres de correctif Linux.

Nom Type Description
bypassPlatformSafetyChecksOnUserSchedule

boolean

Permet au client de planifier des mises à jour correctives sans mises à niveau accidentelles
rebootSetting

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Spécifie le paramètre de redémarrage pour toutes les opérations d’installation du correctif AutomaticByPlatform.

LinuxVMGuestPatchMode

Spécifie le mode de mise à jour corrective de l’invité de machine virtuelle sur une machine virtuelle IaaS ou des machines virtuelles associées à un groupe de machines virtuelles identiques avec OrchestrationMode comme flexible.

Les valeurs possibles sont les suivantes :

ImageDefault : la configuration de mise à jour corrective par défaut de la machine virtuelle est utilisée.

AutomaticByPlatform : la machine virtuelle est automatiquement mise à jour par la plateforme. La propriété provisionVMAgent doit être true

Nom Type Description
AutomaticByPlatform

string

ImageDefault

string

ManagedDiskParameters

Paramètres d’un disque managé.

Nom Type Description
diskEncryptionSet

DiskEncryptionSetParameters

Spécifie l’ID de ressource du jeu de chiffrement de disque managé du client pour le disque managé.
id

string

ID de ressource
securityProfile

VMDiskSecurityProfile

Spécifie le profil de sécurité du disque managé.
storageAccountType

StorageAccountTypes

Spécifie le type de compte de stockage pour le disque managé. REMARQUE : UltraSSD_LRS ne peut être utilisé qu’avec des disques de données, il ne peut pas être utilisé avec le disque du système d’exploitation.

Mode

Spécifie le mode sur lequel ProxyAgent s’exécutera si la fonctionnalité est activée. ProxyAgent commence à auditer ou à surveiller, mais pas à appliquer le contrôle d’accès sur les demandes aux points de terminaison hôtes en mode Audit, tandis qu’en mode Appliquer, il applique le contrôle d’accès. La valeur par défaut est Mode d’application.

Nom Type Description
Audit

string

Enforce

string

OperatingSystemType

Obtient le type de système d’exploitation.

Nom Type Description
Linux

string

Windows

string

OSProfile

Spécifie les paramètres du système d’exploitation de la machine virtuelle. Certains paramètres ne peuvent pas être modifiés une fois la machine virtuelle approvisionnée.

Nom Type Description
adminPassword

string

Spécifie le mot de passe du compte d’administrateur.

Longueur minimale (Windows) : 8 caractères

Longueur minimale (Linux) : 6 caractères

Longueur maximale (Windows) : 123 caractères

Longueur maximale (Linux) : 72 caractères

Exigences de complexité : 3 conditions sur 4 ci-dessous doivent être remplies
Comporte des caractères inférieurs
Comporte des caractères supérieurs
A un chiffre
A un caractère spécial (correspondance regex [\W_])

Valeurs non autorisées : « abc@123 », « P@$$w 0rd », « P@ssw0rd », « P@ssword123 », « Pa$$word », « pass@word1 », « Password ! », « Password1 », « Password22 », « iloveyou ! »

Pour réinitialiser le mot de passe, consultez Comment réinitialiser le service Bureau à distance ou son mot de passe de connexion dans une machine virtuelle Windows

Pour réinitialiser le mot de passe racine, consultez Gérer les utilisateurs, SSH et case activée ou réparer des disques sur des machines virtuelles Linux Azure à l’aide de l’extension VMAccess
adminUsername

string

Spécifie le nom du compte d’administrateur.

Cette propriété ne peut pas être mise à jour après la création de la machine virtuelle.

Restriction Windows uniquement : Impossible de se terminer par « ».

Valeurs non autorisées : « administrator », « admin », « user », « user1 », « test », « user2 », « test1 », « user3 », « admin1 », « 1 », « 123 », « a », « actuser », « adm », « admin2 », « aspnet », « backup », « console », « david », « guest », « john », « owner », « root », « server », « sql », « support », « support_388945a0 », « sys », « test2 », « test3 », « user4 », « user5 ».

Longueur minimale (Linux) : 1 caractère

Longueur maximale (Linux) : 64 caractères

Longueur maximale (Windows) : 20 caractères.
allowExtensionOperations

boolean

Spécifie si les opérations d’extension doivent être autorisées sur la machine virtuelle. Cette valeur peut uniquement être définie sur False lorsqu’aucune extension n’est présente sur la machine virtuelle.
computerName

string

Spécifie le nom du système d’exploitation hôte de la machine virtuelle. Ce nom ne peut pas être mis à jour après la création de la machine virtuelle. Longueur maximale (Windows) : 15 caractères. Longueur maximale (Linux) : 64 caractères. Pour connaître les conventions et restrictions de nommage, consultez Instructions d’implémentation des services d’infrastructure Azure.
customData

string

Spécifie une chaîne codée en base 64 de données personnalisées. La chaîne codée en base 64 est décodée dans un tableau binaire enregistré dans un fichier sur la machine virtuelle. La longueur maximale du tableau binaire est 65535 octets. Remarque : Ne passez pas de secrets ou de mots de passe dans la propriété customData. Cette propriété ne peut pas être mise à jour après la création de la machine virtuelle. La propriété « customData » est passée à la machine virtuelle pour être enregistrée en tant que fichier. Pour plus d’informations, consultez Données personnalisées sur les machines virtuelles Azure. Pour utiliser cloud-init pour votre machine virtuelle Linux, consultez Utilisation de cloud-init pour personnaliser une machine virtuelle Linux lors de la création.
linuxConfiguration

LinuxConfiguration

Spécifie les paramètres du système d’exploitation Linux sur la machine virtuelle. Pour obtenir la liste des distributions Linux prises en charge, consultez Linux on Azure-Endorsed Distributions.
requireGuestProvisionSignal

boolean

Propriété facultative qui doit être définie sur True ou omise.
secrets

VaultSecretGroup[]

Spécifie le jeu de certificats à installer sur la machine virtuelle. Pour installer des certificats sur une machine virtuelle, il est recommandé d’utiliser l’extension de machine virtuelle Azure Key Vault pour Linux ou l’extension de machine virtuelle Azure Key Vault pour Windows.
windowsConfiguration

WindowsConfiguration

Spécifie les paramètres du système d’exploitation Windows sur la machine virtuelle.

PassNames

Nom de passe. Actuellement, la seule valeur autorisée est OobeSystem.

Nom Type Description
OobeSystem

string

PatchSettings

Spécifie les paramètres liés à la mise à jour corrective de l’invité de machine virtuelle sur Windows.

Nom Type Description
assessmentMode

WindowsPatchAssessmentMode

Spécifie le mode d’évaluation des correctifs de l’invité de machine virtuelle pour la machine virtuelle IaaS.

Les valeurs possibles sont les suivantes :

ImageDefault : vous contrôlez le minutage des évaluations des correctifs sur une machine virtuelle.

AutomaticByPlatform : la plateforme déclenche des évaluations périodiques des correctifs. La propriété provisionVMAgent doit être true.
automaticByPlatformSettings

WindowsVMGuestPatchAutomaticByPlatformSettings

Spécifie des paramètres supplémentaires pour le mode de correctif AutomaticByPlatform dans la mise à jour corrective de l’invité de machine virtuelle sur Windows.
enableHotpatching

boolean

Permet aux clients de corriger leurs machines virtuelles Azure sans nécessiter de redémarrage. Pour enableHotpatching, « provisionVMAgent » doit être défini sur true et « patchMode » doit être défini sur « AutomaticByPlatform ».
patchMode

WindowsVMGuestPatchMode

Spécifie le mode de mise à jour corrective de l’invité de machine virtuelle sur une machine virtuelle IaaS ou des machines virtuelles associées à un groupe de machines virtuelles identiques avec OrchestrationMode comme flexible.

Les valeurs possibles sont les suivantes :

Manuel : vous contrôlez l’application des correctifs à une machine virtuelle. Pour ce faire, appliquez des correctifs manuellement à l’intérieur de la machine virtuelle. Dans ce mode, les mises à jour automatiques sont désactivées ; La propriété WindowsConfiguration.enableAutomaticUpdates doit avoir la valeur false

AutomaticByOS : la machine virtuelle est automatiquement mise à jour par le système d’exploitation. La propriété WindowsConfiguration.enableAutomaticUpdates doit être true.

AutomaticByPlatform : la machine virtuelle est automatiquement mise à jour par la plateforme. Les propriétés provisionVMAgent et WindowsConfiguration.enableAutomaticUpdates doivent être true

ProtocolTypes

Spécifie le protocole de l’écouteur WinRM. Les valeurs possibles sont : http,https.

Nom Type Description
Http

string

Https

string

ProxyAgentSettings

Spécifie les paramètres ProxyAgent lors de la création de la machine virtuelle. Version minimale de l’API : 01-03-2024.

Nom Type Description
enabled

boolean

Spécifie si la fonctionnalité ProxyAgent doit être activée sur la machine virtuelle ou le groupe de machines virtuelles identiques.
keyIncarnationId

integer

Augmenter la valeur de cette propriété permet à l’utilisateur de réinitialiser la clé utilisée pour sécuriser le canal de communication entre l’invité et l’hôte.
mode

Mode

Spécifie le mode sur lequel ProxyAgent s’exécutera si la fonctionnalité est activée. ProxyAgent commence à auditer ou à surveiller, mais pas à appliquer le contrôle d’accès sur les demandes aux points de terminaison hôtes en mode Audit, tandis qu’en mode Appliquer, il applique le contrôle d’accès. La valeur par défaut est Mode d’application.

RestorePoint

Détails du point de restauration.

Nom Type Description
id

string

ID de ressource
name

string

Nom de la ressource
properties.consistencyMode

ConsistencyModeTypes

ConsistencyMode du RestorePoint. Peut être spécifié dans l’entrée lors de la création d’un point de restauration. Pour l’instant, seul CrashConsistent est accepté en tant qu’entrée valide. Pour plus d’informations, reportez-vous à https://aka.ms/RestorePoints .
properties.excludeDisks

ApiEntityReference[]

Liste des ID de ressource de disque que le client souhaite exclure du point de restauration. Si aucun disque n’est spécifié, tous les disques sont inclus.
properties.instanceView

RestorePointInstanceView

Point de restauration instance vue.
properties.provisioningState

string

Obtient l’état d’approvisionnement du point de restauration.
properties.sourceMetadata

RestorePointSourceMetadata

Obtient les détails de la machine virtuelle capturée au moment de la création du point de restauration.
properties.sourceRestorePoint

ApiEntityReference

ID de ressource du point de restauration source à partir duquel une copie doit être créée.
properties.timeCreated

string

Obtient l’heure de création du point de restauration.
type

string

Type de ressource

RestorePointCollection

Créez ou mettez à jour des paramètres de collection point de restauration.

Nom Type Description
id

string

ID de ressource
location

string

Emplacement de la ressource
name

string

Nom de la ressource
properties.provisioningState

string

État d’approvisionnement de la collection de points de restauration.
properties.restorePointCollectionId

string

ID unique de la collection de points de restauration.
properties.restorePoints

RestorePoint[]

Liste contenant tous les points de restauration créés sous cette collection de points de restauration.
properties.source

RestorePointCollectionSourceProperties

Propriétés de la ressource source à partir de laquelle cette collection de points de restauration est créée.
tags

object

Balises de ressource
type

string

Type de ressource

RestorePointCollectionExpandOptions

Expression de développement à appliquer à l’opération. Si expand=restorePoints, le serveur retourne tous les points de restauration contenus dans restorePointCollection.

Nom Type Description
restorePoints

string

RestorePointCollectionSourceProperties

Propriétés de la ressource source à partir de laquelle cette collection de points de restauration est créée.

Nom Type Description
id

string

ID de ressource de la ressource source utilisée pour créer cette collection de points de restauration
location

string

Emplacement de la ressource source utilisée pour créer cette collection de points de restauration.

RestorePointEncryption

Paramètres de chiffrement au repos pour le point de restauration de disque. Il s’agit d’une propriété facultative qui peut être spécifiée dans l’entrée lors de la création d’un point de restauration.

Nom Type Description
diskEncryptionSet

DiskEncryptionSetParameters

Décrit le paramètre de l’ID de ressource du jeu de chiffrement de disque géré par le client qui peut être spécifié pour le disque. Note: L’ID de ressource du jeu de chiffrement de disque ne peut être spécifié que pour le disque managé. Pour plus d’informations, reportez-vous https://aka.ms/mdssewithcmkoverview .
type

RestorePointEncryptionType

Type de clé utilisé pour chiffrer les données du point de restauration de disque.

RestorePointEncryptionType

Type de clé utilisé pour chiffrer les données du point de restauration de disque.

Nom Type Description
EncryptionAtRestWithCustomerKey

string

Le point de restauration de disque est chiffré au repos avec une clé gérée par le client qui peut être modifiée et révoquée par un client.
EncryptionAtRestWithPlatformAndCustomerKeys

string

Le point de restauration de disque est chiffré au repos avec 2 couches de chiffrement. L’une des clés est gérée par le client et l’autre clé est gérée par la plateforme.
EncryptionAtRestWithPlatformKey

string

Le point de restauration de disque est chiffré au repos avec la clé gérée par la plateforme.

RestorePointInstanceView

Vue instance d’un point de restauration.

Nom Type Description
diskRestorePoints

DiskRestorePointInstanceView[]

Informations sur les points de restauration de disque.
statuses

InstanceViewStatus[]

La ressource status informations.

RestorePointSourceMetadata

Décrit les propriétés de la machine virtuelle pour laquelle le point de restauration a été créé. Les propriétés fournies sont un sous-ensemble et les instantané des propriétés globales de la machine virtuelle capturées au moment de la création du point de restauration.

Nom Type Description
diagnosticsProfile

DiagnosticsProfile

Obtient le profil diagnostics.
hardwareProfile

HardwareProfile

Obtient le profil matériel.
hyperVGeneration

HyperVGenerationTypes

HyperVGeneration de la machine virtuelle source pour laquelle le point de restauration est capturé.
licenseType

string

Obtient le type de licence, qui est pour apporter votre propre scénario de licence.
location

string

Emplacement de la machine virtuelle à partir de laquelle le point de restauration a été créé.
osProfile

OSProfile

Obtient le profil du système d’exploitation.
securityProfile

SecurityProfile

Obtient le profil de sécurité.
storageProfile

RestorePointSourceVMStorageProfile

Obtient le profil de stockage.
userData

string

UserData associé à la machine virtuelle source pour laquelle le point de restauration est capturé, qui est une valeur encodée en base 64.
vmId

string

Obtient l’ID unique de la machine virtuelle.

RestorePointSourceVMDataDisk

Décrit un disque de données.

Nom Type Description
caching

CachingTypes

Obtient le type de mise en cache.
diskRestorePoint

DiskRestorePointAttributes

Contient les propriétés du point de restauration de disque.
diskSizeGB

integer

Obtient la taille de disque initiale en Go pour les disques de données vides, et la nouvelle taille souhaitée pour les disques de système d’exploitation et de données existants.
lun

integer

Obtient le numéro d’unité logique.
managedDisk

ManagedDiskParameters

Contient les détails du disque managé.
name

string

Obtient le nom du disque.
writeAcceleratorEnabled

boolean

Affiche true si l’accélérateur d’écriture est activé sur le disque.

RestorePointSourceVMOSDisk

Décrit un disque de système d’exploitation.

Nom Type Description
caching

CachingTypes

Obtient le type de mise en cache.
diskRestorePoint

DiskRestorePointAttributes

Contient les propriétés du point de restauration de disque.
diskSizeGB

integer

Obtient la taille du disque en Go.
encryptionSettings

DiskEncryptionSettings

Obtient les paramètres de chiffrement de disque.
managedDisk

ManagedDiskParameters

Obtient les détails du disque managé
name

string

Obtient le nom du disque.
osType

OperatingSystemType

Obtient le type de système d’exploitation.
writeAcceleratorEnabled

boolean

Affiche true si l’accélérateur d’écriture est activé sur le disque.

RestorePointSourceVMStorageProfile

Décrit le profil de stockage.

Nom Type Description
dataDisks

RestorePointSourceVMDataDisk[]

Obtient les disques de données de la machine virtuelle capturés au moment de la création du point de restauration.
diskControllerType

DiskControllerTypes

Obtient le type de contrôleur de disque de la machine virtuelle capturée au moment de la création du point de restauration.
osDisk

RestorePointSourceVMOSDisk

Obtient le disque de système d’exploitation de la machine virtuelle capturée au moment de la création du point de restauration.

securityEncryptionTypes

Spécifie le type de chiffrement du disque managé. Il est défini sur DiskWithVMGuestState pour le chiffrement du disque managé, avec l’objet blob VMGuestState, VMGuestStateOnly pour le chiffrement uniquement de l’objet blob VMGuestState et NonPersistedTPM pour ne pas conserver l’état du microprogramme dans l’objet blob VMGuestState. Note: Il peut être défini uniquement pour les machines virtuelles confidentielles.

Nom Type Description
DiskWithVMGuestState

string

NonPersistedTPM

string

VMGuestStateOnly

string

SecurityProfile

Spécifie les paramètres de profil de sécurité pour la machine virtuelle ou le groupe de machines virtuelles identiques.

Nom Type Description
encryptionAtHost

boolean

Cette propriété peut être utilisée par l’utilisateur dans la demande pour activer ou désactiver le chiffrement de l’hôte pour la machine virtuelle ou le groupe de machines virtuelles identiques. Cela active le chiffrement pour tous les disques, y compris le disque de ressource/temporaire sur l’hôte lui-même. Le comportement par défaut est : Le chiffrement sur l’hôte est désactivé, sauf si cette propriété a la valeur true pour la ressource.
encryptionIdentity

EncryptionIdentity

Spécifie l’identité managée utilisée par ADE pour obtenir le jeton d’accès pour les opérations de coffre de clés.
proxyAgentSettings

ProxyAgentSettings

Spécifie les paramètres ProxyAgent lors de la création de la machine virtuelle. Version minimale de l’API : 01-03-2024.
securityType

SecurityTypes

Spécifie le SecurityType de la machine virtuelle. Elle doit être définie sur n’importe quelle valeur spécifiée pour activer UefiSettings. Le comportement par défaut est : UefiSettings ne sera pas activé, sauf si cette propriété est définie.
uefiSettings

UefiSettings

Spécifie les paramètres de sécurité tels que le démarrage sécurisé et vTPM utilisés lors de la création de la machine virtuelle. Version minimale de l’API : 01-12-2020.

SecurityTypes

Spécifie le SecurityType de la machine virtuelle. Elle doit être définie sur n’importe quelle valeur spécifiée pour activer UefiSettings. Le comportement par défaut est : UefiSettings ne sera pas activé, sauf si cette propriété est définie.

Nom Type Description
ConfidentialVM

string

TrustedLaunch

string

SettingNames

Spécifie le nom du paramètre auquel le contenu s'applique. Les valeurs possibles sont : FirstLogonCommands et AutoLogon.

Nom Type Description
AutoLogon

string

FirstLogonCommands

string

SshConfiguration

Configuration SSH pour les machines virtuelles Linux s’exécutant sur Azure

Nom Type Description
publicKeys

SshPublicKey[]

Liste des clés publiques SSH utilisées pour l’authentification auprès de machines virtuelles linux.

SshPublicKey

Contient des informations sur la clé publique du certificat SSH et le chemin d’accès sur la machine virtuelle Linux où la clé publique est placée.

Nom Type Description
keyData

string

Certificat de clé publique SSH utilisé pour s’authentifier auprès de la machine virtuelle via ssh. La clé doit être au moins 2 048 bits et au format ssh-rsa. Pour créer des clés ssh, consultez [Créer des clés SSH sur Linux et Mac pour les machines virtuelles Linux dans Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
path

string

Spécifie le chemin d’accès complet sur la machine virtuelle créée où la clé publique ssh est stockée. Si le fichier existe déjà, la clé spécifiée est automatiquement ajoutée au fichier. Exemple : /home/user/.ssh/authorized_keys

StatusLevelTypes

Code de niveau.

Nom Type Description
Error

string

Info

string

Warning

string

StorageAccountTypes

Spécifie le type de compte de stockage pour le disque managé. REMARQUE : UltraSSD_LRS ne peut être utilisé qu’avec des disques de données, il ne peut pas être utilisé avec le disque du système d’exploitation.

Nom Type Description
PremiumV2_LRS

string

Premium_LRS

string

Premium_ZRS

string

StandardSSD_LRS

string

StandardSSD_ZRS

string

Standard_LRS

string

UltraSSD_LRS

string

SubResource

Nom Type Description
id

string

ID de ressource

UefiSettings

Spécifie les paramètres de sécurité tels que le démarrage sécurisé et vTPM utilisés lors de la création de la machine virtuelle. Version minimale de l’API : 01-12-2020.

Nom Type Description
secureBootEnabled

boolean

Spécifie si le démarrage sécurisé doit être activé sur la machine virtuelle. Version minimale de l’API : 01-12-2020.
vTpmEnabled

boolean

Spécifie si vTPM doit être activé sur la machine virtuelle. Version minimale de l’API : 01-12-2020.

VaultCertificate

Décrit une référence de certificat unique dans un Key Vault et l’emplacement où le certificat doit résider sur la machine virtuelle.

Nom Type Description
certificateStore

string

Pour les machines virtuelles Windows, spécifie le magasin de certificats sur la machine virtuelle à laquelle le certificat doit être ajouté. Le magasin de certificats spécifié se trouve implicitement dans le compte LocalMachine. Pour les machines virtuelles Linux, le fichier de certificat est placé sous le répertoire /var/lib/waagent, avec le nom <de fichier UppercaseThumbprint.crt> pour le fichier de certificat X509 et <UppercaseThumbprint.prv> pour la clé privée. Ces deux fichiers sont au format .pem.
certificateUrl

string

Il s’agit de l’URL d’un certificat qui a été chargé dans Key Vault en tant que secret. Pour ajouter un secret au Key Vault, consultez Ajouter une clé ou un secret au coffre de clés. Dans ce cas, votre certificat doit être Il s’agit de l’encodage Base64 de l’objet JSON suivant qui est encodé en UTF-8 :

{
« data » : »,
« dataType » :"pfx »,
« password » :" »
}
Pour installer des certificats sur une machine virtuelle, il est recommandé d’utiliser l’extension de machine virtuelle Azure Key Vault pour Linux ou l’extension de machine virtuelle Azure Key Vault pour Windows.

VaultSecretGroup

Décrit un ensemble de certificats qui se trouvent tous dans le même Key Vault.

Nom Type Description
sourceVault

SubResource

URL relative du Key Vault contenant tous les certificats dans VaultCertificates.
vaultCertificates

VaultCertificate[]

Liste des références de coffre de clés dans SourceVault qui contiennent des certificats.

VirtualMachineSizeTypes

Spécifie la taille de la machine virtuelle. Le type de données enum est actuellement déconseillé et sera supprimé d’ici le 23 décembre 2023. La méthode recommandée pour obtenir la liste des tailles disponibles consiste à utiliser les API suivantes : Répertorier toutes les tailles de machine virtuelle disponibles dans un groupe à haute disponibilité, Répertorier toutes les tailles de machine virtuelle disponibles dans une région, Répertorier toutes les tailles de machine virtuelle disponibles pour le redimensionnement. Pour plus d’informations sur les tailles des machines virtuelles, consultez Tailles des machines virtuelles. Les tailles de machine virtuelle disponibles dépendent de la région et du groupe à haute disponibilité.

Nom Type Description
Basic_A0

string

Basic_A1

string

Basic_A2

string

Basic_A3

string

Basic_A4

string

Standard_A0

string

Standard_A1

string

Standard_A10

string

Standard_A11

string

Standard_A1_v2

string

Standard_A2

string

Standard_A2_v2

string

Standard_A2m_v2

string

Standard_A3

string

Standard_A4

string

Standard_A4_v2

string

Standard_A4m_v2

string

Standard_A5

string

Standard_A6

string

Standard_A7

string

Standard_A8

string

Standard_A8_v2

string

Standard_A8m_v2

string

Standard_A9

string

Standard_B1ms

string

Standard_B1s

string

Standard_B2ms

string

Standard_B2s

string

Standard_B4ms

string

Standard_B8ms

string

Standard_D1

string

Standard_D11

string

Standard_D11_v2

string

Standard_D12

string

Standard_D12_v2

string

Standard_D13

string

Standard_D13_v2

string

Standard_D14

string

Standard_D14_v2

string

Standard_D15_v2

string

Standard_D16_v3

string

Standard_D16s_v3

string

Standard_D1_v2

string

Standard_D2

string

Standard_D2_v2

string

Standard_D2_v3

string

Standard_D2s_v3

string

Standard_D3

string

Standard_D32_v3

string

Standard_D32s_v3

string

Standard_D3_v2

string

Standard_D4

string

Standard_D4_v2

string

Standard_D4_v3

string

Standard_D4s_v3

string

Standard_D5_v2

string

Standard_D64_v3

string

Standard_D64s_v3

string

Standard_D8_v3

string

Standard_D8s_v3

string

Standard_DS1

string

Standard_DS11

string

Standard_DS11_v2

string

Standard_DS12

string

Standard_DS12_v2

string

Standard_DS13

string

Standard_DS13-2_v2

string

Standard_DS13-4_v2

string

Standard_DS13_v2

string

Standard_DS14

string

Standard_DS14-4_v2

string

Standard_DS14-8_v2

string

Standard_DS14_v2

string

Standard_DS15_v2

string

Standard_DS1_v2

string

Standard_DS2

string

Standard_DS2_v2

string

Standard_DS3

string

Standard_DS3_v2

string

Standard_DS4

string

Standard_DS4_v2

string

Standard_DS5_v2

string

Standard_E16_v3

string

Standard_E16s_v3

string

Standard_E2_v3

string

Standard_E2s_v3

string

Standard_E32-16_v3

string

Standard_E32-8s_v3

string

Standard_E32_v3

string

Standard_E32s_v3

string

Standard_E4_v3

string

Standard_E4s_v3

string

Standard_E64-16s_v3

string

Standard_E64-32s_v3

string

Standard_E64_v3

string

Standard_E64s_v3

string

Standard_E8_v3

string

Standard_E8s_v3

string

Standard_F1

string

Standard_F16

string

Standard_F16s

string

Standard_F16s_v2

string

Standard_F1s

string

Standard_F2

string

Standard_F2s

string

Standard_F2s_v2

string

Standard_F32s_v2

string

Standard_F4

string

Standard_F4s

string

Standard_F4s_v2

string

Standard_F64s_v2

string

Standard_F72s_v2

string

Standard_F8

string

Standard_F8s

string

Standard_F8s_v2

string

Standard_G1

string

Standard_G2

string

Standard_G3

string

Standard_G4

string

Standard_G5

string

Standard_GS1

string

Standard_GS2

string

Standard_GS3

string

Standard_GS4

string

Standard_GS4-4

string

Standard_GS4-8

string

Standard_GS5

string

Standard_GS5-16

string

Standard_GS5-8

string

Standard_H16

string

Standard_H16m

string

Standard_H16mr

string

Standard_H16r

string

Standard_H8

string

Standard_H8m

string

Standard_L16s

string

Standard_L32s

string

Standard_L4s

string

Standard_L8s

string

Standard_M128-32ms

string

Standard_M128-64ms

string

Standard_M128ms

string

Standard_M128s

string

Standard_M64-16ms

string

Standard_M64-32ms

string

Standard_M64ms

string

Standard_M64s

string

Standard_NC12

string

Standard_NC12s_v2

string

Standard_NC12s_v3

string

Standard_NC24

string

Standard_NC24r

string

Standard_NC24rs_v2

string

Standard_NC24rs_v3

string

Standard_NC24s_v2

string

Standard_NC24s_v3

string

Standard_NC6

string

Standard_NC6s_v2

string

Standard_NC6s_v3

string

Standard_ND12s

string

Standard_ND24rs

string

Standard_ND24s

string

Standard_ND6s

string

Standard_NV12

string

Standard_NV24

string

Standard_NV6

string

VMDiskSecurityProfile

Spécifie les paramètres de profil de sécurité pour le disque managé. Note: Il ne peut être défini que pour les machines virtuelles confidentielles.

Nom Type Description
diskEncryptionSet

DiskEncryptionSetParameters

Spécifie l’ID de ressource du jeu de chiffrement de disque managé du client pour le disque managé qui est utilisé pour le disque de système d’exploitation ConfidentialVM chiffré par clé gérée par le client et l’objet blob VMGuest.
securityEncryptionType

securityEncryptionTypes

Spécifie le type de chiffrement du disque managé. Il est défini sur DiskWithVMGuestState pour le chiffrement du disque managé, avec l’objet blob VMGuestState, VMGuestStateOnly pour le chiffrement uniquement de l’objet blob VMGuestState et NonPersistedTPM pour ne pas conserver l’état du microprogramme dans l’objet blob VMGuestState. Note: Il peut être défini uniquement pour les machines virtuelles confidentielles.

VMSizeProperties

Spécifie les paramètres de la propriété Taille de la machine virtuelle sur la machine virtuelle.

Nom Type Description
vCPUsAvailable

integer

Spécifie le nombre de processeurs virtuels disponibles pour la machine virtuelle. Lorsque cette propriété n’est pas spécifiée dans le corps de la demande, le comportement par défaut consiste à lui affecter la valeur des processeurs virtuels disponibles pour cette taille de machine virtuelle exposée dans la réponse de l’API de Lister toutes les tailles de machine virtuelle disponibles dans une région.
vCPUsPerCore

integer

Spécifie le ratio processeur virtuel/cœur physique. Lorsque cette propriété n’est pas spécifiée dans le corps de la demande, le comportement par défaut est défini sur la valeur de vCPUsPerCore pour la taille de machine virtuelle exposée dans la réponse de l’API de Lister toutes les tailles de machine virtuelle disponibles dans une région. L’attribution de la valeur 1 à cette propriété signifie également que l’hyper-threading est désactivé.

WindowsConfiguration

Spécifie les paramètres du système d’exploitation Windows sur la machine virtuelle.

Nom Type Description
additionalUnattendContent

AdditionalUnattendContent[]

Spécifie des informations supplémentaires au format XML encodées en base 64 pouvant être incluses dans le fichier Unattend.xml. Ce fichier est utilisé par le programme d'installation de Windows.
enableAutomaticUpdates

boolean

Indique si la Mises à jour automatique est activée pour la machine virtuelle Windows. La valeur par défaut est true. Pour les groupes de machines virtuelles identiques, cette propriété peut être mise à jour et les mises à jour prendront effet lors du reprovisionnement du système d’exploitation.
enableVMAgentPlatformUpdates

boolean

Indique si vmAgent Platform Mises à jour est activé pour la machine virtuelle Windows. La valeur par défaut est false.
patchSettings

PatchSettings

[Fonctionnalité en préversion] Spécifie les paramètres liés à la mise à jour corrective de l’invité de machine virtuelle sur Windows.
provisionVMAgent

boolean

Indique si l'agent de machine virtuelle doit être configuré sur la machine virtuelle. Lorsque cette propriété n’est pas spécifiée dans le corps de la demande, elle est définie sur true par défaut. Cela garantit que l’agent de machine virtuelle est installé sur la machine virtuelle afin que les extensions puissent être ajoutées ultérieurement à la machine virtuelle.
timeZone

string

Spécifie le fuseau horaire de la machine virtuelle. Par exemple, « Heure du Pacifique ». Les valeurs possibles peuvent être TimeZoneInfo.Id valeur des fuseaux horaires retournés par TimeZoneInfo.GetSystemTimeZones.
winRM

WinRMConfiguration

Spécifie les écouteurs Windows Remote Management. Cela active le Windows PowerShell distant.

WindowsPatchAssessmentMode

Spécifie le mode d’évaluation des correctifs de l’invité de machine virtuelle pour la machine virtuelle IaaS.

Les valeurs possibles sont les suivantes :

ImageDefault : vous contrôlez le minutage des évaluations des correctifs sur une machine virtuelle.

AutomaticByPlatform : la plateforme déclenche des évaluations périodiques des correctifs. La propriété provisionVMAgent doit être true.

Nom Type Description
AutomaticByPlatform

string

ImageDefault

string

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Spécifie le paramètre de redémarrage pour toutes les opérations d’installation du correctif AutomaticByPlatform.

Nom Type Description
Always

string

IfRequired

string

Never

string

Unknown

string

WindowsVMGuestPatchAutomaticByPlatformSettings

Spécifie des paramètres supplémentaires à appliquer lorsque le mode de correctif AutomaticByPlatform est sélectionné dans les paramètres de correctif Windows.

Nom Type Description
bypassPlatformSafetyChecksOnUserSchedule

boolean

Permet au client de planifier des mises à jour correctives sans mises à niveau accidentelles
rebootSetting

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Spécifie le paramètre de redémarrage pour toutes les opérations d’installation du correctif AutomaticByPlatform.

WindowsVMGuestPatchMode

Spécifie le mode de mise à jour corrective de l’invité de machine virtuelle sur une machine virtuelle IaaS ou des machines virtuelles associées à un groupe de machines virtuelles identiques avec OrchestrationMode comme flexible.

Les valeurs possibles sont les suivantes :

Manuel : vous contrôlez l’application des correctifs à une machine virtuelle. Pour ce faire, appliquez des correctifs manuellement à l’intérieur de la machine virtuelle. Dans ce mode, les mises à jour automatiques sont désactivées ; La propriété WindowsConfiguration.enableAutomaticUpdates doit avoir la valeur false

AutomaticByOS : la machine virtuelle est automatiquement mise à jour par le système d’exploitation. La propriété WindowsConfiguration.enableAutomaticUpdates doit être true.

AutomaticByPlatform : la machine virtuelle est automatiquement mise à jour par la plateforme. Les propriétés provisionVMAgent et WindowsConfiguration.enableAutomaticUpdates doivent être true

Nom Type Description
AutomaticByOS

string

AutomaticByPlatform

string

Manual

string

WinRMConfiguration

Décrit la configuration de la gestion à distance Windows de la machine virtuelle

Nom Type Description
listeners

WinRMListener[]

Liste des écouteurs de gestion à distance Windows

WinRMListener

Décrit le protocole et l’empreinte numérique de l’écouteur Windows Remote Management

Nom Type Description
certificateUrl

string

Il s’agit de l’URL d’un certificat qui a été chargé dans Key Vault en tant que secret. Pour ajouter un secret au Key Vault, consultez Ajouter une clé ou un secret au coffre de clés. Dans ce cas, votre certificat doit être l’encodage Base64 de l’objet JSON suivant, qui est encodé en UTF-8 :

{
« data » : »,
« dataType » :"pfx »,
« password » :" »
}
Pour installer des certificats sur une machine virtuelle, il est recommandé d’utiliser l’extension de machine virtuelle Azure Key Vault pour Linux ou l’extension de machine virtuelle Azure Key Vault pour Windows.
protocol

ProtocolTypes

Spécifie le protocole de l’écouteur WinRM. Les valeurs possibles sont : http,https.