Поделиться через


Galleries - Create Or Update

Создайте или обновите общую коллекцию образов.

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

Параметры URI

Имя В Обязательно Тип Описание
galleryName
path True

string

Имя общей коллекции образов. Допустимые символы — это алфавиты и числа с точками и точками, допустимыми в середине. Максимальная длина — 80 символов.

resourceGroupName
path True

string

Имя группы ресурсов.

subscriptionId
path True

string

Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.

api-version
query True

string

Версия клиентского API.

Текст запроса

Имя Обязательно Тип Описание
location True

string

Расположение ресурса

identity

GalleryIdentity

Удостоверение коллекции, если настроено.

properties.description

string

Описание этого ресурса коллекции общих образов. Это свойство является обновляемым.

properties.identifier

GalleryIdentifier

Описывает уникальное имя коллекции.

properties.sharingProfile

SharingProfile

Профиль для общего доступа к коллекции в подписке или клиенте

properties.softDeletePolicy

SoftDeletePolicy

Содержит сведения о политике обратимого удаления коллекции.

tags

object

Теги ресурсов

Ответы

Имя Тип Описание
200 OK

Gallery

ХОРОШО

201 Created

Gallery

Созданный

202 Accepted

Gallery

Принятый

Other Status Codes

CloudError

Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

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.

Образец запроса

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"
      }
    }
  }
}

Пример ответа

{
  "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"
}

Образец запроса

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"
    }
  }
}

Пример ответа

{
  "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"
}

Образец запроса

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
    }
  }
}

Пример ответа

{
  "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"
}

Образец запроса

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."
  }
}

Пример ответа

{
  "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.

Образец запроса

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."
  }
}

Пример ответа

{
  "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"
}

Определения

Имя Описание
ApiError

Ошибка API.

ApiErrorBase

База ошибок API.

CloudError

Ответ на ошибку из службы вычислений.

CommunityGalleryInfo

Сведения о коллекции сообщества, если текущая коллекция предоставлена сообществу

Gallery

Указывает сведения о общей коллекции образов, которую вы хотите создать или обновить.

GalleryIdentifier

Описывает уникальное имя коллекции.

GalleryIdentity

Удостоверение виртуальной машины.

GalleryProvisioningState

Текущее состояние артефакта коллекции или коллекции.

GallerySharingPermissionTypes

Это свойство позволяет указать разрешение на общий доступ к коллекции. Возможные значения: private,Groups,Community.

InnerError

Сведения о внутренней ошибке.

RegionalSharingStatus

Состояние регионального общего доступа коллекции

ResourceIdentityType

Тип удостоверения, используемого для коллекции. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип None удаляет все удостоверения из коллекции.

SharingProfile

Профиль для общего доступа к коллекции в подписке или клиенте

SharingProfileGroup

Группа профиля общего доступа к коллекции

SharingProfileGroupTypes

Это свойство позволяет указать тип группы общего доступа. Возможные значения: подписки,AADTenants.

SharingState

Состояние общего доступа коллекции.

SharingStatus

Общий доступ к состоянию текущей коллекции.

SoftDeletePolicy

Содержит сведения о политике обратимого удаления коллекции.

UserAssignedIdentities

Список удостоверений пользователей, связанных с виртуальной машиной. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

ApiError

Ошибка API.

Имя Тип Описание
code

string

Код ошибки.

details

ApiErrorBase[]

Сведения об ошибке API

innererror

InnerError

Внутренняя ошибка API

message

string

Сообщение об ошибке.

target

string

Целевой объект конкретной ошибки.

ApiErrorBase

База ошибок API.

Имя Тип Описание
code

string

Код ошибки.

message

string

Сообщение об ошибке.

target

string

Целевой объект конкретной ошибки.

CloudError

Ответ на ошибку из службы вычислений.

Имя Тип Описание
error

ApiError

Ошибка API.

CommunityGalleryInfo

Сведения о коллекции сообщества, если текущая коллекция предоставлена сообществу

Имя Тип Описание
communityGalleryEnabled

boolean

Содержит сведения о том, включен ли общий доступ к коллекции сообщества.

eula

string

Лицензионное соглашение конечного пользователя для образа коллекции сообщества.

publicNamePrefix

string

Префикс имени коллекции, который будет отображаться публично. Видимый всем пользователям.

publicNames

string[]

Список общедоступных имен коллекции сообщества.

publisherContact

string

Издатель коллекции сообщества поддерживает электронную почту. Адрес электронной почты издателя. Видимый всем пользователям.

publisherUri

string

Ссылка на веб-сайт издателя. Видимый всем пользователям.

Указывает сведения о общей коллекции образов, которую вы хотите создать или обновить.

