Freigeben über


Galleries - Create Or Update

Erstellen oder Aktualisieren einer freigegebenen Bildergalerie.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}?api-version=2024-03-03

URI-Parameter

Name In Erforderlich Typ Beschreibung
galleryName
path True

string

Der Name des freigegebenen Bildkatalogs. Die zulässigen Zeichen sind Alphabete und Zahlen mit Punkten und Punkten, die in der Mitte zulässig sind. Die maximale Länge beträgt 80 Zeichen.

resourceGroupName
path True

string

Der Name der Ressourcengruppe.

subscriptionId
path True

string

Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

api-version
query True

string

Client-API-Version.

Anforderungstext

Name Erforderlich Typ Beschreibung
location True

string

Ressourcenspeicherort

identity

GalleryIdentity

Die Identität des Katalogs, falls konfiguriert.

properties.description

string

Die Beschreibung dieser Ressource für freigegebene Bildergalerie. Diese Eigenschaft ist aktualisierbar.

properties.identifier

GalleryIdentifier

Beschreibt den eindeutigen Namen des Katalogs.

properties.sharingProfile

SharingProfile

Profil für die Katalogfreigabe für Abonnement oder Mandant

properties.softDeletePolicy

SoftDeletePolicy

Enthält Informationen zur Richtlinie für das vorläufige Löschen des Katalogs.

tags

object

Ressourcentags

Antworten

Name Typ Beschreibung
200 OK

Gallery

OKAY

201 Created

Gallery

Erstellt

202 Accepted

Gallery

Angenommen

Other Status Codes

CloudError

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

Create a community gallery.
Create or update a simple gallery with sharing profile.
Create or update a simple gallery with soft deletion enabled.
Create or update a simple gallery with system-assigned and user-assigned managed identities.
Create or update a simple gallery.

Create a community gallery.

Beispielanforderung

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName?api-version=2024-03-03

{
  "location": "West US",
  "properties": {
    "description": "This is the gallery description.",
    "sharingProfile": {
      "permissions": "Community",
      "communityGalleryInfo": {
        "publisherUri": "uri",
        "publisherContact": "pir@microsoft.com",
        "eula": "eula",
        "publicNamePrefix": "PirPublic"
      }
    }
  }
}

Beispiel für eine Antwort

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating",
    "sharingProfile": {
      "permissions": "Community",
      "communityGalleryInfo": {
        "publisherUri": "uri",
        "publisherContact": "pir@microsoft.com",
        "eula": "eula",
        "publicNamePrefix": "PirPublic"
      }
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Creating",
    "sharingProfile": {
      "permissions": "Community",
      "communityGalleryInfo": {
        "publisherUri": "uri",
        "publisherContact": "pir@microsoft.com",
        "eula": "eula",
        "publicNamePrefix": "PirPublic"
      }
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating",
    "sharingProfile": {
      "permissions": "Community",
      "communityGalleryInfo": {
        "publisherUri": "uri",
        "publisherContact": "pir@microsoft.com",
        "eula": "eula",
        "publicNamePrefix": "PirPublic"
      }
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}

Beispielanforderung

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName?api-version=2024-03-03

{
  "location": "West US",
  "properties": {
    "description": "This is the gallery description.",
    "sharingProfile": {
      "permissions": "Groups"
    }
  }
}

Beispiel für eine Antwort

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating",
    "sharingProfile": {
      "permissions": "Groups"
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Creating",
    "sharingProfile": {
      "permissions": "Groups"
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating",
    "sharingProfile": {
      "permissions": "Groups"
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}

Beispielanforderung

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName?api-version=2024-03-03

{
  "location": "West US",
  "properties": {
    "description": "This is the gallery description.",
    "softDeletePolicy": {
      "isSoftDeleteEnabled": true
    }
  }
}

Beispiel für eine Antwort

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating",
    "softDeletePolicy": {
      "isSoftDeleteEnabled": true
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Creating",
    "softDeletePolicy": {
      "isSoftDeleteEnabled": true
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating",
    "softDeletePolicy": {
      "isSoftDeleteEnabled": true
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}

Beispielanforderung

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName?api-version=2024-03-03

{
  "location": "West US",
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity": {}
    }
  },
  "properties": {
    "description": "This is the gallery description."
  }
}

Beispiel für eine Antwort

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "userAssignedIdentities": {
      "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity": {}
    }
  },
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating"
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "userAssignedIdentities": {
      "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity": {}
    }
  },
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Creating",
    "softDeletePolicy": {
      "isSoftDeleteEnabled": true
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "userAssignedIdentities": {
      "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity": {}
    }
  },
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating",
    "softDeletePolicy": {
      "isSoftDeleteEnabled": true
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}

Create or update a simple gallery.

Beispielanforderung

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName?api-version=2024-03-03

{
  "location": "West US",
  "properties": {
    "description": "This is the gallery description."
  }
}

Beispiel für eine Antwort

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating"
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Creating"
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating"
  },
  "location": "West US",
  "name": "myGalleryName"
}

