Gallery Script Versions - List By Gallery Script

Dienst:

Compute

API-Version:

2025-03-03

Liste Galerie-Skript-Versionen in einer Galerie-Skriptdefinition auf.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/scripts/{galleryScriptName}/versions?api-version=2025-03-03

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
galleryName	path	True	string pattern: ^[^_\W][\w-._]{0,79}(?	Der Name des freigegebenen Bildkatalogs.
galleryScriptName	path	True	string pattern: ^[a-zA-Z0-9]+([_]?[a-zA-Z0-9]+)*$	Der Name der Galerie: Skriptdefinition, die abgerufen werden soll.
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	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	GalleryScriptVersionList	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	CloudError	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

List gallery Script Versions in a gallery Script Definition.

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/galleries/myGalleryName/scripts/myGalleryScriptName/versions?api-version=2025-03-03

Java

/**
 * Samples for GalleryScriptVersions ListByGalleryScript.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-03-03/galleryScriptExamples/GalleryScriptVersion_ListByGalleryScript.json
     */
    /**
     * Sample code: List gallery Script Versions in a gallery Script Definition.
     * 
     * @param manager Entry point to ComputeManager.
     */
    public static void
        listGalleryScriptVersionsInAGalleryScriptDefinition(com.azure.resourcemanager.compute.ComputeManager manager) {
        manager.serviceClient().getGalleryScriptVersions().listByGalleryScript("myResourceGroupName", "myGalleryName",
            "myGalleryScriptName", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python gallery_script_version_list_by_gallery_script.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.gallery_script_versions.list_by_gallery_script(
        resource_group_name="myResourceGroupName",
        gallery_name="myGalleryName",
        gallery_script_name="myGalleryScriptName",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-03-03/galleryScriptExamples/GalleryScriptVersion_ListByGalleryScript.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v8"
)

// Generated from example definition: 2025-03-03/galleryScriptExamples/GalleryScriptVersion_ListByGalleryScript.json
func ExampleGalleryScriptVersionsClient_NewListByGalleryScriptPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("{subscription-id}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewGalleryScriptVersionsClient().NewListByGalleryScriptPager("myResourceGroupName", "myGalleryName", "myGalleryScriptName", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armcompute.GalleryScriptVersionsClientListByGalleryScriptResponse{
		// 	GalleryScriptVersionList: armcompute.GalleryScriptVersionList{
		// 		Value: []*armcompute.GalleryScriptVersion{
		// 			{
		// 				Location: to.Ptr("West US"),
		// 				Name: to.Ptr("1.0.0"),
		// 				Type: to.Ptr("Microsoft.Compute/galleries/script/versions"),
		// 				ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/galleries/myGalleryName/scripts/myGalleryScriptName/versions/1.0.0"),
		// 				Properties: &armcompute.GalleryScriptVersionProperties{
		// 					PublishingProfile: &armcompute.GalleryScriptVersionPublishingProfile{
		// 						Source: &armcompute.ScriptSource{
		// 							ScriptLink: to.Ptr("https://mystorageaccount.blob.core.windows.net/mycontainer/myScript1.ps1"),
		// 							Parameters: []*armcompute.GalleryScriptParameter{
		// 								{
		// 									Name: to.Ptr("location"),
		// 									Required: to.Ptr(true),
		// 									DefaultValue: to.Ptr("westus"),
		// 									Type: to.Ptr(armcompute.GalleryScriptParameterTypeString),
		// 								},
		// 								{
		// 									Name: to.Ptr("myGalleryScriptParameter1"),
		// 									Required: to.Ptr(true),
		// 									Type: to.Ptr(armcompute.GalleryScriptParameterTypeString),
		// 									DefaultValue: to.Ptr("default value of parameter"),
		// 									Description: to.Ptr("description of the parameter"),
		// 								},
		// 								{
		// 									Name: to.Ptr("myGalleryScriptParameter2"),
		// 									Required: to.Ptr(false),
		// 									Type: to.Ptr(armcompute.GalleryScriptParameterTypeString),
		// 									DefaultValue: to.Ptr("default value of parameter"),
		// 									Description: to.Ptr("description of the parameter"),
		// 								},
		// 								{
		// 									Name: to.Ptr("numberOfUnits"),
		// 									Required: to.Ptr(true),
		// 									Type: to.Ptr(armcompute.GalleryScriptParameterTypeInt),
		// 									DefaultValue: to.Ptr("3"),
		// 									Description: to.Ptr("description of the parameter"),
		// 									MinValue: to.Ptr("1"),
		// 									MaxValue: to.Ptr("5"),
		// 								},
		// 								{
		// 									Name: to.Ptr("weightOfUnit"),
		// 									Required: to.Ptr(true),
		// 									Type: to.Ptr(armcompute.GalleryScriptParameterTypeDouble),
		// 									DefaultValue: to.Ptr("0.6"),
		// 									Description: to.Ptr("description of the parameter"),
		// 									MinValue: to.Ptr("0.1"),
		// 									MaxValue: to.Ptr("2"),
		// 								},
		// 								{
		// 									Name: to.Ptr("typeOfProduct"),
		// 									Required: to.Ptr(false),
		// 									Type: to.Ptr(armcompute.GalleryScriptParameterTypeEnum),
		// 									DefaultValue: to.Ptr("Fruit"),
		// 									Description: to.Ptr("description of the parameter"),
		// 									EnumValues: []*string{
		// 										to.Ptr("Fruit"),
		// 										to.Ptr("Vegetable"),
		// 										to.Ptr("Greens"),
		// 										to.Ptr("Nuts"),
		// 									},
		// 								},
		// 							},
		// 						},
		// 						TargetRegions: []*armcompute.TargetRegion{
		// 							{
		// 								Name: to.Ptr("West US"),
		// 								RegionalReplicaCount: to.Ptr[int32](2),
		// 								StorageAccountType: to.Ptr(armcompute.StorageAccountTypeStandardLRS),
		// 								ExcludeFromLatest: to.Ptr(false),
		// 							},
		// 						},
		// 						ReplicaCount: to.Ptr[int32](2),
		// 						ExcludeFromLatest: to.Ptr(false),
		// 						PublishedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-06-21T17:13:57.5972568+00:00"); return t}()),
		// 						EndOfLifeDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2027-07-01T07:00:00+00:00"); return t}()),
		// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypeStandardLRS),
		// 					},
		// 					SafetyProfile: &armcompute.GalleryScriptVersionSafetyProfile{
		// 						AllowDeletionOfReplicatedLocations: to.Ptr(false),
		// 					},
		// 					ProvisioningState: to.Ptr(armcompute.GalleryProvisioningStateSucceeded),
		// 				},
		// 			},
		// 			{
		// 				Location: to.Ptr("West US"),
		// 				Name: to.Ptr("1.0.1"),
		// 				Type: to.Ptr("Microsoft.Compute/galleries/script/versions"),
		// 				ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/galleries/myGalleryName/scripts/myGalleryScriptName/versions/1.0.1"),
		// 				Properties: &armcompute.GalleryScriptVersionProperties{
		// 					PublishingProfile: &armcompute.GalleryScriptVersionPublishingProfile{
		// 						Source: &armcompute.ScriptSource{
		// 							ScriptLink: to.Ptr("https://mystorageaccount.blob.core.windows.net/mycontainer/myScript2.ps1"),
		// 							Parameters: []*armcompute.GalleryScriptParameter{
		// 								{
		// 									Name: to.Ptr("myGalleryScriptParameter1"),
		// 									Required: to.Ptr(true),
		// 									Type: to.Ptr(armcompute.GalleryScriptParameterTypeString),
		// 									DefaultValue: to.Ptr("default value of parameter"),
		// 									Description: to.Ptr("description of the parameter"),
		// 								},
		// 								{
		// 									Name: to.Ptr("myGalleryScriptParameter2"),
		// 									Required: to.Ptr(false),
		// 									Type: to.Ptr(armcompute.GalleryScriptParameterTypeString),
		// 									DefaultValue: to.Ptr("default value of parameter"),
		// 									Description: to.Ptr("description of the parameter"),
		// 								},
		// 							},
		// 						},
		// 						TargetRegions: []*armcompute.TargetRegion{
		// 							{
		// 								Name: to.Ptr("West US"),
		// 								RegionalReplicaCount: to.Ptr[int32](2),
		// 								StorageAccountType: to.Ptr(armcompute.StorageAccountTypeStandardLRS),
		// 								ExcludeFromLatest: to.Ptr(false),
		// 							},
		// 						},
		// 						ReplicaCount: to.Ptr[int32](2),
		// 						ExcludeFromLatest: to.Ptr(false),
		// 						PublishedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-06-21T17:13:57.5972568+00:00"); return t}()),
		// 						EndOfLifeDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2027-07-01T07:00:00+00:00"); return t}()),
		// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypeStandardLRS),
		// 					},
		// 					SafetyProfile: &armcompute.GalleryScriptVersionSafetyProfile{
		// 						AllowDeletionOfReplicatedLocations: to.Ptr(false),
		// 					},
		// 					ProvisioningState: to.Ptr(armcompute.GalleryProvisioningStateSucceeded),
		// 				},
		// 			},
		// 		},
		// 		NextLink: to.Ptr("https://microsoft.com/nextLinkExample"),
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to list gallery Script Versions in a gallery Script Definition.
 *
 * @summary list gallery Script Versions in a gallery Script Definition.
 * x-ms-original-file: 2025-03-03/galleryScriptExamples/GalleryScriptVersion_ListByGalleryScript.json
 */
async function listGalleryScriptVersionsInAGalleryScriptDefinition() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "{subscription-id}";
  const client = new ComputeManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.galleryScriptVersions.listByGalleryScript(
    "myResourceGroupName",
    "myGalleryName",
    "myGalleryScriptName",
  )) {
    resArray.push(item);
  }

  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/Compute/stable/2025-03-03/examples/galleryScriptExamples/GalleryScriptVersion_ListByGalleryScript.json
// this example is just showing the usage of "GalleryScriptVersions_ListByGalleryScript" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this GalleryScriptResource created on azure
// for more information of creating GalleryScriptResource, please refer to the document of GalleryScriptResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroupName";
string galleryName = "myGalleryName";
string galleryScriptName = "myGalleryScriptName";
ResourceIdentifier galleryScriptResourceId = GalleryScriptResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, galleryName, galleryScriptName);
GalleryScriptResource galleryScript = client.GetGalleryScriptResource(galleryScriptResourceId);

// get the collection of this GalleryScriptVersionResource
GalleryScriptVersionCollection collection = galleryScript.GetGalleryScriptVersions();

// invoke the operation and iterate over the result
await foreach (GalleryScriptVersionResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    GalleryScriptVersionData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "location": "West US",
      "name": "1.0.0",
      "type": "Microsoft.Compute/galleries/script/versions",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/galleries/myGalleryName/scripts/myGalleryScriptName/versions/1.0.0",
      "properties": {
        "publishingProfile": {
          "source": {
            "scriptLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/myScript1.ps1",
            "parameters": [
              {
                "name": "location",
                "required": true,
                "defaultValue": "westus",
                "type": "String"
              },
              {
                "name": "myGalleryScriptParameter1",
                "required": true,
                "type": "String",
                "defaultValue": "default value of parameter",
                "description": "description of the parameter"
              },
              {
                "name": "myGalleryScriptParameter2",
                "required": false,
                "type": "String",
                "defaultValue": "default value of parameter",
                "description": "description of the parameter"
              },
              {
                "name": "numberOfUnits",
                "required": true,
                "type": "Int",
                "defaultValue": "3",
                "description": "description of the parameter",
                "minValue": "1",
                "maxValue": "5"
              },
              {
                "name": "weightOfUnit",
                "required": true,
                "type": "Double",
                "defaultValue": "0.6",
                "description": "description of the parameter",
                "minValue": "0.1",
                "maxValue": "2"
              },
              {
                "name": "typeOfProduct",
                "required": false,
                "type": "Enum",
                "defaultValue": "Fruit",
                "description": "description of the parameter",
                "enumValues": [
                  "Fruit",
                  "Vegetable",
                  "Greens",
                  "Nuts"
                ]
              }
            ]
          },
          "targetRegions": [
            {
              "name": "West US",
              "regionalReplicaCount": 2,
              "storageAccountType": "Standard_LRS",
              "excludeFromLatest": false
            }
          ],
          "replicaCount": 2,
          "excludeFromLatest": false,
          "publishedDate": "2025-06-21T17:13:57.5972568+00:00",
          "endOfLifeDate": "2027-07-01T07:00:00+00:00",
          "storageAccountType": "Standard_LRS"
        },
        "safetyProfile": {
          "allowDeletionOfReplicatedLocations": false
        },
        "provisioningState": "Succeeded"
      }
    },
    {
      "location": "West US",
      "name": "1.0.1",
      "type": "Microsoft.Compute/galleries/script/versions",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/galleries/myGalleryName/scripts/myGalleryScriptName/versions/1.0.1",
      "properties": {
        "publishingProfile": {
          "source": {
            "scriptLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/myScript2.ps1",
            "parameters": [
              {
                "name": "myGalleryScriptParameter1",
                "required": true,
                "type": "String",
                "defaultValue": "default value of parameter",
                "description": "description of the parameter"
              },
              {
                "name": "myGalleryScriptParameter2",
                "required": false,
                "type": "String",
                "defaultValue": "default value of parameter",
                "description": "description of the parameter"
              }
            ]
          },
          "targetRegions": [
            {
              "name": "West US",
              "regionalReplicaCount": 2,
              "storageAccountType": "Standard_LRS",
              "excludeFromLatest": false
            }
          ],
          "replicaCount": 2,
          "excludeFromLatest": false,
          "publishedDate": "2025-06-21T17:13:57.5972568+00:00",
          "endOfLifeDate": "2027-07-01T07:00:00+00:00",
          "storageAccountType": "Standard_LRS"
        },
        "safetyProfile": {
          "allowDeletionOfReplicatedLocations": false
        },
        "provisioningState": "Succeeded"
      }
    }
  ],
  "nextLink": "https://microsoft.com/nextLinkExample"
}