Имя Тип Описание
id

string

Идентификатор ресурса

identity

GalleryIdentity

Удостоверение коллекции, если настроено.

location

string

Расположение ресурса

name

string

Имя ресурса

properties.description

string

Описание этого ресурса коллекции общих образов. Это свойство является обновляемым.

properties.identifier

GalleryIdentifier

Описывает уникальное имя коллекции.

properties.provisioningState

GalleryProvisioningState

Текущее состояние артефакта коллекции или коллекции.
Состояние подготовки, которое отображается только в ответе.

properties.sharingProfile

SharingProfile

Профиль для общего доступа к коллекции в подписке или клиенте

properties.sharingStatus

SharingStatus

Общий доступ к состоянию текущей коллекции.

properties.softDeletePolicy

SoftDeletePolicy

Содержит сведения о политике обратимого удаления коллекции.

tags

object

Теги ресурсов

type

string

Тип ресурса

GalleryIdentifier

Описывает уникальное имя коллекции.

Имя Тип Описание
uniqueName

string

Уникальное имя общей коллекции образов. Это имя создается автоматически в Azure.

GalleryIdentity

Удостоверение виртуальной машины.

Имя Тип Описание
principalId

string

Идентификатор субъекта удостоверения коллекции. Это свойство будет предоставлено только для назначаемого системой удостоверения.

tenantId

string

Идентификатор клиента AAD удостоверения коллекции. Это свойство будет предоставлено только для назначаемого системой удостоверения.

type

ResourceIdentityType

Тип удостоверения, используемого для коллекции. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип None удаляет все удостоверения из коллекции.

userAssignedIdentities

UserAssignedIdentities

Список удостоверений пользователей, связанных с коллекцией. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

GalleryProvisioningState

Текущее состояние артефакта коллекции или коллекции.

Имя Тип Описание
Creating

string

Deleting

string

Failed

string

Migrating

string

Succeeded

string

Updating

string

GallerySharingPermissionTypes

Это свойство позволяет указать разрешение на общий доступ к коллекции. Возможные значения: private,Groups,Community.

Имя Тип Описание
Community

string

Groups

string

Private

string

InnerError

Сведения о внутренней ошибке.

Имя Тип Описание
errordetail

string

Внутреннее сообщение об ошибке или дамп исключений.

exceptiontype

string

Тип исключения.

RegionalSharingStatus

Состояние регионального общего доступа коллекции

Имя Тип Описание
details

string

Сведения о сбое регионального общего доступа коллекции.

region

string

Имя региона

state

SharingState

Состояние общего доступа коллекции.
Состояние общего доступа к коллекции в текущем регионе

ResourceIdentityType

Тип удостоверения, используемого для коллекции. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип None удаляет все удостоверения из коллекции.

Имя Тип Описание
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

SharingProfile

Профиль для общего доступа к коллекции в подписке или клиенте

Имя Тип Описание
communityGalleryInfo

CommunityGalleryInfo

Сведения о коллекции сообщества, если текущая коллекция предоставлена сообществу.

groups

SharingProfileGroup[]

Список групп профилей общего доступа.

permissions

GallerySharingPermissionTypes

Это свойство позволяет указать разрешение на общий доступ к коллекции. Возможные значения: private,Groups,Community.

SharingProfileGroup

Группа профиля общего доступа к коллекции

Имя Тип Описание
ids

string[]

Список идентификаторов подписки или клиента, для которой требуется предоставить общий доступ к коллекции.

type

SharingProfileGroupTypes

Это свойство позволяет указать тип группы общего доступа. Возможные значения: подписки,AADTenants.

SharingProfileGroupTypes

Это свойство позволяет указать тип группы общего доступа. Возможные значения: подписки,AADTenants.

Имя Тип Описание
AADTenants

string

Subscriptions

string

SharingState

Состояние общего доступа коллекции.

Имя Тип Описание
Failed

string

InProgress

string

Succeeded

string

Unknown

string

SharingStatus

Общий доступ к состоянию текущей коллекции.

Имя Тип Описание
aggregatedState

SharingState

Состояние общего доступа коллекции.
Агрегированное состояние общего доступа текущей коллекции.

summary

RegionalSharingStatus[]

Сводка по всем состояниям регионального общего доступа.

SoftDeletePolicy

Содержит сведения о политике обратимого удаления коллекции.

Имя Тип Описание
isSoftDeleteEnabled

boolean

Включает обратимое удаление ресурсов в этой коллекции, что позволяет восстановить их в течение срока хранения.

UserAssignedIdentities

Список удостоверений пользователей, связанных с виртуальной машиной. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Имя Тип Описание