Virtual Machine Templates - Create Or Update

Referenz

Dienst:: Azure Arc enabled SCVMM

API-Version:: 2024-06-01

Implementiert die PUT-Methode "VirtualMachineTemplates".
Integriert die Vm-Vorlage "ScVmm" als Azure VM-Vorlagenressource.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachineTemplates/{virtualMachineTemplateName}?api-version=2024-06-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
virtualMachineTemplateName	path	True	string minLength: 1 maxLength: 54 pattern: [a-zA-Z0-9-_\.]	Name der VirtualMachineTemplate.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
extendedLocation	True	ExtendedLocation	Der erweiterte Speicherort.
location	True	string	Der geografische Standort, an dem sich die Ressource befindet
properties.inventoryItemId		string	Dient zum Abrufen oder Festlegen der Bestandselement-ID für die Ressource.
properties.uuid		string pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$	Eindeutige ID der Vorlage für virtuelle Computer.
properties.vmmServerId		string (arm-id)	ARM-ID der vmmServer-Ressource, in der sich diese Ressource befindet.
tags		object	Ressourcentags.

Antworten

Name	Typ	Beschreibung
200 OK	VirtualMachineTemplate	Der Aktualisierungsvorgang der Ressource "VirtualMachineTemplate" war erfolgreich.
201 Created	VirtualMachineTemplate	Der Erstellungsvorgang der Ressource "VirtualMachineTemplate" war erfolgreich. Header Retry-After: integer
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Name

Typ

Beschreibung

200 OK

VirtualMachineTemplate

Der Aktualisierungsvorgang der Ressource "VirtualMachineTemplate" war erfolgreich.

201 Created

VirtualMachineTemplate

Der Erstellungsvorgang der Ressource "VirtualMachineTemplate" war erfolgreich.

Header

Retry-After: integer

Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

VirtualMachineTemplates_CreateOrUpdate_MaximumSet

VirtualMachineTemplates_CreateOrUpdate_MinimumSet

VirtualMachineTemplates_CreateOrUpdate_MaximumSet

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/79332E5A-630B-480F-A266-A941C015AB19/resourceGroups/rgscvmm/providers/Microsoft.ScVmm/virtualMachineTemplates/6?api-version=2024-06-01

{
  "properties": {
    "inventoryItemId": "qjrykoogccwlgkd",
    "uuid": "12345678-1234-1234-1234-12345678abcd",
    "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName",
    "osType": "Windows",
    "limitCpuForMigration": "true",
    "dynamicMemoryEnabled": "true",
    "isCustomizable": "true",
    "isHighlyAvailable": "true"
  },
  "extendedLocation": {
    "type": "customLocation",
    "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName"
  },
  "tags": {
    "key9494": "kkbmfpwhmvlobm"
  },
  "location": "ayxsyduviotylbojh"
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "properties": {
    "inventoryItemId": "qjrykoogccwlgkd",
    "uuid": "12345678-1234-1234-1234-12345678abcd",
    "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName",
    "osType": "Windows",
    "osName": "qcbolnbisklo",
    "computerName": "asxghqngsojdsdptpirbz",
    "memoryMB": 24,
    "cpuCount": 23,
    "limitCpuForMigration": "true",
    "dynamicMemoryEnabled": "true",
    "isCustomizable": "true",
    "dynamicMemoryMaxMB": 21,
    "dynamicMemoryMinMB": 21,
    "isHighlyAvailable": "true",
    "generation": 16,
    "networkInterfaces": [
      {
        "name": "kvofzqulbjlbtt",
        "displayName": "yoayfd",
        "ipv4Addresses": [
          "eeunirpkpqazzxhsqonkxcfuks"
        ],
        "ipv6Addresses": [
          "pk"
        ],
        "macAddress": "oaeqqegt",
        "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName",
        "networkName": "lqbm",
        "ipv4AddressType": "Dynamic",
        "ipv6AddressType": "Dynamic",
        "macAddressType": "Dynamic",
        "nicId": "roxpsvlo"
      }
    ],
    "disks": [
      {
        "name": "fgnckfymwdsqnfxkdvexuaobe",
        "displayName": "fgladknawlgjodo",
        "diskId": "ltdrwcfjklpsimhzqyh",
        "diskSizeGB": 30,
        "maxDiskSizeGB": 18,
        "bus": 8,
        "lun": 10,
        "busType": "zu",
        "vhdType": "cnbeeeylrvopigdynvgpkfp",
        "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln",
        "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb",
        "templateDiskId": "lcdwrokpyvekqccclf",
        "storageQoSPolicy": {
          "name": "ceiyfrflu",
          "id": "o"
        },
        "createDiffDisk": "true"
      }
    ],
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "type": "customLocation",
    "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName"
  },
  "tags": {
    "key9494": "kkbmfpwhmvlobm"
  },
  "location": "ayxsyduviotylbojh",
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName",
  "name": "ioeuwaznkaayvhpqbnrwbr",
  "type": "egfzqiscydkyddksvsjujdlee",
  "systemData": {
    "createdBy": "p",
    "createdByType": "User",
    "createdAt": "2024-01-29T22:28:00.094Z",
    "lastModifiedBy": "goxcwpyyqlxndquly",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-01-29T22:28:00.095Z"
  }
}