Definitionen

Name	Beschreibung
AdditionalReplicaSet	Beschreibt die zusätzlichen Replikatgruppeninformationen.
AggregatedReplicationState	Dies ist der aggregierte Replikationsstatus basierend auf allen regionalen Replikationsstatuskennzeichnungen.
ApiError	API-Fehler.
ApiErrorBase	API-Fehlerbasis.
CloudError	Eine Fehlerantwort des Computediensts.
ConfidentialVMEncryptionType	Vertrauliche VM-Verschlüsselungstypen
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DataDiskImageEncryption	Enthält Verschlüsselungseinstellungen für ein Datenträgerimage.
EdgeZoneStorageAccountType	Gibt den Speicherkontotyp an, der zum Speichern des Bilds verwendet werden soll. Diese Eigenschaft ist nicht aktualisierbar.
EncryptionImages	Wahlfrei. Ermöglicht Es Benutzern, vom Kunden verwaltete Schlüssel zum Verschlüsseln des Betriebssystems und der Datenträger im Katalogartefakt bereitzustellen.
GalleryExtendedLocation	Der Name des erweiterten Speicherorts.
GalleryExtendedLocationType	Es ist der Typ des erweiterten Speicherorts.
GalleryProvisioningState	Der Bereitstellungsstatus, der nur in der Antwort angezeigt wird.
GalleryScriptParameter	Die Definition eines Parameters, der an ein Skript einer Gallery Script Version weitergegeben werden kann.
GalleryScriptParameterType	Spezifiziert den Typ des Gallery Script-Parameters. Mögliche Werte sind: String, Int, Double, Boolean, Enum
GalleryScriptVersion	Konkrete nachverfolgte Ressourcentypen können durch Aliasen dieses Typs mithilfe eines bestimmten Eigenschaftstyps erstellt werden.
GalleryScriptVersionList	Paged-Sammlung von GalleryScriptVersion-Objekten
GalleryScriptVersionProperties	Beschreibt die Eigenschaften einer Galerie-Skriptversion.
GalleryScriptVersionPublishingProfile	Das Veröffentlichungsprofil einer Katalogbildversion.
GalleryScriptVersionSafetyProfile	Das Sicherheitsprofil der Gallery Script Version.
GalleryTargetExtendedLocation
InnerError	Innere Fehlerdetails.
OSDiskImageEncryption	Enthält Verschlüsselungseinstellungen für ein Betriebssystemdatenträgerimage.
OSDiskImageSecurityProfile	Enthält Sicherheitsprofil für ein Betriebssystemdatenträgerimage.
RegionalReplicationStatus	Dies ist der regionale Replikationsstatus.
ReplicationMode	Optionaler Parameter, der den Modus angibt, der für die Replikation verwendet werden soll. Diese Eigenschaft ist nicht aktualisierbar.
ReplicationState	Dies ist der regionale Replikationsstatus.
ReplicationStatus	Dies ist der Replikationsstatus der Katalogbildversion.
ScriptSource	Das Quellskript, aus dem die Skriptversion erstellt wird.
StorageAccountStrategy	Spezifiziert die Strategie, die bei der Auswahl des Speicherkontotyps verwendet werden soll. Kann nicht zusammen mit storageAccountType angegeben werden, kann aber pro Region durch die Angabe von targetRegions[].storageAccountType überschrieben werden. Diese Eigenschaft ist nicht aktualisierbar.
StorageAccountType	Gibt den Speicherkontotyp an, der zum Speichern des Bilds verwendet werden soll. Diese Eigenschaft ist nicht aktualisierbar.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
TargetRegion	Beschreibt die Zielregioneninformationen.

