Restore Points - Create
De bewerking voor het maken van het herstelpunt. Het bijwerken van eigenschappen van een bestaand herstelpunt is niet toegestaan
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{restorePointName}?api-version=2024-07-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
De naam van de resourcegroep. |
restore
|
path | True |
string |
De naam van de verzameling herstelpunten. |
restore
|
path | True |
string |
De naam van het herstelpunt. |
subscription
|
path | True |
string |
Abonnementsreferenties die het Microsoft Azure-abonnement uniek identificeren. De abonnements-id maakt deel uit van de URI voor elke serviceoproep. |
api-version
|
query | True |
string |
Client-API-versie. |
Aanvraagbody
Name | Type | Description |
---|---|---|
properties.consistencyMode |
ConsistencyMode van het RestorePoint. Kan worden opgegeven in de invoer tijdens het maken van een herstelpunt. Voorlopig wordt alleen CrashConsistent geaccepteerd als een geldige invoer. Raadpleeg https://aka.ms/RestorePoints voor meer informatie. |
|
properties.excludeDisks |
Lijst met schijfresource-id's die de klant wil uitsluiten van het herstelpunt. Als er geen schijven zijn opgegeven, worden alle schijven opgenomen. |
|
properties.sourceMetadata |
Hiermee haalt u de details op van de virtuele machine die is vastgelegd op het moment dat het herstelpunt is gemaakt. |
|
properties.sourceRestorePoint |
Resource-id van het bronherstelpunt waaruit een kopie moet worden gemaakt. |
|
properties.timeCreated |
string |
Hiermee haalt u de aanmaaktijd van het herstelpunt op. |
Antwoorden
Name | Type | Description |
---|---|---|
201 Created |
Geschapen |
|
Other Status Codes |
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
Copy a restore point to a different region |
Create a restore point |
Copy a restore point to a different region
Voorbeeldaanvraag
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName?api-version=2024-07-01
{
"properties": {
"sourceRestorePoint": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName/restorePoints/sourceRpName"
}
}
}
Voorbeeldrespons
{
"name": "rpName",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName",
"properties": {
"sourceRestorePoint": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName/restorePoints/sourceRpName"
},
"sourceMetadata": {
"vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7",
"hardwareProfile": {
"vmSize": "Standard_B1s"
},
"storageProfile": {
"osDisk": {
"osType": "Windows",
"name": "osDisk123",
"caching": "ReadWrite",
"managedDisk": {
"storageAccountType": "Standard_LRS",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/osDisk123"
},
"diskRestorePoint": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/osDisk123_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
}
},
"dataDisks": [
{
"lun": 1,
"name": "dataDisk123",
"caching": "None",
"managedDisk": {
"storageAccountType": "Standard_LRS",
"id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/dataDisk123"
},
"diskRestorePoint": {
"id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/dataDisk123_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",
"userData": "c2FtcGxlIHVzZXJEYXRh"
},
"provisioningState": "Creating",
"consistencyMode": "ApplicationConsistent",
"timeCreated": "2021-10-25T23:54:29.2796325+00:00"
}
}
Create a restore point
Voorbeeldaanvraag
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName?api-version=2024-07-01
{
"properties": {
"excludeDisks": [
{
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123"
}
]
}
}
Voorbeeldrespons
{
"name": "rpName",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName",
"properties": {
"excludeDisks": [
{
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123"
}
],
"sourceMetadata": {
"vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7",
"hardwareProfile": {
"vmSize": "Standard_B1s"
},
"storageProfile": {
"osDisk": {
"osType": "Windows",
"name": "osDisk123",
"caching": "ReadWrite",
"managedDisk": {
"storageAccountType": "Standard_LRS",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/osDisk123"
},
"diskRestorePoint": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/osDisk123_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
}
},
"dataDisks": [
{
"lun": 1,
"name": "dataDisk123",
"caching": "None",
"managedDisk": {
"storageAccountType": "Standard_LRS",
"id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/dataDisk123"
},
"diskRestorePoint": {
"id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/dataDisk123_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",
"userData": "c2FtcGxlIHVzZXJEYXRh"
},
"provisioningState": "Succeeded",
"consistencyMode": "ApplicationConsistent",
"timeCreated": "2021-01-27T20:35:05.8401519+00:00"
}
}
Definities
Name | Description |
---|---|
Additional |
Hiermee geeft u aanvullende XML-opgemaakte informatie op die kan worden opgenomen in het Unattend.xml-bestand, dat wordt gebruikt door Windows Setup. De inhoud wordt gedefinieerd door de naam van de instelling, de onderdeelnaam en de pass waarin de inhoud wordt toegepast. |
Api |
De API-entiteitsreferentie. |
Api |
Api-fout. |
Api |
Api-foutbasis. |
Boot |
Diagnostische gegevens over opstarten is een functie voor foutopsporing waarmee u console-uitvoer en schermopname kunt bekijken om de VM-status te diagnosticeren. U kunt eenvoudig de uitvoer van uw consolelogboek bekijken. Met Azure kunt u ook een schermopname van de virtuele machine bekijken vanuit de hypervisor. |
Caching |
Hiermee haalt u het cachetype op. |
Cloud |
Een foutreactie van de Compute-service. |
Component |
De naam van het onderdeel. Momenteel is de enige toegestane waarde Microsoft-Windows-Shell-Setup. |
Consistency |
ConsistencyMode van het RestorePoint. Kan worden opgegeven in de invoer tijdens het maken van een herstelpunt. Voorlopig wordt alleen CrashConsistent geaccepteerd als een geldige invoer. Raadpleeg https://aka.ms/RestorePoints voor meer informatie. |
Diagnostics |
Hiermee geeft u de status van diagnostische instellingen voor opstarten. Minimale API-versie: 2015-06-15. |
Disk |
Hiermee haalt u het type schijfcontroller op van de virtuele machine die is vastgelegd op het moment dat het herstelpunt is gemaakt. |
Disk |
Beschrijft de parameter van de resource-id van de door de klant beheerde schijfversleutelingsset die kan worden opgegeven voor schijf. Opmerking: de resource-id van de schijfversleutelingsset kan alleen worden opgegeven voor beheerde schijven. Raadpleeg https://aka.ms/mdssewithcmkoverview voor meer informatie. |
Disk |
Beschrijft een versleutelingsinstellingen voor een schijf |
Disk |
Details van schijfherstelpunt. |
Disk |
De exemplaarweergave van een schijfherstelpunt. |
Disk |
De exemplaarweergave van een schijfherstelpunt. |
Encryption |
Hiermee geeft u de beheerde identiteit op die door ADE wordt gebruikt om toegangstoken op te halen voor sleutelkluisbewerkingen. |
Hardware |
Hiermee geeft u de hardware-instellingen voor de virtuele machine. |
Hyper |
HyperVGeneratie van de bron-VM waarvoor het herstelpunt wordt vastgelegd. |
Inner |
Interne foutdetails. |
Instance |
Status van exemplaarweergave. |
Key |
Beschrijft een verwijzing naar Key Vault-sleutel |
Key |
Beschrijft een verwijzing naar Key Vault-geheim |
Linux |
Hiermee geeft u de linux-besturingssysteeminstellingen op de virtuele machine. Zie Linux op Azure-Endorsed Distributiesvoor een lijst met ondersteunde Linux-distributies. |
Linux |
Hiermee geeft u de modus van vm-gastpatchevaluatie voor de virtuele IaaS-machine. |
Linux |
Hiermee geeft u instellingen met betrekking tot VM-gastpatching op Linux. |
Linux |
Hiermee geeft u de instelling voor opnieuw opstarten voor alle installatiebewerkingen van de AutomaticByPlatform-patch. |
Linux |
Hiermee geeft u aanvullende instellingen op die moeten worden toegepast wanneer de patchmodus AutomaticByPlatform is geselecteerd in de Instellingen voor Linux-patches. |
Linux |
Hiermee geeft u de modus van VM-gastpatching naar virtuele IaaS-machine of virtuele machines die zijn gekoppeld aan virtuele-machineschaalset met OrchestrationMode als Flexibel. |
Managed |
De parameters van een beheerde schijf. |
Mode |
Hiermee geeft u de modus op waarop ProxyAgent wordt uitgevoerd als de functie is ingeschakeld. ProxyAgent begint met controleren of bewaken, maar dwingt geen toegangsbeheer af over aanvragen voor hosteindpunten in de controlemodus, terwijl in de modus Afdwingen het toegangsbeheer wordt afgedwongen. De standaardwaarde is de modus Afdwingen. |
Operating |
Hiermee haalt u het type besturingssysteem op. |
OSProfile |
Hiermee geeft u de besturingssysteeminstellingen voor de virtuele machine. Sommige instellingen kunnen niet worden gewijzigd zodra de VIRTUELE machine is ingericht. |
Pass |
De wachtwoordnaam. Momenteel is de enige toegestane waarde OobeSystem. |
Patch |
Hiermee geeft u instellingen met betrekking tot VM-gastpatching in Windows. |
Protocol |
Hiermee geeft u het protocol van WinRM-listener. Mogelijke waarden zijn: http,https. |
Proxy |
Hiermee geeft u ProxyAgent-instellingen op tijdens het maken van de virtuele machine. Minimale API-versie: 2023-09-01. |
Restore |
Details van herstelpunt. |
Restore |
Versleuteling-at-rest-instellingen voor schijfherstelpunt. Het is een optionele eigenschap die kan worden opgegeven in de invoer tijdens het maken van een herstelpunt. |
Restore |
Het type sleutel dat wordt gebruikt voor het versleutelen van de gegevens van het schijfherstelpunt. |
Restore |
De exemplaarweergave van een herstelpunt. |
Restore |
Beschrijft de eigenschappen van de virtuele machine waarvoor het herstelpunt is gemaakt. De opgegeven eigenschappen zijn een subset en de momentopname van de algemene eigenschappen van de virtuele machine die zijn vastgelegd op het moment dat het herstelpunt is gemaakt. |
Restore |
Beschrijft een gegevensschijf. |
Restore |
Beschrijft een besturingssysteemschijf. |
Restore |
Beschrijft het opslagprofiel. |
security |
Hiermee geeft u het EncryptionType van de beheerde schijf. Deze is ingesteld op DiskWithVMGuestState voor versleuteling van de beheerde schijf, samen met VMGuestState-blob, VMGuestStateOnly voor versleuteling van alleen de VMGuestState-blob en NonPersistedTPM voor het niet behouden van de firmwarestatus in de VMGuestState-blob.. Opmerking: Deze kan alleen worden ingesteld voor vertrouwelijke VM's. |
Security |
Hiermee geeft u de beveiligingsprofielinstellingen voor de virtuele machine of virtuele-machineschaalset op. |
Security |
Hiermee geeft u het SecurityType van de virtuele machine. Deze moet worden ingesteld op een opgegeven waarde om UefiSettings in te schakelen. Het standaardgedrag is: UefiSettings wordt niet ingeschakeld, tenzij deze eigenschap is ingesteld. |
Setting |
Hiermee geeft u de naam op van de instelling waarop de inhoud van toepassing is. Mogelijke waarden zijn: FirstLogonCommands en AutoLogon. |
Ssh |
SSH-configuratie voor op Linux gebaseerde VM's die worden uitgevoerd in Azure |
Ssh |
Bevat informatie over de openbare SSH-certificaatsleutel en het pad op de Virtuele Linux-machine waarop de openbare sleutel wordt geplaatst. |
Status |
De niveaucode. |
Storage |
Hiermee geeft u het type opslagaccount voor de beheerde schijf. OPMERKING: UltraSSD_LRS kan alleen worden gebruikt met gegevensschijven, deze kan niet worden gebruikt met besturingssysteemschijf. |
Sub |
|
Uefi |
Hiermee geeft u de beveiligingsinstellingen op, zoals beveiligd opstarten en vTPM die worden gebruikt tijdens het maken van de virtuele machine. Minimale API-versie: 2020-12-01. |
Vault |
Beschrijft één certificaatverwijzing in een Sleutelkluis en waar het certificaat zich op de virtuele machine moet bevinden. |
Vault |
Beschrijft een set certificaten die zich allemaal in dezelfde Key Vault bevinden. |
Virtual |
Hiermee geeft u de grootte van de virtuele machine. Het enum-gegevenstype is momenteel afgeschaft en wordt op 23 december 2023 verwijderd. De aanbevolen manier om de lijst met beschikbare grootten op te halen, is met behulp van deze API's: Alle beschikbare grootten van virtuele machines in een beschikbaarheidsset weergeven, Alle beschikbare grootten van virtuele machines in een regio weergeven, Alle beschikbare grootten van virtuele machines weergeven voor het wijzigen van de grootte van. Zie Grootten voor virtuele machinesvoor meer informatie over de grootte van virtuele machines. De beschikbare VM-grootten zijn afhankelijk van de regio en beschikbaarheidsset. |
VMDisk |
Hiermee geeft u de beveiligingsprofielinstellingen voor de beheerde schijf. Opmerking: Deze kan alleen worden ingesteld voor vertrouwelijke VM's. |
VMSize |
Hiermee geeft u de instellingen voor de eigenschap VM-grootte op de virtuele machine. |
Windows |
Hiermee geeft u windows-besturingssysteeminstellingen op de virtuele machine. |
Windows |
Hiermee geeft u de modus van vm-gastpatchevaluatie voor de virtuele IaaS-machine. |
Windows |
Hiermee geeft u de instelling voor opnieuw opstarten voor alle installatiebewerkingen van de AutomaticByPlatform-patch. |
Windows |
Hiermee geeft u aanvullende instellingen op die moeten worden toegepast wanneer de patchmodus AutomaticByPlatform is geselecteerd in de Windows-patchinstellingen. |
Windows |
Hiermee geeft u de modus van VM-gastpatching naar virtuele IaaS-machine of virtuele machines die zijn gekoppeld aan virtuele-machineschaalset met OrchestrationMode als Flexibel. |
Win |
Hierin wordt de configuratie van Windows Remote Management van de VM beschreven |
Win |
Beschrijft protocol en vingerafdruk van Windows Remote Management-listener |
AdditionalUnattendContent
Hiermee geeft u aanvullende XML-opgemaakte informatie op die kan worden opgenomen in het Unattend.xml-bestand, dat wordt gebruikt door Windows Setup. De inhoud wordt gedefinieerd door de naam van de instelling, de onderdeelnaam en de pass waarin de inhoud wordt toegepast.
Name | Type | Description |
---|---|---|
componentName |
De naam van het onderdeel. Momenteel is de enige toegestane waarde Microsoft-Windows-Shell-Setup. |
|
content |
string |
Hiermee geeft u de xml-opgemaakte inhoud op die wordt toegevoegd aan het unattend.xml-bestand voor het opgegeven pad en het opgegeven onderdeel. De XML moet kleiner zijn dan 4 kB en moet het hoofdelement bevatten voor de instelling of functie die wordt ingevoegd. |
passName |
De wachtwoordnaam. Momenteel is de enige toegestane waarde OobeSystem. |
|
settingName |
Hiermee geeft u de naam op van de instelling waarop de inhoud van toepassing is. Mogelijke waarden zijn: FirstLogonCommands en AutoLogon. |
ApiEntityReference
De API-entiteitsreferentie.
Name | Type | Description |
---|---|---|
id |
string |
De ARM-resource-id in de vorm van /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... |
ApiError
Api-fout.
Name | Type | Description |
---|---|---|
code |
string |
De foutcode. |
details |
Details van de API-fout |
|
innererror |
De interne API-fout |
|
message |
string |
Het foutbericht. |
target |
string |
Het doel van de specifieke fout. |
ApiErrorBase
Api-foutbasis.
Name | Type | Description |
---|---|---|
code |
string |
De foutcode. |
message |
string |
Het foutbericht. |
target |
string |
Het doel van de specifieke fout. |
BootDiagnostics
Diagnostische gegevens over opstarten is een functie voor foutopsporing waarmee u console-uitvoer en schermopname kunt bekijken om de VM-status te diagnosticeren. U kunt eenvoudig de uitvoer van uw consolelogboek bekijken. Met Azure kunt u ook een schermopname van de virtuele machine bekijken vanuit de hypervisor.
Name | Type | Description |
---|---|---|
enabled |
boolean |
Of diagnostische gegevens over opstarten moeten worden ingeschakeld op de virtuele machine. |
storageUri |
string |
Uri van het opslagaccount dat moet worden gebruikt voor het plaatsen van de console-uitvoer en schermopname. Als storageUri niet is opgegeven tijdens het inschakelen van diagnostische gegevens over opstarten, wordt beheerde opslag gebruikt. |
CachingTypes
Hiermee haalt u het cachetype op.
Name | Type | Description |
---|---|---|
None |
string |
|
ReadOnly |
string |
|
ReadWrite |
string |
CloudError
Een foutreactie van de Compute-service.
Name | Type | Description |
---|---|---|
error |
Api-fout. |
ComponentNames
De naam van het onderdeel. Momenteel is de enige toegestane waarde Microsoft-Windows-Shell-Setup.
Name | Type | Description |
---|---|---|
Microsoft-Windows-Shell-Setup |
string |
ConsistencyModeTypes
ConsistencyMode van het RestorePoint. Kan worden opgegeven in de invoer tijdens het maken van een herstelpunt. Voorlopig wordt alleen CrashConsistent geaccepteerd als een geldige invoer. Raadpleeg https://aka.ms/RestorePoints voor meer informatie.
Name | Type | Description |
---|---|---|
ApplicationConsistent |
string |
|
CrashConsistent |
string |
|
FileSystemConsistent |
string |
DiagnosticsProfile
Hiermee geeft u de status van diagnostische instellingen voor opstarten. Minimale API-versie: 2015-06-15.
Name | Type | Description |
---|---|---|
bootDiagnostics |
Diagnostische gegevens over opstarten is een functie voor foutopsporing waarmee u console-uitvoer en schermopname kunt bekijken om de VM-status te diagnosticeren. OPMERKING: als storageUri wordt opgegeven, moet u ervoor zorgen dat het opslagaccount zich in dezelfde regio en hetzelfde abonnement bevindt als de virtuele machine. U kunt eenvoudig de uitvoer van uw consolelogboek bekijken. Met Azure kunt u ook een schermopname van de virtuele machine bekijken vanuit de hypervisor. |
DiskControllerTypes
Hiermee haalt u het type schijfcontroller op van de virtuele machine die is vastgelegd op het moment dat het herstelpunt is gemaakt.
Name | Type | Description |
---|---|---|
NVMe |
string |
|
SCSI |
string |
DiskEncryptionSetParameters
Beschrijft de parameter van de resource-id van de door de klant beheerde schijfversleutelingsset die kan worden opgegeven voor schijf. Opmerking: de resource-id van de schijfversleutelingsset kan alleen worden opgegeven voor beheerde schijven. Raadpleeg https://aka.ms/mdssewithcmkoverview voor meer informatie.
Name | Type | Description |
---|---|---|
id |
string |
Resource-id |
DiskEncryptionSettings
Beschrijft een versleutelingsinstellingen voor een schijf
Name | Type | Description |
---|---|---|
diskEncryptionKey |
Hiermee geeft u de locatie van de schijfversleutelingssleutel, een Sleutelkluisgeheim. |
|
enabled |
boolean |
Hiermee geeft u op of schijfversleuteling moet worden ingeschakeld op de virtuele machine. |
keyEncryptionKey |
Hiermee geeft u de locatie van de sleutelversleutelingssleutel in Key Vault. |
DiskRestorePointAttributes
Details van schijfherstelpunt.
Name | Type | Description |
---|---|---|
encryption |
Versleuteling-at-rest-instellingen voor schijfherstelpunt. Het is een optionele eigenschap die kan worden opgegeven in de invoer tijdens het maken van een herstelpunt. |
|
id |
string |
Resource-id |
sourceDiskRestorePoint |
Resource-id van het herstelpunt van de bronschijf. |
DiskRestorePointInstanceView
De exemplaarweergave van een schijfherstelpunt.
Name | Type | Description |
---|---|---|
id |
string |
Schijfherstelpunt-id. |
replicationStatus |
Informatie over de replicatiestatus van het schijfherstelpunt. |
DiskRestorePointReplicationStatus
De exemplaarweergave van een schijfherstelpunt.
Name | Type | Description |
---|---|---|
completionPercent |
integer |
Voltooiingspercentage van replicatie. |
status |
De informatie over de resourcestatus. |
EncryptionIdentity
Hiermee geeft u de beheerde identiteit op die door ADE wordt gebruikt om toegangstoken op te halen voor sleutelkluisbewerkingen.
Name | Type | Description |
---|---|---|
userAssignedIdentityResourceId |
string |
Hiermee geeft u de ARM-resource-id op van een van de gebruikersidentiteiten die zijn gekoppeld aan de virtuele machine. |
HardwareProfile
Hiermee geeft u de hardware-instellingen voor de virtuele machine.
Name | Type | Description |
---|---|---|
vmSize |
Hiermee geeft u de grootte van de virtuele machine. Het enum-gegevenstype is momenteel afgeschaft en wordt op 23 december 2023 verwijderd. De aanbevolen manier om de lijst met beschikbare grootten op te halen, is met behulp van deze API's: Alle beschikbare grootten van virtuele machines in een beschikbaarheidsset weergeven, Alle beschikbare grootten van virtuele machines in een regio weergeven, Alle beschikbare grootten van virtuele machines weergeven voor het wijzigen van de grootte van. Zie Grootten voor virtuele machinesvoor meer informatie over de grootte van virtuele machines. De beschikbare VM-grootten zijn afhankelijk van de regio en beschikbaarheidsset. |
|
vmSizeProperties |
Hiermee geeft u de eigenschappen voor het aanpassen van de grootte van de virtuele machine. Minimale API-versie: 2021-07-01. Deze functie bevindt zich nog steeds in de preview-modus en wordt niet ondersteund voor VirtualMachineScaleSet. Volg de instructies in VM-aanpassing voor meer informatie. |
HyperVGenerationTypes
HyperVGeneratie van de bron-VM waarvoor het herstelpunt wordt vastgelegd.
Name | Type | Description |
---|---|---|
V1 |
string |
|
V2 |
string |
InnerError
Interne foutdetails.
Name | Type | Description |
---|---|---|
errordetail |
string |
Het interne foutbericht of de uitzonderingsdump. |
exceptiontype |
string |
Het uitzonderingstype. |
InstanceViewStatus
Status van exemplaarweergave.
Name | Type | Description |
---|---|---|
code |
string |
De statuscode. |
displayStatus |
string |
Het korte lokaliseerbare label voor de status. |
level |
De niveaucode. |
|
message |
string |
Het gedetailleerde statusbericht, inclusief voor waarschuwingen en foutberichten. |
time |
string |
Het tijdstip van de status. |
KeyVaultKeyReference
Beschrijft een verwijzing naar Key Vault-sleutel
Name | Type | Description |
---|---|---|
keyUrl |
string |
De URL die verwijst naar een sleutelversleutelingssleutel in Key Vault. |
sourceVault |
De relatieve URL van de sleutelkluis die de sleutel bevat. |
KeyVaultSecretReference
Beschrijft een verwijzing naar Key Vault-geheim
Name | Type | Description |
---|---|---|
secretUrl |
string |
De URL die verwijst naar een geheim in een Sleutelkluis. |
sourceVault |
De relatieve URL van de sleutelkluis die het geheim bevat. |
LinuxConfiguration
Hiermee geeft u de linux-besturingssysteeminstellingen op de virtuele machine. Zie Linux op Azure-Endorsed Distributiesvoor een lijst met ondersteunde Linux-distributies.
Name | Type | Description |
---|---|---|
disablePasswordAuthentication |
boolean |
Hiermee geeft u op of wachtwoordverificatie moet worden uitgeschakeld. |
enableVMAgentPlatformUpdates |
boolean |
Geeft aan of VMAgent-platformupdates zijn ingeschakeld voor de virtuele Linux-machine. De standaardwaarde is onwaar. |
patchSettings |
[Preview-functie] Hiermee geeft u instellingen met betrekking tot VM-gastpatching op Linux. |
|
provisionVMAgent |
boolean |
Hiermee wordt aangegeven of de virtuele-machineagent moet worden ingericht op de virtuele machine. Wanneer deze eigenschap niet is opgegeven in de hoofdtekst van de aanvraag, is het standaardgedrag ingesteld op waar. Dit zorgt ervoor dat de VM-agent op de VIRTUELE machine is geïnstalleerd, zodat extensies later aan de VIRTUELE machine kunnen worden toegevoegd. |
ssh |
Hiermee geeft u de ssh-sleutelconfiguratie voor een Linux-besturingssysteem. |
LinuxPatchAssessmentMode
Hiermee geeft u de modus van vm-gastpatchevaluatie voor de virtuele IaaS-machine.
Mogelijke waarden zijn:
ImageDefault-: u bepaalt de timing van patchevaluaties op een virtuele machine.
AutomaticByPlatform - Het platform activeert periodieke patchevaluaties. De eigenschap provisionVMAgent moet waar zijn.
Name | Type | Description |
---|---|---|
AutomaticByPlatform |
string |
|
ImageDefault |
string |
LinuxPatchSettings
Hiermee geeft u instellingen met betrekking tot VM-gastpatching op Linux.
Name | Type | Description |
---|---|---|
assessmentMode |
Hiermee geeft u de modus van vm-gastpatchevaluatie voor de virtuele IaaS-machine. |
|
automaticByPlatformSettings |
Hiermee geeft u aanvullende instellingen voor patchmodus AutomaticByPlatform in VM-gastpatching op Linux. |
|
patchMode |
Hiermee geeft u de modus van VM-gastpatching naar virtuele IaaS-machine of virtuele machines die zijn gekoppeld aan virtuele-machineschaalset met OrchestrationMode als Flexibel. |
LinuxVMGuestPatchAutomaticByPlatformRebootSetting
Hiermee geeft u de instelling voor opnieuw opstarten voor alle installatiebewerkingen van de AutomaticByPlatform-patch.
Name | Type | Description |
---|---|---|
Always |
string |
|
IfRequired |
string |
|
Never |
string |
|
Unknown |
string |
LinuxVMGuestPatchAutomaticByPlatformSettings
Hiermee geeft u aanvullende instellingen op die moeten worden toegepast wanneer de patchmodus AutomaticByPlatform is geselecteerd in de Instellingen voor Linux-patches.
Name | Type | Description |
---|---|---|
bypassPlatformSafetyChecksOnUserSchedule |
boolean |
Stelt de klant in staat patches te plannen zonder onbedoelde upgrades |
rebootSetting |
Hiermee geeft u de instelling voor opnieuw opstarten voor alle installatiebewerkingen van de AutomaticByPlatform-patch. |
LinuxVMGuestPatchMode
Hiermee geeft u de modus van VM-gastpatching naar virtuele IaaS-machine of virtuele machines die zijn gekoppeld aan virtuele-machineschaalset met OrchestrationMode als Flexibel.
Mogelijke waarden zijn:
ImageDefault-: de standaardpatchconfiguratie van de virtuele machine wordt gebruikt.
AutomaticByPlatform : de virtuele machine wordt automatisch bijgewerkt door het platform. De eigenschap provisionVMAgent moet waar zijn
Name | Type | Description |
---|---|---|
AutomaticByPlatform |
string |
|
ImageDefault |
string |
ManagedDiskParameters
De parameters van een beheerde schijf.
Name | Type | Description |
---|---|---|
diskEncryptionSet |
Hiermee geeft u de resource-id van de door de klant beheerde schijfversleutelingsset voor de beheerde schijf op. |
|
id |
string |
Resource-id |
securityProfile |
Hiermee geeft u het beveiligingsprofiel voor de beheerde schijf. |
|
storageAccountType |
Hiermee geeft u het type opslagaccount voor de beheerde schijf. OPMERKING: UltraSSD_LRS kan alleen worden gebruikt met gegevensschijven, deze kan niet worden gebruikt met besturingssysteemschijf. |
Mode
Hiermee geeft u de modus op waarop ProxyAgent wordt uitgevoerd als de functie is ingeschakeld. ProxyAgent begint met controleren of bewaken, maar dwingt geen toegangsbeheer af over aanvragen voor hosteindpunten in de controlemodus, terwijl in de modus Afdwingen het toegangsbeheer wordt afgedwongen. De standaardwaarde is de modus Afdwingen.
Name | Type | Description |
---|---|---|
Audit |
string |
|
Enforce |
string |
OperatingSystemType
Hiermee haalt u het type besturingssysteem op.
Name | Type | Description |
---|---|---|
Linux |
string |
|
Windows |
string |
OSProfile
Hiermee geeft u de besturingssysteeminstellingen voor de virtuele machine. Sommige instellingen kunnen niet worden gewijzigd zodra de VIRTUELE machine is ingericht.
Name | Type | Description |
---|---|---|
adminPassword |
string |
Hiermee geeft u het wachtwoord van het beheerdersaccount. |
adminUsername |
string |
Hiermee geeft u de naam van het beheerdersaccount. |
allowExtensionOperations |
boolean |
Hiermee geeft u op of uitbreidingsbewerkingen moeten worden toegestaan op de virtuele machine. Dit kan alleen worden ingesteld op False wanneer er geen extensies aanwezig zijn op de virtuele machine. |
computerName |
string |
Hiermee geeft u de naam van het host-besturingssysteem van de virtuele machine. Deze naam kan niet worden bijgewerkt nadat de virtuele machine is gemaakt. Maximale lengte (Windows): 15 tekens. Maximale lengte (Linux): 64 tekens. Zie implementatierichtlijnen voor Azure-infrastructuurservicesvoor naamconventies en -beperkingen. |
customData |
string |
Hiermee geeft u een met base 64 gecodeerde tekenreeks van aangepaste gegevens op. De met base 64 gecodeerde tekenreeks wordt gedecodeerd naar een binaire matrix die wordt opgeslagen als een bestand op de virtuele machine. De maximale lengte van de binaire matrix is 65535 bytes. Opmerking: geef geen geheimen of wachtwoorden door in de eigenschap customData. Deze eigenschap kan niet worden bijgewerkt nadat de virtuele machine is gemaakt. De eigenschap 'customData' wordt doorgegeven aan de virtuele machine die als bestand moet worden opgeslagen. Zie Aangepaste gegevens op Virtuele Azure-machinesvoor meer informatie. Zie Cloud-init gebruiken om een Virtuele Linux-machine aan te passen tijdens het maken vanvoor het gebruik van cloud-init. |
linuxConfiguration |
Hiermee geeft u de linux-besturingssysteeminstellingen op de virtuele machine. Zie Linux op Azure-Endorsed Distributiesvoor een lijst met ondersteunde Linux-distributies. |
|
requireGuestProvisionSignal |
boolean |
Optionele eigenschap die moet worden ingesteld op Waar of weggelaten. |
secrets |
Hiermee geeft u een set certificaten op die op de virtuele machine moeten worden geïnstalleerd. Als u certificaten op een virtuele machine wilt installeren, wordt u aangeraden de extensie van de virtuele Azure Key Vault-machine voor Linux- of de virtuele Machine-extensie van Azure Key Vault voor Windowste gebruiken. |
|
windowsConfiguration |
Hiermee geeft u windows-besturingssysteeminstellingen op de virtuele machine. |
PassNames
De wachtwoordnaam. Momenteel is de enige toegestane waarde OobeSystem.
Name | Type | Description |
---|---|---|
OobeSystem |
string |
PatchSettings
Hiermee geeft u instellingen met betrekking tot VM-gastpatching in Windows.
Name | Type | Description |
---|---|---|
assessmentMode |
Hiermee geeft u de modus van vm-gastpatchevaluatie voor de virtuele IaaS-machine. |
|
automaticByPlatformSettings |
Hiermee geeft u aanvullende instellingen voor patchmodus AutomaticByPlatform in VM-gastpatching in Windows. |
|
enableHotpatching |
boolean |
Hiermee kunnen klanten hun Virtuele Azure-machines patchen zonder dat ze opnieuw hoeven op te starten. Voor enableHotpatching moet de 'provisionVMAgent' worden ingesteld op true en moet patchMode worden ingesteld op 'AutomaticByPlatform'. |
patchMode |
Hiermee geeft u de modus van VM-gastpatching naar virtuele IaaS-machine of virtuele machines die zijn gekoppeld aan virtuele-machineschaalset met OrchestrationMode als Flexibel. |
ProtocolTypes
Hiermee geeft u het protocol van WinRM-listener. Mogelijke waarden zijn: http,https.
Name | Type | Description |
---|---|---|
Http |
string |
|
Https |
string |
ProxyAgentSettings
Hiermee geeft u ProxyAgent-instellingen op tijdens het maken van de virtuele machine. Minimale API-versie: 2023-09-01.
Name | Type | Description |
---|---|---|
enabled |
boolean |
Hiermee geeft u op of de functie ProxyAgent moet worden ingeschakeld op de virtuele machine of virtuele-machineschaalset. |
keyIncarnationId |
integer |
Verhoog de waarde van deze eigenschap zodat de gebruiker de sleutel die wordt gebruikt voor het beveiligen van het communicatiekanaal tussen gast en host opnieuw kan instellen. |
mode |
Hiermee geeft u de modus op waarop ProxyAgent wordt uitgevoerd als de functie is ingeschakeld. ProxyAgent begint met controleren of bewaken, maar dwingt geen toegangsbeheer af over aanvragen voor hosteindpunten in de controlemodus, terwijl in de modus Afdwingen het toegangsbeheer wordt afgedwongen. De standaardwaarde is de modus Afdwingen. |
RestorePoint
Details van herstelpunt.
Name | Type | Description |
---|---|---|
id |
string |
Resource-id |
name |
string |
Resourcenaam |
properties.consistencyMode |
ConsistencyMode van het RestorePoint. Kan worden opgegeven in de invoer tijdens het maken van een herstelpunt. Voorlopig wordt alleen CrashConsistent geaccepteerd als een geldige invoer. Raadpleeg https://aka.ms/RestorePoints voor meer informatie. |
|
properties.excludeDisks |
Lijst met schijfresource-id's die de klant wil uitsluiten van het herstelpunt. Als er geen schijven zijn opgegeven, worden alle schijven opgenomen. |
|
properties.instanceView |
De weergave herstelpuntexemplaren. |
|
properties.provisioningState |
string |
Hiermee haalt u de inrichtingsstatus van het herstelpunt op. |
properties.sourceMetadata |
Hiermee haalt u de details op van de virtuele machine die is vastgelegd op het moment dat het herstelpunt is gemaakt. |
|
properties.sourceRestorePoint |
Resource-id van het bronherstelpunt waaruit een kopie moet worden gemaakt. |
|
properties.timeCreated |
string |
Hiermee haalt u de aanmaaktijd van het herstelpunt op. |
type |
string |
Resourcetype |
RestorePointEncryption
Versleuteling-at-rest-instellingen voor schijfherstelpunt. Het is een optionele eigenschap die kan worden opgegeven in de invoer tijdens het maken van een herstelpunt.
Name | Type | Description |
---|---|---|
diskEncryptionSet |
Beschrijft de parameter van de resource-id van de door de klant beheerde schijfversleutelingsset die kan worden opgegeven voor schijf. Opmerking: de resource-id van de schijfversleutelingsset kan alleen worden opgegeven voor beheerde schijven. Raadpleeg https://aka.ms/mdssewithcmkoverview voor meer informatie. |
|
type |
Het type sleutel dat wordt gebruikt voor het versleutelen van de gegevens van het schijfherstelpunt. |
RestorePointEncryptionType
Het type sleutel dat wordt gebruikt voor het versleutelen van de gegevens van het schijfherstelpunt.
Name | Type | Description |
---|---|---|
EncryptionAtRestWithCustomerKey |
string |
Schijfherstelpunt wordt in rust versleuteld met door de klant beheerde sleutel die kan worden gewijzigd en ingetrokken door een klant. |
EncryptionAtRestWithPlatformAndCustomerKeys |
string |
Schijfherstelpunt wordt in rust versleuteld met 2 lagen versleuteling. Een van de sleutels wordt door de klant beheerd en de andere sleutel wordt beheerd door platform. |
EncryptionAtRestWithPlatformKey |
string |
Schijfherstelpunt wordt in rust versleuteld met door platform beheerde sleutel. |
RestorePointInstanceView
De exemplaarweergave van een herstelpunt.
Name | Type | Description |
---|---|---|
diskRestorePoints |
Informatie over de schijfherstelpunten. |
|
statuses |
De informatie over de resourcestatus. |
RestorePointSourceMetadata
Beschrijft de eigenschappen van de virtuele machine waarvoor het herstelpunt is gemaakt. De opgegeven eigenschappen zijn een subset en de momentopname van de algemene eigenschappen van de virtuele machine die zijn vastgelegd op het moment dat het herstelpunt is gemaakt.
Name | Type | Description |
---|---|---|
diagnosticsProfile |
Hiermee haalt u het diagnostische profiel op. |
|
hardwareProfile |
Hiermee haalt u het hardwareprofiel op. |
|
hyperVGeneration |
HyperVGeneratie van de bron-VM waarvoor het herstelpunt wordt vastgelegd. |
|
licenseType |
string |
Hiermee haalt u het licentietype op. Dit is voor uw eigen licentiescenario. |
location |
string |
Locatie van de VIRTUELE machine waaruit het herstelpunt is gemaakt. |
osProfile |
Hiermee haalt u het besturingssysteemprofiel op. |
|
securityProfile |
Hiermee haalt u het beveiligingsprofiel op. |
|
storageProfile |
Hiermee haalt u het opslagprofiel op. |
|
userData |
string |
UserData die is gekoppeld aan de bron-VM waarvoor het herstelpunt wordt vastgelegd, een base-64-gecodeerde waarde. |
vmId |
string |
Hiermee haalt u de unieke id van de virtuele machine op. |
RestorePointSourceVMDataDisk
Beschrijft een gegevensschijf.
Name | Type | Description |
---|---|---|
caching |
Hiermee haalt u het cachetype op. |
|
diskRestorePoint |
Bevat eigenschappen van schijfherstelpunt. |
|
diskSizeGB |
integer |
Hiermee wordt de initiële schijfgrootte in GB opgehaald voor lege gegevensschijven en de nieuwe gewenste grootte voor bestaande besturingssysteem- en gegevensschijven. |
lun |
integer |
Hiermee haalt u het nummer van de logische eenheid op. |
managedDisk |
Bevat de details van de beheerde schijf. |
|
name |
string |
Hiermee haalt u de naam van de schijf op. |
writeAcceleratorEnabled |
boolean |
Geeft waar weer als de schijf schrijfversneller is ingeschakeld. |
RestorePointSourceVMOSDisk
Beschrijft een besturingssysteemschijf.
Name | Type | Description |
---|---|---|
caching |
Hiermee haalt u het cachetype op. |
|
diskRestorePoint |
Bevat eigenschappen van schijfherstelpunt. |
|
diskSizeGB |
integer |
Hiermee haalt u de schijfgrootte op in GB. |
encryptionSettings |
Hiermee haalt u de instellingen voor schijfversleuteling op. |
|
managedDisk |
Hiermee haalt u de details van de beheerde schijf op |
|
name |
string |
Hiermee haalt u de naam van de schijf op. |
osType |
Hiermee haalt u het type besturingssysteem op. |
|
writeAcceleratorEnabled |
boolean |
Geeft waar weer als de schijf schrijfversneller is ingeschakeld. |
RestorePointSourceVMStorageProfile
Beschrijft het opslagprofiel.
Name | Type | Description |
---|---|---|
dataDisks |
Haalt de gegevensschijven op van de VIRTUELE machine die is vastgelegd op het moment dat het herstelpunt is gemaakt. |
|
diskControllerType |
Hiermee haalt u het type schijfcontroller op van de virtuele machine die is vastgelegd op het moment dat het herstelpunt is gemaakt. |
|
osDisk |
Hiermee haalt u de besturingssysteemschijf op van de virtuele machine die is vastgelegd op het moment dat het herstelpunt is gemaakt. |
securityEncryptionTypes
Hiermee geeft u het EncryptionType van de beheerde schijf. Deze is ingesteld op DiskWithVMGuestState voor versleuteling van de beheerde schijf, samen met VMGuestState-blob, VMGuestStateOnly voor versleuteling van alleen de VMGuestState-blob en NonPersistedTPM voor het niet behouden van de firmwarestatus in de VMGuestState-blob.. Opmerking: Deze kan alleen worden ingesteld voor vertrouwelijke VM's.
Name | Type | Description |
---|---|---|
DiskWithVMGuestState |
string |
|
NonPersistedTPM |
string |
|
VMGuestStateOnly |
string |
SecurityProfile
Hiermee geeft u de beveiligingsprofielinstellingen voor de virtuele machine of virtuele-machineschaalset op.
Name | Type | Description |
---|---|---|
encryptionAtHost |
boolean |
Deze eigenschap kan worden gebruikt door de gebruiker in de aanvraag om hostversleuteling voor de virtuele machine of virtuele-machineschaalset in of uit te schakelen. Hierdoor wordt de versleuteling ingeschakeld voor alle schijven, inclusief resource-/tijdelijke schijf op de host zelf. Het standaardgedrag is: De versleuteling op de host wordt uitgeschakeld, tenzij deze eigenschap is ingesteld op waar voor de resource. |
encryptionIdentity |
Hiermee geeft u de beheerde identiteit op die door ADE wordt gebruikt om toegangstoken op te halen voor sleutelkluisbewerkingen. |
|
proxyAgentSettings |
Hiermee geeft u ProxyAgent-instellingen op tijdens het maken van de virtuele machine. Minimale API-versie: 2023-09-01. |
|
securityType |
Hiermee geeft u het SecurityType van de virtuele machine. Deze moet worden ingesteld op een opgegeven waarde om UefiSettings in te schakelen. Het standaardgedrag is: UefiSettings wordt niet ingeschakeld, tenzij deze eigenschap is ingesteld. |
|
uefiSettings |
Hiermee geeft u de beveiligingsinstellingen op, zoals beveiligd opstarten en vTPM die worden gebruikt tijdens het maken van de virtuele machine. Minimale API-versie: 2020-12-01. |
SecurityTypes
Hiermee geeft u het SecurityType van de virtuele machine. Deze moet worden ingesteld op een opgegeven waarde om UefiSettings in te schakelen. Het standaardgedrag is: UefiSettings wordt niet ingeschakeld, tenzij deze eigenschap is ingesteld.
Name | Type | Description |
---|---|---|
ConfidentialVM |
string |
|
TrustedLaunch |
string |
SettingNames
Hiermee geeft u de naam op van de instelling waarop de inhoud van toepassing is. Mogelijke waarden zijn: FirstLogonCommands en AutoLogon.
Name | Type | Description |
---|---|---|
AutoLogon |
string |
|
FirstLogonCommands |
string |
SshConfiguration
SSH-configuratie voor op Linux gebaseerde VM's die worden uitgevoerd in Azure
Name | Type | Description |
---|---|---|
publicKeys |
De lijst met openbare SSH-sleutels die worden gebruikt voor verificatie met virtuele Linux-machines. |
SshPublicKey
Bevat informatie over de openbare SSH-certificaatsleutel en het pad op de Virtuele Linux-machine waarop de openbare sleutel wordt geplaatst.
Name | Type | Description |
---|---|---|
keyData |
string |
Het openbare SSH-sleutelcertificaat dat wordt gebruikt voor verificatie met de virtuele machine via ssh. De sleutel moet ten minste 2048-bits en in ssh-rsa-indeling zijn. Zie [SSH-sleutels maken in Linux en Mac voor Linux-VM's in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). voor het maken van SSH-sleutels |
path |
string |
Hiermee geeft u het volledige pad op de gemaakte VM waarin de openbare SSH-sleutel wordt opgeslagen. Als het bestand al bestaat, wordt de opgegeven sleutel toegevoegd aan het bestand. Voorbeeld: /home/user/.ssh/authorized_keys |
StatusLevelTypes
De niveaucode.
Name | Type | Description |
---|---|---|
Error |
string |
|
Info |
string |
|
Warning |
string |
StorageAccountTypes
Hiermee geeft u het type opslagaccount voor de beheerde schijf. OPMERKING: UltraSSD_LRS kan alleen worden gebruikt met gegevensschijven, deze kan niet worden gebruikt met besturingssysteemschijf.
Name | Type | Description |
---|---|---|
PremiumV2_LRS |
string |
|
Premium_LRS |
string |
|
Premium_ZRS |
string |
|
StandardSSD_LRS |
string |
|
StandardSSD_ZRS |
string |
|
Standard_LRS |
string |
|
UltraSSD_LRS |
string |
SubResource
Name | Type | Description |
---|---|---|
id |
string |
Resource-id |
UefiSettings
Hiermee geeft u de beveiligingsinstellingen op, zoals beveiligd opstarten en vTPM die worden gebruikt tijdens het maken van de virtuele machine. Minimale API-versie: 2020-12-01.
Name | Type | Description |
---|---|---|
secureBootEnabled |
boolean |
Hiermee geeft u op of beveiligd opstarten moet worden ingeschakeld op de virtuele machine. Minimale API-versie: 2020-12-01. |
vTpmEnabled |
boolean |
Hiermee geeft u op of vTPM moet worden ingeschakeld op de virtuele machine. Minimale API-versie: 2020-12-01. |
VaultCertificate
Beschrijft één certificaatverwijzing in een Sleutelkluis en waar het certificaat zich op de virtuele machine moet bevinden.
Name | Type | Description |
---|---|---|
certificateStore |
string |
Voor Virtuele Windows-machines geeft u het certificaatarchief op de virtuele machine waaraan het certificaat moet worden toegevoegd. Het opgegeven certificaatarchief bevindt zich impliciet in het LocalMachine-account. Voor Linux-VM's wordt het certificaatbestand onder de map /var/lib/waagent geplaatst, met de bestandsnaam <HoofdletterThumbprint>.crt voor het X509-certificaatbestand en <HoofdlettercaseThumbprint>.prv voor persoonlijke sleutel. Beide bestanden zijn .pem-indeling. |
certificateUrl |
string |
Dit is de URL van een certificaat dat als geheim is geüpload naar Key Vault. Zie Een sleutel of geheim toevoegen aan de sleutelkluisvoor informatie over het toevoegen van een geheim aan de sleutelkluis. In dit geval moet uw certificaat de Base64-codering zijn van het volgende JSON-object dat is gecodeerd in UTF-8: |
VaultSecretGroup
Beschrijft een set certificaten die zich allemaal in dezelfde Key Vault bevinden.
Name | Type | Description |
---|---|---|
sourceVault |
De relatieve URL van de Sleutelkluis met alle certificaten in VaultCertificates. |
|
vaultCertificates |
De lijst met sleutelkluisverwijzingen in SourceVault die certificaten bevatten. |
VirtualMachineSizeTypes
Hiermee geeft u de grootte van de virtuele machine. Het enum-gegevenstype is momenteel afgeschaft en wordt op 23 december 2023 verwijderd. De aanbevolen manier om de lijst met beschikbare grootten op te halen, is met behulp van deze API's: Alle beschikbare grootten van virtuele machines in een beschikbaarheidsset weergeven, Alle beschikbare grootten van virtuele machines in een regio weergeven, Alle beschikbare grootten van virtuele machines weergeven voor het wijzigen van de grootte van. Zie Grootten voor virtuele machinesvoor meer informatie over de grootte van virtuele machines. De beschikbare VM-grootten zijn afhankelijk van de regio en beschikbaarheidsset.
Name | 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
Hiermee geeft u de beveiligingsprofielinstellingen voor de beheerde schijf. Opmerking: Deze kan alleen worden ingesteld voor vertrouwelijke VM's.
Name | Type | Description |
---|---|---|
diskEncryptionSet |
Hiermee geeft u de door de klant beheerde schijfversleutelingssetresource-id op voor de beheerde schijf die wordt gebruikt voor door de klant beheerde sleutel versleutelde ConfidentialVM-besturingssysteemschijf en VMGuest-blob. |
|
securityEncryptionType |
Hiermee geeft u het EncryptionType van de beheerde schijf. Deze is ingesteld op DiskWithVMGuestState voor versleuteling van de beheerde schijf, samen met VMGuestState-blob, VMGuestStateOnly voor versleuteling van alleen de VMGuestState-blob en NonPersistedTPM voor het niet behouden van de firmwarestatus in de VMGuestState-blob.. Opmerking: Deze kan alleen worden ingesteld voor vertrouwelijke VM's. |
VMSizeProperties
Hiermee geeft u de instellingen voor de eigenschap VM-grootte op de virtuele machine.
Name | Type | Description |
---|---|---|
vCPUsAvailable |
integer |
Hiermee geeft u het aantal vCPU's dat beschikbaar is voor de virtuele machine. Wanneer deze eigenschap niet is opgegeven in de aanvraagbody, wordt het standaardgedrag ingesteld op de waarde van vCPU's die beschikbaar zijn voor die VM-grootte die beschikbaar is in api-antwoord van Alle beschikbare grootten van virtuele machines in een regio weergeven. |
vCPUsPerCore |
integer |
Hiermee geeft u de verhouding tussen vCPU en fysieke kern. Wanneer deze eigenschap niet is opgegeven in de aanvraagbody, wordt het standaardgedrag ingesteld op de waarde van vCPUUsPerCore voor de VM-grootte die wordt weergegeven in api-antwoord van Alle beschikbare grootten van virtuele machines in een regio weergeven. Deze eigenschap instellen op 1 betekent ook dat hyperthreading is uitgeschakeld. |
WindowsConfiguration
Hiermee geeft u windows-besturingssysteeminstellingen op de virtuele machine.
Name | Type | Description |
---|---|---|
additionalUnattendContent |
Hiermee geeft u aanvullende base-64 gecodeerde XML-geformatteerde informatie op die kan worden opgenomen in het Unattend.xml-bestand, dat wordt gebruikt door Windows Setup. |
|
enableAutomaticUpdates |
boolean |
Hiermee wordt aangegeven of Automatische updates is ingeschakeld voor de virtuele Windows-machine. De standaardwaarde is waar. Voor virtuele-machineschaalsets kan deze eigenschap worden bijgewerkt en worden updates van kracht bij het opnieuw inrichten van het besturingssysteem. |
enableVMAgentPlatformUpdates |
boolean |
Geeft aan of VMAgent-platformupdates zijn ingeschakeld voor de virtuele Windows-machine. |
patchSettings |
[Preview-functie] Hiermee geeft u instellingen met betrekking tot VM-gastpatching in Windows. |
|
provisionVMAgent |
boolean |
Hiermee wordt aangegeven of de virtuele-machineagent moet worden ingericht op de virtuele machine. Wanneer deze eigenschap niet is opgegeven in de hoofdtekst van de aanvraag, is deze standaard ingesteld op true. Dit zorgt ervoor dat de VM-agent op de VIRTUELE machine is geïnstalleerd, zodat extensies later aan de VIRTUELE machine kunnen worden toegevoegd. |
timeZone |
string |
Hiermee geeft u de tijdzone van de virtuele machine. bijvoorbeeld "Pacific Standard Time". Mogelijke waarden kunnen worden TimeZoneInfo.Id waarde uit tijdzones die worden geretourneerd door TimeZoneInfo.GetSystemTimeZones. |
winRM |
Hiermee geeft u de listeners voor Extern beheer van Windows op. Hiermee schakelt u externe Windows PowerShell in. |
WindowsPatchAssessmentMode
Hiermee geeft u de modus van vm-gastpatchevaluatie voor de virtuele IaaS-machine.
Mogelijke waarden zijn:
ImageDefault-: u bepaalt de timing van patchevaluaties op een virtuele machine.
AutomaticByPlatform - Het platform activeert periodieke patchevaluaties. De eigenschap provisionVMAgent moet waar zijn.
Name | Type | Description |
---|---|---|
AutomaticByPlatform |
string |
|
ImageDefault |
string |
WindowsVMGuestPatchAutomaticByPlatformRebootSetting
Hiermee geeft u de instelling voor opnieuw opstarten voor alle installatiebewerkingen van de AutomaticByPlatform-patch.
Name | Type | Description |
---|---|---|
Always |
string |
|
IfRequired |
string |
|
Never |
string |
|
Unknown |
string |
WindowsVMGuestPatchAutomaticByPlatformSettings
Hiermee geeft u aanvullende instellingen op die moeten worden toegepast wanneer de patchmodus AutomaticByPlatform is geselecteerd in de Windows-patchinstellingen.
Name | Type | Description |
---|---|---|
bypassPlatformSafetyChecksOnUserSchedule |
boolean |
Stelt de klant in staat patches te plannen zonder onbedoelde upgrades |
rebootSetting |
Hiermee geeft u de instelling voor opnieuw opstarten voor alle installatiebewerkingen van de AutomaticByPlatform-patch. |
WindowsVMGuestPatchMode
Hiermee geeft u de modus van VM-gastpatching naar virtuele IaaS-machine of virtuele machines die zijn gekoppeld aan virtuele-machineschaalset met OrchestrationMode als Flexibel.
Mogelijke waarden zijn:
Handmatige: u beheert de toepassing van patches op een virtuele machine. U doet dit door patches handmatig toe te passen in de VIRTUELE machine. In deze modus worden automatische updates uitgeschakeld; de eigenschap WindowsConfiguration.enableAutomaticUpdates moet onwaar zijn
AutomaticByOS-: de virtuele machine wordt automatisch bijgewerkt door het besturingssysteem. De eigenschap WindowsConfiguration.enableAutomaticUpdates moet waar zijn.
AutomaticByPlatform: de virtuele machine wordt automatisch bijgewerkt door het platform. De eigenschappen provisionVMAgent en WindowsConfiguration.enableAutomaticUpdates moeten waar zijn
Name | Type | Description |
---|---|---|
AutomaticByOS |
string |
|
AutomaticByPlatform |
string |
|
Manual |
string |
WinRMConfiguration
Hierin wordt de configuratie van Windows Remote Management van de VM beschreven
Name | Type | Description |
---|---|---|
listeners |
De lijst met Windows Remote Management-listeners |
WinRMListener
Beschrijft protocol en vingerafdruk van Windows Remote Management-listener
Name | Type | Description |
---|---|---|
certificateUrl |
string |
Dit is de URL van een certificaat dat als geheim is geüpload naar Key Vault. Zie Een sleutel of geheim toevoegen aan de sleutelkluisvoor informatie over het toevoegen van een geheim aan de sleutelkluis. In dit geval moet uw certificaat de Base64-codering zijn van het volgende JSON-object dat is gecodeerd in UTF-8: |
protocol |
Hiermee geeft u het protocol van WinRM-listener. Mogelijke waarden zijn: http,https. |