Statuscode:: 201

Azure-AsyncOperation: https://contoso.com/operationstatus

{
  "properties": {
    "inventoryItemId": "qjrykoogccwlgkd",
    "uuid": "12345678-1234-1234-1234-12345678abcd",
    "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName",
    "osType": "Windows",
    "osName": "qcbolnbisklo",
    "computerName": "asxghqngsojdsdptpirbz",
    "memoryMB": 24,
    "cpuCount": 23,
    "limitCpuForMigration": "true",
    "dynamicMemoryEnabled": "true",
    "isCustomizable": "true",
    "dynamicMemoryMaxMB": 21,
    "dynamicMemoryMinMB": 21,
    "isHighlyAvailable": "true",
    "generation": 16,
    "networkInterfaces": [
      {
        "name": "kvofzqulbjlbtt",
        "displayName": "yoayfd",
        "ipv4Addresses": [
          "eeunirpkpqazzxhsqonkxcfuks"
        ],
        "ipv6Addresses": [
          "pk"
        ],
        "macAddress": "oaeqqegt",
        "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName",
        "networkName": "lqbm",
        "ipv4AddressType": "Dynamic",
        "ipv6AddressType": "Dynamic",
        "macAddressType": "Dynamic",
        "nicId": "roxpsvlo"
      }
    ],
    "disks": [
      {
        "name": "fgnckfymwdsqnfxkdvexuaobe",
        "displayName": "fgladknawlgjodo",
        "diskId": "ltdrwcfjklpsimhzqyh",
        "diskSizeGB": 30,
        "maxDiskSizeGB": 18,
        "bus": 8,
        "lun": 10,
        "busType": "zu",
        "vhdType": "cnbeeeylrvopigdynvgpkfp",
        "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln",
        "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb",
        "templateDiskId": "lcdwrokpyvekqccclf",
        "storageQoSPolicy": {
          "name": "ceiyfrflu",
          "id": "o"
        },
        "createDiffDisk": "true"
      }
    ],
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "type": "customLocation",
    "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName"
  },
  "tags": {
    "key9494": "kkbmfpwhmvlobm"
  },
  "location": "ayxsyduviotylbojh",
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName",
  "name": "ioeuwaznkaayvhpqbnrwbr",
  "type": "egfzqiscydkyddksvsjujdlee",
  "systemData": {
    "createdBy": "p",
    "createdByType": "User",
    "createdAt": "2024-01-29T22:28:00.094Z",
    "lastModifiedBy": "goxcwpyyqlxndquly",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-01-29T22:28:00.095Z"
  }
}

VirtualMachineTemplates_CreateOrUpdate_MinimumSet

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/79332E5A-630B-480F-A266-A941C015AB19/resourceGroups/rgscvmm/providers/Microsoft.ScVmm/virtualMachineTemplates/P?api-version=2024-06-01

{
  "extendedLocation": {},
  "location": "ayxsyduviotylbojh"
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName",
  "extendedLocation": {},
  "location": "ayxsyduviotylbojh"
}

Statuscode:: 201

Azure-AsyncOperation: https://contoso.com/operationstatus

{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName",
  "extendedLocation": {},
  "location": "ayxsyduviotylbojh"
}

Definitionen

Name	Beschreibung
AllocationMethod	Methode für die Netzwerkadressenzuweisung.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
CreateDiffDisk	Erstellen Sie diff disk.
DynamicMemoryEnabled	Dynamischer Speicher aktiviert.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ExtendedLocation	Der erweiterte Speicherort.
IsCustomizable	Anpassbar.
IsHighlyAvailable	Hoch verfügbar.
LimitCpuForMigration	Beschränken Sie die CPU für die Migration.
NetworkInterface	Netzwerkschnittstellenmodell
OsType	Betriebssystemtyp des virtuellen Computers.
ProvisioningState	Der Bereitstellungsstatus der Ressource.
StorageQosPolicyDetails	Die StorageQoSPolicyDetails-Definition.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
VirtualDisk	Modell für virtuelle Datenträger
VirtualMachineTemplate	Die VirtualMachineTemplates-Ressourcendefinition.

