你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Gallery Items - Get

服务:: Azure Stack Admin

API 版本:: 2015-04-01

获取特定的库项。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/microsoft.gallery.admin/galleryItems/{galleryItemName}?api-version=2015-04-01

URI 参数

名称	在	必需	类型	说明
galleryItemName	path	True	string	库项的标识。包括发布者名称、项名称，并且可以包含按句点字符分隔的版本。
subscriptionId	path	True	string	唯一标识Microsoft Azure 订阅的订阅凭据。订阅 ID 构成了每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	GalleryItem	还行
404 Not Found		未找到

安全性

azure_auth

授权使用 Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Get a specific gallery item.

示例请求

HTTP

GET https://management.azure.com/subscriptions/0ff0bbbe-d68d-4314-8f68-80a808b5a6ec/providers/microsoft.gallery.admin/galleryItems/Microsoft.DSC-arm.2.0.7?api-version=2015-04-01

示例响应

状态代码:: 200

{
  "id": "/subscriptions/0ff0bbbe-d68d-4314-8f68-80a808b5a6ec/providers/Microsoft.Gallery.Admin/galleryItems/Microsoft.DSC-arm.2.0.7",
  "name": "Microsoft.DSC-arm.2.0.7",
  "type": "Microsoft.Gallery.Admin/galleryItems",
  "properties": {
    "identity": "Microsoft.DSC-arm.2.0.7",
    "publisher": "Microsoft",
    "publisherDisplayName": "Microsoft Corp.",
    "itemName": "DSC-arm",
    "itemDisplayName": "PowerShell Desired State Configuration",
    "version": "2.0.7",
    "summary": "PowerShell Desired State Configuration",
    "longSummary": "PowerShell Desired State Configuration",
    "description": "<p>DSC is a management platform in Windows PowerShell that enables deploying and managing configuration data for software services and managing the environment in which these services run.\r\nDSC provides a set of Windows PowerShell language extensions, new Windows PowerShell cmdlets, and resources that you can use to declaratively specify how you want your software environment to be configured. It also provides a means to maintain and manage existing configurations.</p>",
    "uiDefinitionUri": "https://adminportal.local.azurestack.external:30015/artifact/20161101/Microsoft.DSC-arm.2.0.7/UIDefinition.json",
    "createdTime": "2017-09-29T01:48:54.6612587Z",
    "changedTime": "2017-09-29T01:48:54.6618173Z",
    "itemType": "GalleryItem",
    "categoryIds": [
      "compute-vmextension-windows"
    ],
    "screenshotUris": [],
    "links": [
      {
        "id": "0",
        "displayName": "Learn more about PowerShell DSC",
        "uri": "http://technet.microsoft.com/library/dn249912.aspx"
      }
    ],
    "filters": [],
    "iconFileUris": {
      "small": "https://adminportal.local.azurestack.external:30015/artifact/20161101/Microsoft.DSC-arm.2.0.7/icons/Small.png",
      "medium": "https://adminportal.local.azurestack.external:30015/artifact/20161101/Microsoft.DSC-arm.2.0.7/icons/Medium.png",
      "large": "https://adminportal.local.azurestack.external:30015/artifact/20161101/Microsoft.DSC-arm.2.0.7/icons/Large.png",
      "wide": "https://adminportal.local.azurestack.external:30015/artifact/20161101/Microsoft.DSC-arm.2.0.7/icons/Wide.png"
    },
    "artifacts": [
      {
        "name": "MainTemplate",
        "uri": "https://adminportal.local.azurestack.external:30015/artifact/20161101/Microsoft.DSC-arm.2.0.7/DeploymentTemplates/MainTemplate.json",
        "type": "template"
      },
      {
        "name": "CreateUiDefinition",
        "uri": "https://adminportal.local.azurestack.external:30015/artifact/20161101/Microsoft.DSC-arm.2.0.7/DeploymentTemplates/CreateUiDefinition.json",
        "type": "custom"
      }
    ],
    "metadata": {},
    "properties": {},
    "images": [
      {
        "context": "ibiza",
        "items": [
          {
            "id": "small",
            "uri": "https://adminportal.local.azurestack.external:30015/artifact/20161101/Microsoft.DSC-arm.2.0.7/icons/Small.png",
            "type": "icon"
          },
          {
            "id": "medium",
            "uri": "https://adminportal.local.azurestack.external:30015/artifact/20161101/Microsoft.DSC-arm.2.0.7/icons/Medium.png",
            "type": "icon"
          },
          {
            "id": "large",
            "uri": "https://adminportal.local.azurestack.external:30015/artifact/20161101/Microsoft.DSC-arm.2.0.7/icons/Large.png",
            "type": "icon"
          },
          {
            "id": "wide",
            "uri": "https://adminportal.local.azurestack.external:30015/artifact/20161101/Microsoft.DSC-arm.2.0.7/icons/Wide.png",
            "type": "icon"
          }
        ]
      }
    ],
    "products": [],
    "definitionTemplates": {
      "uiDefinitionFileUri": "https://adminportal.local.azurestack.external:30015/artifact/20161101/Microsoft.DSC-arm.2.0.7/UIDefinition.json",
      "defaultDeploymentTemplateId": "MainTemplate",
      "deploymentTemplateFileUris": {
        "MainTemplate": "https://adminportal.local.azurestack.external:30015/artifact/20161101/Microsoft.DSC-arm.2.0.7/DeploymentTemplates/MainTemplate.json",
        "CreateUiDefinition": "https://adminportal.local.azurestack.external:30015/artifact/20161101/Microsoft.DSC-arm.2.0.7/DeploymentTemplates/CreateUiDefinition.json"
      },
      "deploymentFragmentFileUris": {}
    },
    "additionalProperties": {}
  }
}