AdditionalReplicaSet

Objekt

Beschreibt die zusätzlichen Replikatgruppeninformationen.

Name	Typ	Beschreibung
regionalReplicaCount	integer (int32)	Die Anzahl der direkten Laufwerkreplikate der zu erstellenden Imageversion. Diese Eigenschaft ist aktualisierbar
storageAccountType	StorageAccountType	Gibt den Speicherkontotyp an, der zum Erstellen der direkten Laufwerkreplikate verwendet werden soll.

AggregatedReplicationState

Enumeration

Dies ist der aggregierte Replikationsstatus basierend auf allen regionalen Replikationsstatuskennzeichnungen.

Wert	Beschreibung
Unknown
InProgress
Completed
Failed

ApiError

Objekt

API-Fehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	ApiErrorBase[]	Die API-Fehlerdetails
innererror	InnerError	Interner API-Fehler
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

ApiErrorBase

Objekt

API-Fehlerbasis.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

CloudError

Objekt

Eine Fehlerantwort des Computediensts.

Name	Typ	Beschreibung
error	ApiError	API-Fehler.

ConfidentialVMEncryptionType

Enumeration

Vertrauliche VM-Verschlüsselungstypen

Wert	Beschreibung
EncryptedVMGuestStateOnlyWithPmk
EncryptedWithPmk
EncryptedWithCmk
NonPersistedTPM

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

