Gallery Images - Create Or Update

Referenz

Dienst:: Azure Stack HCI

API-Version:: 2024-01-01

Der Vorgang zum Erstellen oder Aktualisieren eines Katalogbilds. Beachten Sie, dass einige Eigenschaften nur während der Erstellung von Katalogbildern festgelegt werden können.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/galleryImages/{galleryImageName}?api-version=2024-01-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
galleryImageName	path	True	string minLength: 1 maxLength: 80 pattern: ^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[a-zA-Z0-9]$	Name des Katalogbilds
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 minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
location	True	string	Der geografische Standort, an dem sich die Ressource befindet
properties.osType	True	OperatingSystemTypes	Betriebssystemtyp, den das Katalogimage verwendet [Windows, Linux]
extendedLocation		ExtendedLocation	Die extendedLocation der Ressource.
properties.cloudInitDataSource		CloudInitDataSource	Datenquelle für das Katalogbild bei der Bereitstellung mit cloud-init [NoCloud, Azure]
properties.containerId		string (arm-id)	Storage ContainerID des Speichercontainers, der für das Katalogimage verwendet werden soll
properties.hyperVGeneration		HyperVGeneration	Die Hypervisorgenerierung des virtuellen Computers [V1, V2]
properties.identifier		GalleryImageIdentifier	Dies ist der Katalogbilddefinitionsbezeichner.
properties.imagePath		string	Speicherort des Bilds, aus dem das Katalogbild erstellt werden soll
properties.status.downloadStatus		DownloadStatus	Der Downloadstatus des Katalogbilds
properties.status.errorCode		string	Fehlercode für die GalleryImage-Bereitstellung
properties.status.errorMessage		string	Beschreibende Fehlermeldung
properties.status.progressPercentage		integer (int64)	Der Fortschritt des Vorgangs in Prozent
properties.status.provisioningStatus		ProvisioningStatus
properties.version		GalleryImageVersion	Gibt Informationen zur Katalogbildversion an, die Sie erstellen oder aktualisieren möchten.
tags		object	Ressourcentags.

Antworten

Name	Typ	Beschreibung
200 OK	GalleryImages	Aktualisiert
201 Created	GalleryImages	Erstellt
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

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

PutGalleryImage

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image?api-version=2024-01-01