状态代码:: 404

定义

名称	说明
Artifact	表示库项项目。
ArtifactType	项目类型。
DefinitionTemplates	保存 UI 定义文件 URI 和部署模板文件 URI。
Filter	表示筛选器项。
GalleryItem	库项的属性。
GalleryItemMenuReferenceType	描述库项的类型，即 GalleryItem 或 ItemGroup。
IconFileUris	图标文件的 URI。
Image	表示图像项。
ImageGroup	图像组。
LinkProperties	表示从库项包读取的链接项。
MarketingMaterial	库项的营销材料。
OfferDetails	表示从库项包读取的产品/服务详细信息项。
OpenProperty	用于定义动态属性的打开类型。
Plan	表示从库项包读取的计划项。
Product	表示从库项包读取的产品项。

Artifact

Object

表示库项项目。

名称	类型	说明
name	string	项目的名称。
type	ArtifactType	项目类型。
uri	string	项目的 URI。

ArtifactType

枚举

项目类型。

值	说明
template
fragment
custom
metadata

DefinitionTemplates

Object

保存 UI 定义文件 URI 和部署模板文件 URI。

名称	类型	说明
defaultDeploymentTemplateId	string	默认部署模板 ID。
deploymentFragmentFileUris	object	包含包清单中定义的部署片段文件 ID 的键值对列表。
deploymentTemplateFileUris	object	包含包清单中定义的部署模板文件 ID 的键值列表。
uiDefinitionFileUri	string	UI 定义文件 URI。

Filter

Object

表示筛选器项。

名称	类型	说明
type	string	筛选器类型。
value	string	筛选值。

GalleryItem

Object

库项的属性。