DataDiskImageEncryption

Objekt

Enthält Verschlüsselungseinstellungen für ein Datenträgerimage.

Name	Typ	Beschreibung
diskEncryptionSetId	string	Ein relativer URI, der die Ressourcen-ID des Datenträgerverschlüsselungssatzes enthält.
lun	integer (int32)	Diese Eigenschaft gibt die logische Einheitennummer des Datenträgers an. Dieser Wert wird verwendet, um Datenträger innerhalb des virtuellen Computers zu identifizieren und muss daher für jeden Datenträger eindeutig sein, der an den virtuellen Computer angefügt ist.

EdgeZoneStorageAccountType

Enumeration

Gibt den Speicherkontotyp an, der zum Speichern des Bilds verwendet werden soll. Diese Eigenschaft ist nicht aktualisierbar.

Wert	Beschreibung
Standard_LRS
Standard_ZRS
StandardSSD_LRS
Premium_LRS

EncryptionImages

Objekt

Wahlfrei. Ermöglicht Es Benutzern, vom Kunden verwaltete Schlüssel zum Verschlüsseln des Betriebssystems und der Datenträger im Katalogartefakt bereitzustellen.

Name	Typ	Beschreibung
dataDiskImages	DataDiskImageEncryption[]	Eine Liste der Verschlüsselungsspezifikationen für Datenträgerimages.
osDiskImage	OSDiskImageEncryption	Enthält Verschlüsselungseinstellungen für ein Betriebssystemdatenträgerimage.