Definitionen

Name Beschreibung
ApiError

API-Fehler.

ApiErrorBase

API-Fehlerbasis.

CloudError

Eine Fehlerantwort des Computediensts.

CommunityGalleryInfo

Informationen zum Communitykatalog, wenn der aktuelle Katalog für die Community freigegeben wird

Gallery

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

GalleryIdentifier

Beschreibt den eindeutigen Namen des Katalogs.

GalleryIdentity

Identität für den virtuellen Computer.

GalleryProvisioningState

Der aktuelle Status des Katalog- oder Katalogartefaktes.

GallerySharingPermissionTypes

Mit dieser Eigenschaft können Sie die Berechtigung des Freigabekatalogs angeben. Mögliche Werte sind: Private,Gruppen,Community.

InnerError

Innere Fehlerdetails.

RegionalSharingStatus

Status der regionalen Freigabe des Katalogs

ResourceIdentityType

Der Identitätstyp, der für den Katalog verwendet wird. Der Typ "SystemAssigned, UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Gruppe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Katalog.

SharingProfile

Profil für die Katalogfreigabe für Abonnement oder Mandant

SharingProfileGroup

Gruppe des Katalogfreigabeprofils

SharingProfileGroupTypes

Mit dieser Eigenschaft können Sie den Typ der Freigabegruppe angeben. Mögliche Werte sind: Abonnements,AADTenants.

SharingState

Der Freigabestatus des Katalogs.

SharingStatus

Freigabestatus des aktuellen Katalogs.

SoftDeletePolicy

Enthält Informationen zur Richtlinie für das vorläufige Löschen des Katalogs.

UserAssignedIdentities

Die Liste der Benutzeridentitäten, die dem virtuellen Computer zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

ApiError

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

API-Fehlerbasis.

Name Typ Beschreibung
code

string

Der Fehlercode.

message

string

Die Fehlermeldung.

target

string

Das Ziel des bestimmten Fehlers.

CloudError

Eine Fehlerantwort des Computediensts.

Name Typ Beschreibung
error

ApiError

API-Fehler.

CommunityGalleryInfo

Informationen zum Communitykatalog, wenn der aktuelle Katalog für die Community freigegeben wird

Name Typ Beschreibung
communityGalleryEnabled

boolean

Enthält Informationen dazu, ob die Freigabe des Communitykatalogs aktiviert ist.

eula

string

Lizenzvertrag für Endbenutzer für community gallery image.

publicNamePrefix

string

Das Präfix des Katalognamens, der öffentlich angezeigt wird. Für alle Benutzer sichtbar.

publicNames

string[]

Liste der öffentlichen Namen des Communitykatalogs.

publisherContact

string

Community gallery publisher support email. Die E-Mail-Adresse des Herausgebers. Für alle Benutzer sichtbar.

publisherUri

string

Der Link zur Herausgeberwebsite. Für alle Benutzer sichtbar.

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

Name Typ Beschreibung
id

string

Ressourcen-ID

identity

GalleryIdentity

Die Identität des Katalogs, falls konfiguriert.

location

string

Ressourcenspeicherort

name

string

Ressourcenname

properties.description

string

Die Beschreibung dieser Ressource für freigegebene Bildergalerie. Diese Eigenschaft ist aktualisierbar.

properties.identifier

GalleryIdentifier

Beschreibt den eindeutigen Namen des Katalogs.

properties.provisioningState

GalleryProvisioningState

Der aktuelle Status des Katalog- oder Katalogartefaktes.
Der Bereitstellungsstatus, der nur in der Antwort angezeigt wird.

properties.sharingProfile

SharingProfile

Profil für die Katalogfreigabe für Abonnement oder Mandant

properties.sharingStatus

SharingStatus

Freigabestatus des aktuellen Katalogs.