AllocationMethod

Enumeration

Methode für die Netzwerkadressenzuweisung.

Wert	Beschreibung
Dynamic	Dynamisch zugewiesene Adresse.
Static	Statisch zugewiesene Adresse.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

CreateDiffDisk

Enumeration

Erstellen Sie diff disk.

Wert	Beschreibung
false	Deaktivieren Sie den Diff-Datenträger erstellen.
true	Aktivieren Sie "Diff Disk erstellen".

DynamicMemoryEnabled

Enumeration

Dynamischer Speicher aktiviert.

Wert	Beschreibung
false	Deaktivieren Sie den dynamischen Speicher.
true	Aktivieren Sie dynamischen Arbeitsspeicher.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ExtendedLocation

Objekt

Der erweiterte Speicherort.

Name	Typ	Beschreibung
name	string (arm-id)	Der Name des erweiterten Speicherorts.
type	string	Der erweiterte Standorttyp.

IsCustomizable

Enumeration

Anpassbar.

Wert	Beschreibung
false	Anpassbar deaktivieren.
true	Anpassbare Option aktivieren.

IsHighlyAvailable

Enumeration

Hoch verfügbar.

Wert	Beschreibung
false	Deaktivieren Sie hochverwendbar.
true	Aktivieren Sie hochverwendbar.

LimitCpuForMigration

Enumeration

Beschränken Sie die CPU für die Migration.

Wert	Beschreibung
false	Deaktivieren Sie die CPU-Grenze für die Migration.
true	Aktivieren Sie die CPU-Grenze für die Migration.

NetworkInterface

Objekt

Netzwerkschnittstellenmodell

Name	Typ	Beschreibung
displayName	string	Ruft den Anzeigenamen der Netzwerkschnittstelle ab, wie im vmmServer dargestellt. Dies ist die Fallbackbezeichnung für eine NIC, wenn der Name nicht festgelegt ist.
ipv4AddressType	AllocationMethod	Dient zum Abrufen oder Festlegen des ipv4-Adresstyps.
ipv4Addresses	string[]	Ruft die nic ipv4-Adressen ab.
ipv6AddressType	AllocationMethod	Dient zum Abrufen oder Festlegen des ipv6-Adresstyps.
ipv6Addresses	string[]	Ruft die nic ipv6-Adressen ab.
macAddress	string	Ruft die nic MAC-Adresse ab oder legt sie fest.
macAddressType	AllocationMethod	Dient zum Abrufen oder Festlegen des Mac-Adresstyps.
name	string	Dient zum Abrufen oder Festlegen des Namens der Netzwerkschnittstelle.
networkName	string	Ruft den Namen des virtuellen Netzwerks in vmmServer ab, mit dem der nic verbunden ist.
nicId	string	Ruft die nic-ID ab oder legt sie fest.
virtualNetworkId	string (arm-id)	Ruft die ARM-ID der Microsoft.ScVmm/virtualNetwork-Ressource ab, um die nic zu verbinden, oder legt sie fest.

OsType

Enumeration

Betriebssystemtyp des virtuellen Computers.

Wert	Beschreibung
Linux	Linux-Betriebssystem.
Other	Anderes Betriebssystem.
Windows	Windows-Betriebssystem.

ProvisioningState

Enumeration

Der Bereitstellungsstatus der Ressource.

Wert	Beschreibung
Accepted	Die Ressource wurde akzeptiert.
Canceled	Die Ressourcenerstellung wurde abgebrochen.
Created	Die Ressource wurde erstellt.
Deleting	Die Ressource wird gelöscht.
Failed	Fehler bei der Ressourcenerstellung.
Provisioning	Die Ressource wird bereitgestellt.
Succeeded	Ressource wurde erstellt.
Updating	Die Ressource wird aktualisiert.

StorageQosPolicyDetails

Objekt

Die StorageQoSPolicyDetails-Definition.

Name	Typ	Beschreibung
id	string	Die ID der QoS-Richtlinie.
name	string	Der Name der Richtlinie.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

VirtualDisk

Objekt

Modell für virtuelle Datenträger