GalleryExtendedLocation

Objekt

Der Name des erweiterten Speicherorts.

Name	Typ	Beschreibung
name	string
type	GalleryExtendedLocationType	Es ist der Typ des erweiterten Speicherorts.

GalleryExtendedLocationType

Enumeration

Es ist der Typ des erweiterten Speicherorts.

Wert	Beschreibung
EdgeZone
Unknown

GalleryProvisioningState

Enumeration

Der Bereitstellungsstatus, der nur in der Antwort angezeigt wird.

Wert	Beschreibung
Creating
Updating
Failed
Succeeded
Deleting
Migrating

GalleryScriptParameter

Objekt

Die Definition eines Parameters, der an ein Skript einer Gallery Script Version weitergegeben werden kann.

Name	Typ	Beschreibung
defaultValue	string	Der Standardwert des Parameters gilt nur für Zeichenkettentypen.
description	string	Eine Beschreibung, mit der Benutzer verstehen können, was dieser Parameter bedeutet
enumValues	string[]	Eine Liste zulässiger Werte. Nur anwandbare Werte stammen aus 'Enum'-Werten, die in 'GalleryScriptParameter' definiert sind.
maxValue	string	Der Mindestwert des Parameters.
minValue	string	Der Mindestwert des Parameters.
name	string	Der Name des Parameters.
required	boolean	Gibt an, ob dieser Parameter passiert werden muss.
type	GalleryScriptParameterType	Spezifiziert den Typ des Gallery Script-Parameters. Mögliche Werte sind: String, Int, Double, Boolean, Enum

