次の方法で共有


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 サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。

api-version
query True

string

クライアント API のバージョン。

要求本文

名前 必須 説明
location True

string

リソースの場所

identity

GalleryIdentity

ギャラリーの ID (構成されている場合)。

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

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 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

仮想マシンの ID。

GalleryProvisioningState

ギャラリーまたはギャラリー成果物の現在の状態。

GallerySharingPermissionTypes

このプロパティを使用すると、共有ギャラリーのアクセス許可を指定できます。 使用可能な値は、Private、グループ、Community です。

InnerError

内部エラーの詳細。

RegionalSharingStatus

ギャラリーの地域共有の状態

ResourceIdentityType

ギャラリーに使用される ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、ギャラリーからすべての ID を削除します。

SharingProfile

サブスクリプションまたはテナントへのギャラリー共有のプロファイル

SharingProfileGroup

ギャラリー共有プロファイルのグループ

SharingProfileGroupTypes

このプロパティを使用すると、共有グループの種類を指定できます。 使用可能な値は、サブスクリプション、AADTenants です。

SharingState

ギャラリーの共有状態。

SharingStatus

現在のギャラリーの共有状態。

SoftDeletePolicy

ギャラリーの論理的な削除ポリシーに関する情報が含まれています。

UserAssignedIdentities

仮想マシンに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

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

発行元の Web サイトへのリンク。 すべてのユーザーに表示されます。

作成または更新する共有イメージ ギャラリーに関する情報を指定します。

名前 説明
id

string

リソース ID

identity

GalleryIdentity

ギャラリーの ID (構成されている場合)。

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

仮想マシンの ID。

名前 説明
principalId

string

ギャラリー ID のプリンシパル ID。 このプロパティは、システム割り当て ID にのみ提供されます。

tenantId

string

ギャラリー ID の AAD テナント ID。 このプロパティは、システム割り当て ID にのみ提供されます。

type

ResourceIdentityType

ギャラリーに使用される ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、ギャラリーからすべての ID を削除します。

userAssignedIdentities

UserAssignedIdentities

ギャラリーに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

GalleryProvisioningState

ギャラリーまたはギャラリー成果物の現在の状態。

名前 説明
Creating

string

Deleting

string

Failed

string

Migrating

string

Succeeded

string

Updating

string

GallerySharingPermissionTypes

このプロパティを使用すると、共有ギャラリーのアクセス許可を指定できます。 使用可能な値は、Private、グループ、Community です。

名前 説明
Community

string

Groups

string

Private

string

InnerError

内部エラーの詳細。

名前 説明
errordetail

string

内部エラー メッセージまたは例外ダンプ。

exceptiontype

string

例外の種類。

RegionalSharingStatus

ギャラリーの地域共有の状態

名前 説明
details

string

ギャラリーのリージョン共有エラーの詳細。

region

string

リージョン名

state

SharingState

ギャラリーの共有状態。
現在のリージョンのギャラリー共有状態

ResourceIdentityType

ギャラリーに使用される ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、ギャラリーからすべての ID を削除します。

名前 説明
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

SharingProfile

サブスクリプションまたはテナントへのギャラリー共有のプロファイル

名前 説明
communityGalleryInfo

CommunityGalleryInfo

現在のギャラリーがコミュニティと共有されている場合のコミュニティ ギャラリーの情報。

groups

SharingProfileGroup[]

共有プロファイル グループの一覧。

permissions

GallerySharingPermissionTypes

このプロパティを使用すると、共有ギャラリーのアクセス許可を指定できます。 使用可能な値は、Private、グループ、Community です。

SharingProfileGroup

ギャラリー共有プロファイルのグループ

名前 説明
ids

string[]

ギャラリーが共有を目的としているサブスクリプション/テナント ID の一覧。

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

仮想マシンに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

名前 説明