{
  "location": "West US2",
  "extendedLocation": {
    "type": "CustomLocation",
    "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location"
  },
  "properties": {
    "imagePath": "C:\\test.vhdx",
    "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container",
    "osType": "Linux"
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image",
  "name": "test-gallery-image",
  "type": "Microsoft.AzureStackHCI/galleryImages",
  "location": "West US2",
  "extendedLocation": {
    "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location",
    "type": "CustomLocation"
  },
  "properties": {
    "provisioningState": "Accepted",
    "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container",
    "osType": "Linux",
    "cloudInitDataSource": "NoCloud",
    "hyperVGeneration": "V2",
    "version": {
      "properties": {
        "storageProfile": {
          "osDiskImage": {
            "sizeInMB": 30270
          }
        }
      }
    },
    "status": {
      "provisioningStatus": {
        "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0",
        "status": "Succeeded"
      },
      "progressPercentage": 100,
      "downloadStatus": {
        "downloadSizeInMB": 9383
      }
    }
  }
}

Statuscode:: 201

{
  "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-galimg3325",
  "name": "test-gallery-image",
  "type": "Microsoft.AzureStackHCI/galleryImages",
  "location": "West US2",
  "extendedLocation": {
    "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location",
    "type": "CustomLocation"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container",
    "osType": "Linux",
    "cloudInitDataSource": "NoCloud",
    "hyperVGeneration": "V2",
    "version": {
      "properties": {
        "storageProfile": {
          "osDiskImage": {
            "sizeInMB": 30270
          }
        }
      }
    },
    "status": {
      "provisioningStatus": {
        "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0",
        "status": "Succeeded"
      },
      "progressPercentage": 100,
      "downloadStatus": {
        "downloadSizeInMB": 9383
      }
    }
  }
}

Definitionen

Name	Beschreibung
CloudInitDataSource	Datenquelle für das Katalogbild bei der Bereitstellung mit cloud-init [NoCloud, Azure]
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DownloadStatus	Der Downloadstatus des Katalogbilds
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ExtendedLocation	Der komplexe Typ des erweiterten Standorts.
ExtendedLocationTypes	Der Typ des erweiterten Speicherorts.
GalleryImageIdentifier	Dies ist der Katalogbilddefinitionsbezeichner.
GalleryImages	Die Ressourcendefinition der Galeriebilder.
GalleryImageVersion	Gibt Informationen zur Katalogbildversion an, die Sie erstellen oder aktualisieren möchten.
GalleryImageVersionStorageProfile	Dies ist das Speicherprofil einer Katalogbildversion.
GalleryOSDiskImage	Dies ist das Betriebssystemdatenträgerimage.
HyperVGeneration	Die Hypervisorgenerierung des virtuellen Computers [V1, V2]
OperatingSystemTypes	Betriebssystemtyp, den das Katalogimage verwendet [Windows, Linux]
ProvisioningStateEnum	Bereitstellungsstatus des Katalogbilds.
ProvisioningStatus
Status	Der Status des Vorgangs, der für das Katalogbild ausgeführt wurde [Erfolgreich, Fehlgeschlagen, InProgress]
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

CloudInitDataSource

Enumeration

Datenquelle für das Katalogbild bei der Bereitstellung mit cloud-init [NoCloud, Azure]

Wert	Beschreibung
Azure
NoCloud

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

DownloadStatus

Objekt

Der Downloadstatus des Katalogbilds

Name	Typ	Beschreibung
downloadSizeInMB	integer (int64)	Die heruntergeladene Größe des Bilds in MB

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 komplexe Typ des erweiterten Standorts.

Name	Typ	Beschreibung
name	string	Der Name des erweiterten Speicherorts.
type	ExtendedLocationTypes	Der Typ des erweiterten Speicherorts.

ExtendedLocationTypes

Enumeration

Der Typ des erweiterten Speicherorts.

Wert	Beschreibung
CustomLocation

GalleryImageIdentifier

Objekt

Dies ist der Katalogbilddefinitionsbezeichner.

Name	Typ	Beschreibung
offer	string	Der Name des Katalogbilddefinitionsangebots.
publisher	string	Der Name des Herausgebers der Katalogbilddefinition.
sku	string	Der Name der SKU der Katalogbilddefinition.

GalleryImages

Objekt

Die Ressourcendefinition der Galeriebilder.

Name	Typ	Beschreibung
extendedLocation	ExtendedLocation	Die extendedLocation der Ressource.
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /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.cloudInitDataSource	CloudInitDataSource	Datenquelle für das Katalogbild bei der Bereitstellung mit cloud-init [NoCloud, Azure]
properties.containerId	string (arm-id)	Storage ContainerID des Speichercontainers, der für das Katalogimage verwendet werden soll
properties.hyperVGeneration	HyperVGeneration	Die Hypervisorgenerierung des virtuellen Computers [V1, V2]
properties.identifier	GalleryImageIdentifier	Dies ist der Katalogbilddefinitionsbezeichner.
properties.imagePath	string	Speicherort des Bilds, aus dem das Katalogbild erstellt werden soll
properties.osType	OperatingSystemTypes	Betriebssystemtyp, den das Katalogimage verwendet [Windows, Linux]
properties.provisioningState	ProvisioningStateEnum	Bereitstellungsstatus des Katalogbilds.
properties.status.downloadStatus	DownloadStatus	Der Downloadstatus des Katalogbilds
properties.status.errorCode	string	Fehlercode für die GalleryImage-Bereitstellung
properties.status.errorMessage	string	Beschreibende Fehlermeldung
properties.status.progressPercentage	integer (int64)	Der Fortschritt des Vorgangs in Prozent
properties.status.provisioningStatus	ProvisioningStatus
properties.version	GalleryImageVersion	Gibt Informationen zur Katalogbildversion an, die Sie erstellen oder aktualisieren möchten.
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"

GalleryImageVersion

Objekt

Gibt Informationen zur Katalogbildversion an, die Sie erstellen oder aktualisieren möchten.

Name	Typ	Beschreibung
name	string	Dies ist die Version des Katalogbilds.
properties.storageProfile	GalleryImageVersionStorageProfile	Dies ist das Speicherprofil einer Katalogbildversion.

GalleryImageVersionStorageProfile

Objekt

Dies ist das Speicherprofil einer Katalogbildversion.

Name	Typ	Beschreibung
osDiskImage	GalleryOSDiskImage	Dies ist das Betriebssystemdatenträgerimage.

GalleryOSDiskImage

Objekt

Dies ist das Betriebssystemdatenträgerimage.

Name	Typ	Beschreibung
sizeInMB	integer (int64)	Diese Eigenschaft gibt die Größe der zu erstellenden VHD an.

HyperVGeneration

Enumeration

Die Hypervisorgenerierung des virtuellen Computers [V1, V2]

Wert	Beschreibung
V1
V2

OperatingSystemTypes

Enumeration

Betriebssystemtyp, den das Katalogimage verwendet [Windows, Linux]

Wert	Beschreibung
Linux
Windows

ProvisioningStateEnum

Enumeration

Bereitstellungsstatus des Katalogbilds.

Wert	Beschreibung
Accepted
Canceled
Deleting
Failed
InProgress
Succeeded

ProvisioningStatus

Objekt

Name	Typ	Beschreibung
operationId	string	Die ID des Vorgangs, der für das Katalogbild ausgeführt wurde
status	Status	Der Status des Vorgangs, der für das Katalogbild ausgeführt wurde [Erfolgreich, Fehlgeschlagen, InProgress]

Status

Enumeration

Der Status des Vorgangs, der für das Katalogbild ausgeführt wurde [Erfolgreich, Fehlgeschlagen, InProgress]

Wert	Beschreibung
Failed
InProgress
Succeeded

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.

Freigeben über

Gallery Images - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

PutGalleryImage

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CloudInitDataSource

createdByType

DownloadStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedLocation

ExtendedLocationTypes

GalleryImageIdentifier

GalleryImages

GalleryImageVersion

GalleryImageVersionStorageProfile

GalleryOSDiskImage

HyperVGeneration

OperatingSystemTypes

ProvisioningStateEnum

ProvisioningStatus

Status

systemData