GalleryScriptParameterType

Enumeration

Spezifiziert den Typ des Gallery Script-Parameters. Mögliche Werte sind: String, Int, Double, Boolean, Enum

Wert	Beschreibung
String	Parametertyp des String-Gallery-Skripts
Int	Int Gallery-Skript-Parametertyp
Double	Double-Gallery-Skriptparametertyp
Boolean	Boolesche Galerie-Skriptparametertyp
Enum	Enum-Galerie-Skriptparametertyp

GalleryScriptVersion

Objekt

Konkrete nachverfolgte Ressourcentypen können durch Aliasen dieses Typs mithilfe eines bestimmten Eigenschaftstyps erstellt werden.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Zum Beispiel - /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	GalleryScriptVersionProperties	Beschreibt die Eigenschaften einer Galerie-Skriptversion.
systemData	systemData	Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

GalleryScriptVersionList

Objekt

Paged-Sammlung von GalleryScriptVersion-Objekten

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link zur nächsten Seite von Elementen
value	GalleryScriptVersion[]	Die GalleryScriptVersion-Einträge auf dieser Seite

GalleryScriptVersionProperties

Objekt

Beschreibt die Eigenschaften einer Galerie-Skriptversion.

Name	Typ	Beschreibung
provisioningState	GalleryProvisioningState	Der Bereitstellungsstatus, der nur in der Antwort angezeigt wird.
publishingProfile	GalleryScriptVersionPublishingProfile	Das Veröffentlichungsprofil einer Katalogbildversion.
replicationStatus	ReplicationStatus	Dies ist der Replikationsstatus der Katalogbildversion.
safetyProfile	GalleryScriptVersionSafetyProfile	Das Sicherheitsprofil der Gallery Script Version.

GalleryScriptVersionPublishingProfile

Objekt

Das Veröffentlichungsprofil einer Katalogbildversion.

