共用方式為


Galleries - Create Or Update

建立或更新共用映像庫。

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

URI 參數

名稱 位於 必要 類型 Description
galleryName
path True

string

共用映像庫的名稱。 允許的字元是字母和數位,中間允許點和句點。 最大長度為80個字元。

resourceGroupName
path True

string

資源群組的名稱。

subscriptionId
path True

string

可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。

api-version
query True

string

用戶端 API 版本。

要求本文

名稱 必要 類型 Description
location True

string

資源位置

identity

GalleryIdentity

如果已設定,則為資源庫的身分識別。

properties.description

string

此共用映像庫資源的描述。 這個屬性是可更新的。

properties.identifier

GalleryIdentifier

描述資源庫的唯一名稱。

properties.sharingProfile

SharingProfile

資源庫共用至訂用帳戶或租使用者的配置檔

properties.softDeletePolicy

SoftDeletePolicy

包含資源庫虛刪除原則的相關信息。

tags

object

資源標籤

回應

名稱 類型 Description
200 OK

Gallery

還行

201 Created

Gallery

創建

202 Accepted

Gallery

接受

Other Status Codes

CloudError

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
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"
}

定義

名稱 Description
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 錯誤。

名稱 類型 Description
code

string

錯誤碼。

details

ApiErrorBase[]

Api 錯誤詳細數據

innererror

InnerError

Api 內部錯誤

message

string

錯誤訊息。

target

string

特定錯誤的目標。

ApiErrorBase

API 錯誤基底。

名稱 類型 Description
code

string

錯誤碼。

message

string

錯誤訊息。

target

string

特定錯誤的目標。

CloudError

來自計算服務的錯誤回應。

名稱 類型 Description
error

ApiError

Api 錯誤。

CommunityGalleryInfo

如果目前資源庫共用給社群,則社群資源庫的資訊

名稱 類型 Description
communityGalleryEnabled

boolean

包含是否啟用社群資源庫共用的相關信息。

eula

string

社群資源庫映像的使用者許可協定。

publicNamePrefix

string

將公開顯示之資源庫名稱的前置詞。 所有使用者都能看見。

publicNames

string[]

社群資源庫公用名稱清單。

publisherContact

string

社群資源庫發行者支持電子郵件。 發行者的電子郵件位址。 所有使用者都能看見。

publisherUri

string

發行者網站的連結。 所有使用者都能看見。

指定您要建立或更新之共用映像庫的相關信息。

名稱 類型 Description
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

描述資源庫的唯一名稱。

名稱 類型 Description
uniqueName

string

共用映像庫的唯一名稱。 Azure 會自動產生此名稱。

GalleryIdentity

虛擬機的身分識別。

名稱 類型 Description
principalId

string

資源庫身分識別的主體標識碼。 此屬性只會針對系統指派的身分識別提供。

tenantId

string

資源庫身分識別的 AAD 租使用者標識碼。 此屬性只會針對系統指派的身分識別提供。

type

ResourceIdentityType

用於資源庫的身分識別類型。 類型 'SystemAssigned, UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從資源庫移除所有身分識別。

userAssignedIdentities

UserAssignedIdentities

與資源庫相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

GalleryProvisioningState

資源庫或資源庫成品的目前狀態。

名稱 類型 Description
Creating

string

Deleting

string

Failed

string

Migrating

string

Succeeded

string

Updating

string

GallerySharingPermissionTypes

這個屬性可讓您指定共用資源庫的許可權。 可能的值為:Private、Groups、Community。

名稱 類型 Description
Community

string

Groups

string

Private

string

InnerError

內部錯誤詳細數據。

名稱 類型 Description
errordetail

string

內部錯誤訊息或例外狀況傾印。

exceptiontype

string

例外狀況類型。

RegionalSharingStatus

資源庫區域共享狀態

名稱 類型 Description
details

string

資源庫區域共用失敗的詳細數據。

region

string

區域名稱

state

SharingState

資源庫的共享狀態。
目前區域中的資源庫共享狀態

ResourceIdentityType

用於資源庫的身分識別類型。 類型 'SystemAssigned, UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從資源庫移除所有身分識別。

名稱 類型 Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

SharingProfile

資源庫共用至訂用帳戶或租使用者的配置檔

名稱 類型 Description
communityGalleryInfo

CommunityGalleryInfo

如果目前資源庫共用給社群,則社群資源庫的資訊。

groups

SharingProfileGroup[]

共用配置檔群組的清單。

permissions

GallerySharingPermissionTypes

這個屬性可讓您指定共用資源庫的許可權。 可能的值為:Private、Groups、Community。

SharingProfileGroup

資源庫共用配置檔的群組

名稱 類型 Description
ids

string[]

資源庫的目標訂用帳戶/租使用者標識符清單。

type

SharingProfileGroupTypes

這個屬性可讓您指定共用群組的類型。 可能的值為:訂用帳戶,AADTenants。

SharingProfileGroupTypes

這個屬性可讓您指定共用群組的類型。 可能的值為:訂用帳戶,AADTenants。

名稱 類型 Description
AADTenants

string

Subscriptions

string

SharingState

資源庫的共享狀態。

名稱 類型 Description
Failed

string

InProgress

string

Succeeded

string

Unknown

string

SharingStatus

目前資源庫的共享狀態。

名稱 類型 Description
aggregatedState

SharingState

資源庫的共享狀態。
目前資源庫的匯總共享狀態。

summary

RegionalSharingStatus[]

所有區域共享狀態的摘要。

SoftDeletePolicy

包含資源庫虛刪除原則的相關信息。

名稱 類型 Description
isSoftDeleteEnabled

boolean

針對此資源庫中的資源啟用虛刪除功能,使其可在保留時間內復原。

UserAssignedIdentities

與虛擬機相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

名稱 類型 Description