Name	Typ	Beschreibung
bus	integer (int32)	Ruft den Datenträgerbus ab oder legt den Datenträgerbus fest.
busType	string	Dient zum Abrufen oder Festlegen des Datenträgerbustyps.
createDiffDisk	CreateDiffDisk	Dient zum Abrufen oder Festlegen eines Werts, der den Diff Disk angibt.
diskId	string	Ruft die Datenträger-ID ab oder legt sie fest.
diskSizeGB	integer (int32)	Ruft die Gesamtgröße des Datenträgers ab oder legt diese fest.
displayName	string	Ruft den Anzeigenamen des virtuellen Datenträgers ab, wie im vmmServer dargestellt. Dies ist die Fallbackbezeichnung für einen Datenträger, wenn der Name nicht festgelegt ist.
lun	integer (int32)	Ruft die Datenträger-Lun ab oder legt sie fest.
maxDiskSizeGB	integer (int32)	Ruft die maximale Datenträgergröße ab.
name	string	Ruft den Namen des Datenträgers ab oder legt den Namen fest.
storageQoSPolicy	StorageQosPolicyDetails	Die QoS-Richtlinie für den Datenträger.
templateDiskId	string	Ruft die Datenträger-ID in der Vorlage ab oder legt sie fest.
vhdFormatType	string	Ruft den Datenträger vhd-Formattyp ab.
vhdType	string	Dient zum Abrufen oder Festlegen des Datenträger-vhd-Typs.
volumeType	string	Ruft den Datenträgervolumetyp ab.

VirtualMachineTemplate

Objekt

Die VirtualMachineTemplates-Ressourcendefinition.

Name	Typ	Beschreibung
extendedLocation	ExtendedLocation	Der erweiterte Speicherort.
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.computerName	string	Ruft den Computernamen ab.
properties.cpuCount	integer (int32)	Ruft die gewünschte Anzahl von vCPUs für den virtuellen Computer ab.
properties.disks	VirtualDisk[]	Ruft die Datenträger der Vorlage ab.
properties.dynamicMemoryEnabled	DynamicMemoryEnabled	Ruft einen Wert ab, der angibt, ob dynamischen Speicher aktiviert werden soll oder nicht.
properties.dynamicMemoryMaxMB	integer (int32)	Ruft den maximalen dynamischen Speicher für den virtuellen Computer ab.
properties.dynamicMemoryMinMB	integer (int32)	Ruft den min. dynamischen Arbeitsspeicher für den virtuellen Computer ab.
properties.generation	integer (int32)	Ruft die Generierung für den virtuellen Computer ab.
properties.inventoryItemId	string	Dient zum Abrufen oder Festlegen der Bestandselement-ID für die Ressource.
properties.isCustomizable	IsCustomizable	Ruft einen Wert ab, der angibt, ob die VM-Vorlage anpassbar ist oder nicht.
properties.isHighlyAvailable	IsHighlyAvailable	Ruft hoch verfügbare Eigenschaft ab.
properties.limitCpuForMigration	LimitCpuForMigration	Ruft einen Wert ab, der angibt, ob der Prozessorkompatibilitätsmodus für die Livemigration von VMs aktiviert werden soll.
properties.memoryMB	integer (int32)	MemoryMB ist die gewünschte Größe des Arbeitsspeichers eines virtuellen Computers in MB.
properties.networkInterfaces	NetworkInterface[]	Ruft die Netzwerkschnittstellen der Vorlage ab.
properties.osName	string	Ruft den Namen des Betriebssystems ab.
properties.osType	OsType	Ruft den Typ des Betriebssystems ab.
properties.provisioningState	ProvisioningState	Bereitstellungsstatus der Ressource.
properties.uuid	string pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$	Eindeutige ID der Vorlage für virtuelle Computer.
properties.vmmServerId	string (arm-id)	ARM-ID der vmmServer-Ressource, in der sich diese Ressource befindet.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

Freigeben über

Virtual Machine Templates - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

VirtualMachineTemplates_CreateOrUpdate_MaximumSet

Beispielanforderung

Beispiel für eine Antwort

VirtualMachineTemplates_CreateOrUpdate_MinimumSet

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AllocationMethod

createdByType

CreateDiffDisk

DynamicMemoryEnabled

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedLocation

IsCustomizable

IsHighlyAvailable

LimitCpuForMigration

NetworkInterface

OsType

ProvisioningState

StorageQosPolicyDetails

systemData

VirtualDisk

VirtualMachineTemplate