Name	Typ	Beschreibung
endOfLifeDate	string (date-time)	Das Ende des Lebenszyklusdatums der Katalogbildversion. Diese Eigenschaft kann für Außerbetriebnahmezwecke verwendet werden. Diese Eigenschaft ist aktualisierbar.
excludeFromLatest	boolean	Wenn dieser Wert auf "true" festgelegt ist, verwenden virtuelle Computer, die aus der neuesten Version der Imagedefinition bereitgestellt wurden, diese Imageversion nicht.
publishedDate	string (date-time)	Der Zeitstempel für die Veröffentlichung der Katalogbildversion.
replicaCount	integer (int32)	Die Anzahl der Replikate der Bildversion, die pro Region erstellt werden soll. Diese Eigenschaft wird für eine Region wirksam, wenn "regionalReplicaCount" nicht angegeben wird. Diese Eigenschaft ist aktualisierbar.
replicationMode	ReplicationMode	Optionaler Parameter, der den Modus angibt, der für die Replikation verwendet werden soll. Diese Eigenschaft ist nicht aktualisierbar.
source	ScriptSource	Das Quellskript, aus dem die Skriptversion erstellt wird.
storageAccountStrategy	StorageAccountStrategy	Spezifiziert die Strategie, die bei der Auswahl des Speicherkontotyps verwendet werden soll. Kann nicht zusammen mit storageAccountType angegeben werden, kann aber pro Region durch die Angabe von targetRegions[].storageAccountType überschrieben werden. Diese Eigenschaft ist nicht aktualisierbar.
storageAccountType	StorageAccountType	Gibt den Speicherkontotyp an, der zum Speichern des Bilds verwendet werden soll. Kann nicht zusammen mit storageAccountStrategy angegeben werden. Diese Eigenschaft ist nicht aktualisierbar.
targetExtendedLocations	GalleryTargetExtendedLocation[]	Die erweiterten Zielspeicherorte, an denen die Bildversion repliziert werden soll. Diese Eigenschaft ist aktualisierbar.
targetRegions	TargetRegion[]	Die Zielbereiche, in denen die Bildversion repliziert werden soll. Diese Eigenschaft ist aktualisierbar.

GalleryScriptVersionSafetyProfile

Objekt

Das Sicherheitsprofil der Gallery Script Version.

Name	Typ	Beschreibung
allowDeletionOfReplicatedLocations	boolean	Gibt an, ob das Entfernen dieser Katalogbildversion aus replizierten Regionen zulässig ist.

GalleryTargetExtendedLocation

Objekt

Name	Typ	Beschreibung
encryption	EncryptionImages	Wahlfrei. Ermöglicht Es Benutzern, vom Kunden verwaltete Schlüssel zum Verschlüsseln des Betriebssystems und der Datenträger im Katalogartefakt bereitzustellen.
extendedLocation	GalleryExtendedLocation	Der Name des erweiterten Speicherorts.
extendedLocationReplicaCount	integer (int32)	Die Anzahl der Replikate der Bildversion, die pro erweiterter Speicherort erstellt werden soll. Diese Eigenschaft ist aktualisierbar.
name	string	Der Name der Region.
storageAccountType	EdgeZoneStorageAccountType	Gibt den Speicherkontotyp an, der zum Speichern des Bilds verwendet werden soll. Diese Eigenschaft ist nicht aktualisierbar.

InnerError

Objekt

Innere Fehlerdetails.

Name	Typ	Beschreibung
errordetail	string	Die interne Fehlermeldung oder das Ausnahmeabbild.
exceptiontype	string	Der Ausnahmetyp.

OSDiskImageEncryption

Objekt

Enthält Verschlüsselungseinstellungen für ein Betriebssystemdatenträgerimage.

Name	Typ	Beschreibung
diskEncryptionSetId	string	Ein relativer URI, der die Ressourcen-ID des Datenträgerverschlüsselungssatzes enthält.
securityProfile	OSDiskImageSecurityProfile	Diese Eigenschaft gibt das Sicherheitsprofil eines Betriebssystemdatenträgerimages an.

OSDiskImageSecurityProfile

Objekt

Enthält Sicherheitsprofil für ein Betriebssystemdatenträgerimage.

Name	Typ	Beschreibung
confidentialVMEncryptionType	ConfidentialVMEncryptionType	Vertrauliche VM-Verschlüsselungstypen
secureVMDiskEncryptionSetId	string	Verschlüsselungssatz-ID für sichere VM-Datenträger