properties.softDeletePolicy

SoftDeletePolicy

Enthält Informationen zur Richtlinie für das vorläufige Löschen des Katalogs.

tags

object

Ressourcentags

type

string

Ressourcentyp

GalleryIdentifier

Beschreibt den eindeutigen Namen des Katalogs.

Name Typ Beschreibung
uniqueName

string

Der eindeutige Name des freigegebenen Bildkatalogs. Dieser Name wird automatisch von Azure generiert.

GalleryIdentity

Identität für den virtuellen Computer.

Name Typ Beschreibung
principalId

string

Die Prinzipal-ID der Katalogidentität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.

tenantId

string

Die AAD-Mandanten-ID der Katalogidentität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.

type

ResourceIdentityType

Der Identitätstyp, der für den Katalog verwendet wird. Der Typ "SystemAssigned, UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Gruppe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Katalog.

userAssignedIdentities

UserAssignedIdentities

Die Liste der Benutzeridentitäten, die dem Katalog zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

GalleryProvisioningState

Der aktuelle Status des Katalog- oder Katalogartefaktes.

Name Typ Beschreibung
Creating

string

Deleting

string

Failed

string

Migrating

string

Succeeded

string

Updating

string

GallerySharingPermissionTypes

Mit dieser Eigenschaft können Sie die Berechtigung des Freigabekatalogs angeben. Mögliche Werte sind: Private,Gruppen,Community.

Name Typ Beschreibung
Community

string

Groups

string

Private

string

InnerError

Innere Fehlerdetails.

Name Typ Beschreibung
errordetail

string

Die interne Fehlermeldung oder das Ausnahmeabbild.

exceptiontype

string

Der Ausnahmetyp.

RegionalSharingStatus

Status der regionalen Freigabe des Katalogs

Name Typ Beschreibung
details

string

Details zum Fehler bei der regionalen Freigabe des Katalogs.

region

string

Regionsname

state

SharingState

Der Freigabestatus des Katalogs.
Freigabestatus des Katalogs in der aktuellen Region

ResourceIdentityType

Der Identitätstyp, der für den Katalog verwendet wird. Der Typ "SystemAssigned, UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Gruppe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Katalog.

Name Typ Beschreibung
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

SharingProfile

Profil für die Katalogfreigabe für Abonnement oder Mandant

Name Typ Beschreibung
communityGalleryInfo

CommunityGalleryInfo

Informationen des Communitykatalogs, wenn der aktuelle Katalog für die Community freigegeben wird.

groups

SharingProfileGroup[]

Eine Liste der Freigabeprofilgruppen.

permissions

GallerySharingPermissionTypes

Mit dieser Eigenschaft können Sie die Berechtigung des Freigabekatalogs angeben. Mögliche Werte sind: Private,Gruppen,Community.

SharingProfileGroup

Gruppe des Katalogfreigabeprofils

Name Typ Beschreibung
ids

string[]

Eine Liste der Abonnement-/Mandanten-IDs, für die der Katalog freigegeben werden soll.

type

SharingProfileGroupTypes

Mit dieser Eigenschaft können Sie den Typ der Freigabegruppe angeben. Mögliche Werte sind: Abonnements,AADTenants.

SharingProfileGroupTypes

Mit dieser Eigenschaft können Sie den Typ der Freigabegruppe angeben. Mögliche Werte sind: Abonnements,AADTenants.

Name Typ Beschreibung
AADTenants

string

Subscriptions

string

SharingState

Der Freigabestatus des Katalogs.

Name Typ Beschreibung
Failed

string

InProgress

string

Succeeded

string

Unknown

string

SharingStatus

Freigabestatus des aktuellen Katalogs.

Name Typ Beschreibung
aggregatedState

SharingState

Der Freigabestatus des Katalogs.
Aggregierter Freigabestatus des aktuellen Katalogs.

summary

RegionalSharingStatus[]

Zusammenfassung aller regionalen Freigabestatus.

SoftDeletePolicy

Enthält Informationen zur Richtlinie für das vorläufige Löschen des Katalogs.

Name Typ Beschreibung
isSoftDeleteEnabled

boolean

Ermöglicht das vorläufige Löschen von Ressourcen in diesem Katalog, sodass sie innerhalb der Aufbewahrungszeit wiederhergestellt werden können.

UserAssignedIdentities

Die Liste der Benutzeridentitäten, die dem virtuellen Computer zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Name Typ Beschreibung