名称	类型	说明
id	string	资源的 URI。
location	string	资源的位置。
name	string	资源的名称。
properties.additionalProperties	object	为项提供的其他属性的列表。
properties.artifacts	Artifact[]	库项的项目列表。
properties.categoryIds	string[]	库项所属的类别 ID 列表。
properties.changedTime	string (date-time)	库项的上次更新时间。
properties.createdTime	string (date-time)	创建库项的日期和时间。
properties.definitionTemplates	DefinitionTemplates	库项的定义模板。
properties.description	string	库项的说明。
properties.filters	Filter[]	库项的筛选器列表。
properties.iconFileUris	IconFileUris	图标文件的 URI。
properties.identity	string	库项的标识。
properties.images	ImageGroup[]	图像列表。
properties.itemDisplayName	string	门户中显示的名称。
properties.itemName	string	库项的显示名称，请求的区域设置。
properties.itemType	GalleryItemMenuReferenceType	描述库项的类型，即 GalleryItem 或 ItemGroup。
properties.links	LinkProperties[]	为项目提供的链接。
properties.longSummary	string	库项的长摘要。
properties.marketingMaterial	MarketingMaterial	库项的营销材料。
properties.metadata	OpenProperty	自定义项元数据。
properties.products	Product[]	产品列表。
properties.properties	object	为库项提供的属性列表。
properties.publisher	string	库项的发布者。
properties.publisherDisplayName	string	发布者的显示名称。
properties.resourceGroupName	string	库项也属于资源组名称。
properties.screenshotUris	string[]	为项提供的屏幕截图图像 URI 列表。
properties.summary	string	库项的简短摘要。
properties.uiDefinitionUri	string	视图定义对象的 URL，该对象定义定义创建库项资源定义的实例时使用的 UI 信息。
properties.version	string	库项的版本标识符，采用 Major.Minor.Build 格式。
tags	object	键值对的列表。
type	string	资源的类型。

GalleryItemMenuReferenceType

枚举

描述库项的类型，即 GalleryItem 或 ItemGroup。

值	说明
GalleryItem
ItemGroup

IconFileUris

Object

图标文件的 URI。

名称	类型	说明
hero	string	主图标的 URI。
large	string	大图标的 URI。
medium	string	媒体图标的 URI。
small	string	小图标的 URI。
wide	string	宽图标的 URI。

Image

Object

表示图像项。

名称	类型	说明
id	string	映像的 ID。
type	string	图像的类型。
uri	string	映像的 URI。

ImageGroup

Object

图像组。

名称	类型	说明
context	string	图像组标识符。
items	Image[]	图像列表。

LinkProperties

Object

表示从库项包读取的链接项。

名称	类型	说明
displayName	string	链接的显示名称。
id	string	链接的 ID。
uri	string	链接的 URI。

MarketingMaterial

Object

库项的营销材料。

名称	类型	说明
learnUri	string	教育材料 URI。
path	string	营销网站的路径。

OfferDetails

Object

表示从库项包读取的产品/服务详细信息项。

名称	类型	说明
offerId	string	产品/服务标识符。
plans	Plan[]	产品/服务可用的计划列表。
publisherId	string	发布者标识符。

OpenProperty

Object

用于定义动态属性的打开类型。

名称	类型	说明
properties	object	动态属性的字典。

Plan

Object

表示从库项包读取的计划项。

名称	类型	说明
description	string	计划的说明。
displayName	string	计划的显示名称。
planId	string	计划标识符。
summary	string	计划的摘要。

Product

Object

表示从库项包读取的产品项。

名称	类型	说明
displayName	string	产品的显示名称。
legalTerms	string	产品的法律条款。
legalTermsUri	string	产品法律条款的 URI。
offerDetails	OfferDetails	产品/服务详细信息。
pricingDetailsUri	string	产品的定价详细信息的 URI。
privacyPolicy	string	产品的隐私策略。
privacyPolicyUri	string	产品的隐私策略的 URI。
publisherDisplayName	string	产品的发布者显示名称。

通过

Gallery Items - Get

URI 参数

响应

安全性

azure_auth

作用域

示例

Get a specific gallery item.

示例请求

示例响应

定义

Artifact

ArtifactType

DefinitionTemplates

Filter

GalleryItem

GalleryItemMenuReferenceType

IconFileUris

Image

ImageGroup

LinkProperties

MarketingMaterial

OfferDetails

OpenProperty

Plan

Product