RegionalReplicationStatus

Objekt

Dies ist der regionale Replikationsstatus.

Name	Typ	Beschreibung
details	string	Die Details des Replikationsstatus.
progress	integer (int32)	Er gibt den Fortschritt des Replikationsauftrags an.
region	string	Der Bereich, in den die Katalogbildversion repliziert wird.
state	ReplicationState	Dies ist der regionale Replikationsstatus.

ReplicationMode

Enumeration

Optionaler Parameter, der den Modus angibt, der für die Replikation verwendet werden soll. Diese Eigenschaft ist nicht aktualisierbar.

Wert	Beschreibung
Full
Shallow

ReplicationState

Enumeration

Dies ist der regionale Replikationsstatus.

Wert	Beschreibung
Unknown
Replicating
Completed
Failed

ReplicationStatus

Objekt

Dies ist der Replikationsstatus der Katalogbildversion.

Name	Typ	Beschreibung
aggregatedState	AggregatedReplicationState	Dies ist der aggregierte Replikationsstatus basierend auf allen regionalen Replikationsstatuskennzeichnungen.
summary	RegionalReplicationStatus[]	Dies ist eine Zusammenfassung des Replikationsstatus für jede Region.

ScriptSource

Objekt

Das Quellskript, aus dem die Skriptversion erstellt wird.

Name	Typ	Beschreibung
parameters	GalleryScriptParameter[]	Wahlfrei. Alle Eingabeparameter, die an das Skript übergeben werden müssen und innerhalb des Skripts zur Ausführung abgerufen werden.
scriptLink	string	Erforderlich. Der Link zum Quellskript muss ein lesbarer Speicherblob mit aktivierter SAS-URI oder öffentlich zugänglicher URI oder verwalteter Identität sein.

StorageAccountStrategy

Enumeration

Spezifiziert die Strategie, die bei der Auswahl des Speicherkontotyps verwendet werden soll. Kann nicht zusammen mit storageAccountType angegeben werden, kann aber pro Region durch die Angabe von targetRegions[].storageAccountType überschrieben werden. Diese Eigenschaft ist nicht aktualisierbar.

Wert	Beschreibung
PreferStandard_ZRS	Wählen Sie Standard_ZRS Speicher, wenn die Region ihn unterstützt, andernfalls wählen Sie Standard_LRS Speicher, es sei denn, dies wird durch die Angabe von regionalem SpeicherAccountType überschrieben. Wenn keine storageAccountStrategy angegeben ist, ist dies die Standardstrategie (ab API-Version 2025-03-03).
DefaultStandard_LRS	Wählen Sie Standard_LRS Speicher, sofern nicht durch die Angabe von regionalem SpeicherAccountType überschrieben wird.

StorageAccountType

Enumeration

Gibt den Speicherkontotyp an, der zum Speichern des Bilds verwendet werden soll. Diese Eigenschaft ist nicht aktualisierbar.

Wert	Beschreibung
Standard_LRS
Standard_ZRS
Premium_LRS
PremiumV2_LRS

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.

TargetRegion

Objekt

Beschreibt die Zielregioneninformationen.

Name	Typ	Beschreibung
additionalReplicaSets	AdditionalReplicaSet[]	Liste der Speichersku mit Replikatanzahl zum Erstellen von direkten Laufwerkreplikaten.
encryption	EncryptionImages	Wahlfrei. Ermöglicht Es Benutzern, vom Kunden verwaltete Schlüssel zum Verschlüsseln des Betriebssystems und der Datenträger im Katalogartefakt bereitzustellen.
excludeFromLatest	boolean	Enthält die Kennzeichnungseinstellung, um ein Bild auszublenden, wenn Benutzer version='latest' angeben.
name	string	Der Name der Region.
regionalReplicaCount	integer (int32)	Die Anzahl der Replikate der Bildversion, die pro Region erstellt werden soll. Diese Eigenschaft ist aktualisierbar.
storageAccountType	StorageAccountType	Gibt den Speicherkontotyp an, der zum Speichern des Bilds verwendet werden soll. Diese Eigenschaft ist nicht aktualisierbar.