Images - List By Catalog

服务:

Azure Sphere

API 版本:

2024-04-01

按目录列出图像资源

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/images?api-version=2024-04-01

具有可选参数:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/images?api-version=2024-04-01&$filter={$filter}&$top={$top}&$skip={$skip}&$maxpagesize={$maxpagesize}

URI 参数

名称	在	必需	类型	说明
catalogName	path	True	string pattern: ^[A-Za-z0-9_-]{1,50}$	目录名称
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。
$filter	query		string	使用给定表达式筛选结果列表
$maxpagesize	query		integer (int32)	每个页面的结果项的最大数目。
$skip	query		integer (int32)	要跳过的结果项数。
$top	query		integer (int32)	要返回的结果项数。

响应

名称	类型	说明
200 OK	ImageListResult	Azure作已成功完成。
Other Status Codes	ErrorResponse	意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Images_ListByCatalog

示例请求

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images?api-version=2024-04-01

Java

/**
 * Samples for Images ListByCatalog.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetImages.json
     */
    /**
     * Sample code: Images_ListByCatalog.
     * 
     * @param manager Entry point to AzureSphereManager.
     */
    public static void imagesListByCatalog(com.azure.resourcemanager.sphere.AzureSphereManager manager) {
        manager.images().listByCatalog("MyResourceGroup1", "MyCatalog1", null, null, null, null,
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sphere import AzureSphereMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sphere
# USAGE
    python get_images.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AzureSphereMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.images.list_by_catalog(
        resource_group_name="MyResourceGroup1",
        catalog_name="MyCatalog1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetImages.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armsphere_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/sphere/armsphere"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/09c37754dac91874ff689ed1e60effb4268c8669/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetImages.json
func ExampleImagesClient_NewListByCatalogPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsphere.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewImagesClient().NewListByCatalogPager("MyResourceGroup1", "MyCatalog1", &armsphere.ImagesClientListByCatalogOptions{Filter: nil,
		Top:         nil,
		Skip:        nil,
		Maxpagesize: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ImageListResult = armsphere.ImageListResult{
		// 	Value: []*armsphere.Image{
		// 		{
		// 			Name: to.Ptr("MyImage1"),
		// 			ID: to.Ptr("00000000-0000-0000-0000-000000000001"),
		// 		},
		// 		{
		// 			Name: to.Ptr("MyImage2"),
		// 			ID: to.Ptr("00000000-0000-0000-0000-000000000002"),
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AzureSphereManagementClient } = require("@azure/arm-sphere");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List Image resources by Catalog
 *
 * @summary List Image resources by Catalog
 * x-ms-original-file: specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetImages.json
 */
async function imagesListByCatalog() {
  const subscriptionId =
    process.env["SPHERE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["SPHERE_RESOURCE_GROUP"] || "MyResourceGroup1";
  const catalogName = "MyCatalog1";
  const credential = new DefaultAzureCredential();
  const client = new AzureSphereManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.images.listByCatalog(resourceGroupName, catalogName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sphere;

// Generated from example definition: specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetImages.json
// this example is just showing the usage of "Images_ListByCatalog" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SphereCatalogResource created on azure
// for more information of creating SphereCatalogResource, please refer to the document of SphereCatalogResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "MyResourceGroup1";
string catalogName = "MyCatalog1";
ResourceIdentifier sphereCatalogResourceId = SphereCatalogResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, catalogName);
SphereCatalogResource sphereCatalog = client.GetSphereCatalogResource(sphereCatalogResourceId);

// get the collection of this SphereImageResource
SphereImageCollection collection = sphereCatalog.GetSphereImages();

// invoke the operation and iterate over the result
await foreach (SphereImageResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SphereImageData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:

200

{
  "value": [
    {
      "id": "00000000-0000-0000-0000-000000000001",
      "name": "MyImage1"
    },
    {
      "id": "00000000-0000-0000-0000-000000000002",
      "name": "MyImage2"
    }
  ]
}

定义

名称	说明
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
Image	属于目录资源的图像资源。
ImageListResult	图像列表作的响应。
ImageType	图像类型值。
ProvisioningState	资源预配状态。
RegionalDataBoundary	区域数据边界值。
systemData	与创建和上次修改资源相关的元数据。

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

Image

Object

属于目录资源的图像资源。

名称	类型	说明
id	string	资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties.componentId	string	映像组件 ID。
properties.description	string	图像说明。
properties.image	string	图像创建时显示为 UTF-8 编码的 base 64 字符串。 此字段包含图像读取时的图像 URI。
properties.imageId	string	图像 ID
properties.imageName	string	映像名称
properties.imageType	ImageType	图像类型。
properties.provisioningState	ProvisioningState	上次作的状态。
properties.regionalDataBoundary	RegionalDataBoundary	图像的区域数据边界
properties.uri	string	将图像定位
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ImageListResult

Object

图像列表作的响应。

名称	类型	说明
nextLink	string (uri)	指向下一页项的链接
value	Image[]	此页上的图像项

ImageType

枚举

图像类型值。

值	说明
Applications	应用程序映像类型
BaseSystemUpdateManifest	基本系统更新清单映像类型
BootManifest	启动清单映像类型
CustomerBoardConfig	客户板配置映像类型
CustomerUpdateManifest	客户更新清单映像类型
FirmwareUpdateManifest	固件更新清单映像类型
FwConfig	FW 配置映像类型
InvalidImageType	无效图像。
ManifestSet	清单集映像类型
NormalWorldDtb	普通世界 dtb 图像类型
NormalWorldKernel	普通世界内核映像类型
NormalWorldLoader	普通世界加载程序图像类型
Nwfs	Nwfs 图像类型
OneBl	一个 Bl 图像类型
Other	其他图像类型
PlutonRuntime	冥王星图像类型
Policy	策略映像类型
RecoveryManifest	恢复清单映像类型
RootFs	根 FS 映像类型
SecurityMonitor	安全监视器映像类型
Services	服务映像类型
TrustedKeystore	受信任的密钥存储映像类型
UpdateCertStore	更新证书存储映像类型
WifiFirmware	Wifi 固件映像类型

ProvisioningState

枚举

资源预配状态。

值	说明
Accepted	已接受资源创建请求
Canceled	资源创建已取消。
Deleting	正在删除资源
Failed	资源创建失败。
Provisioning	正在预配资源
Succeeded	已创建资源。
Updating	正在更新资源

RegionalDataBoundary

枚举

区域数据边界值。

值	说明
EU	欧盟数据边界
None	无数据边界

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。