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

Application Package - List

Service:

Batch Management

API Version:

2024-02-01

Lists指定应用程序中的所有应用程序包。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions?api-version=2024-02-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions?maxresults={maxresults}&api-version=2024-02-01

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string	Batch 帐户的名称。 Regex pattern: ^[a-zA-Z0-9]+$
applicationName	path	True	string	应用程序的名称。 这在帐户中必须是唯一的。 Regex pattern: ^[a-zA-Z0-9_-]+$
resourceGroupName	path	True	string	包含 Batch 帐户的资源组的名称。
subscriptionId	path	True	string	Azure 订阅 ID。 这是 GUID 格式的字符串 (例如 00000000-0000-0000-0000-0000-0000000000000)
api-version	query	True	string	要与 HTTP 请求一起使用的 API 版本。
maxresults	query		integer int32	响应中要返回的最大项数。

响应

名称	类型	说明
200 OK	ListApplicationPackagesResult	操作成功。 响应包含与指定应用程序关联的应用程序包实体的列表。
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

azure_auth

Microsoft Entra OAuth 2.0 身份验证代码流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

ApplicationPackageList

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions?api-version=2024-02-01

Java

/**
 * Samples for ApplicationPackage List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/ApplicationPackageList.json
     */
    /**
     * Sample code: ApplicationPackageList.
     * 
     * @param manager Entry point to BatchManager.
     */
    public static void applicationPackageList(com.azure.resourcemanager.batch.BatchManager manager) {
        manager.applicationPackages().list("default-azurebatch-japaneast", "sampleacct", "app1", 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.batch import BatchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-batch
# USAGE
    python application_package_list.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 = BatchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.application_package.list(
        resource_group_name="default-azurebatch-japaneast",
        account_name="sampleacct",
        application_name="app1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/ApplicationPackageList.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 armbatch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/batch/armbatch/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/ApplicationPackageList.json
func ExampleApplicationPackageClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbatch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewApplicationPackageClient().NewListPager("default-azurebatch-japaneast", "sampleacct", "app1", &armbatch.ApplicationPackageClientListOptions{Maxresults: 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.ListApplicationPackagesResult = armbatch.ListApplicationPackagesResult{
		// 	Value: []*armbatch.ApplicationPackage{
		// 		{
		// 			Name: to.Ptr("1.0"),
		// 			Type: to.Ptr("Microsoft.Batch/batchAccounts/applications/versions"),
		// 			Etag: to.Ptr("W/\"0x8D64FF0B9F47F67\""),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1.0"),
		// 			Properties: &armbatch.ApplicationPackageProperties{
		// 				State: to.Ptr(armbatch.PackageStatePending),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("2.0"),
		// 			Type: to.Ptr("Microsoft.Batch/batchAccounts/applications/versions"),
		// 			Etag: to.Ptr("W/\"0x8D64FF0B9F47F67\""),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/2.0"),
		// 			Properties: &armbatch.ApplicationPackageProperties{
		// 				Format: to.Ptr("zip"),
		// 				LastActivationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-27T18:48:09.933Z"); return t}()),
		// 				State: to.Ptr(armbatch.PackageStateActive),
		// 			},
		// 	}},
		// }
	}
}

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 { BatchManagementClient } = require("@azure/arm-batch");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists all of the application packages in the specified application.
 *
 * @summary Lists all of the application packages in the specified application.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/ApplicationPackageList.json
 */
async function applicationPackageList() {
  const subscriptionId = process.env["BATCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["BATCH_RESOURCE_GROUP"] || "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const applicationName = "app1";
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.applicationPackageOperations.list(
    resourceGroupName,
    accountName,
    applicationName,
  )) {
    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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Batch;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/ApplicationPackageList.json
// this example is just showing the usage of "ApplicationPackage_List" 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 BatchApplicationResource created on azure
// for more information of creating BatchApplicationResource, please refer to the document of BatchApplicationResource
string subscriptionId = "subid";
string resourceGroupName = "default-azurebatch-japaneast";
string accountName = "sampleacct";
string applicationName = "app1";
ResourceIdentifier batchApplicationResourceId = BatchApplicationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, applicationName);
BatchApplicationResource batchApplication = client.GetBatchApplicationResource(batchApplicationResourceId);

// get the collection of this BatchApplicationPackageResource
BatchApplicationPackageCollection collection = batchApplication.GetBatchApplicationPackages();

// invoke the operation and iterate over the result
await foreach (BatchApplicationPackageResource 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
    BatchApplicationPackageData 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

Sample Response

Status code:

200

{
  "value": [
    {
      "type": "Microsoft.Batch/batchAccounts/applications/versions",
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1.0",
      "name": "1.0",
      "etag": "W/\"0x8D64FF0B9F47F67\"",
      "properties": {
        "state": "Pending"
      }
    },
    {
      "type": "Microsoft.Batch/batchAccounts/applications/versions",
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/2.0",
      "name": "2.0",
      "etag": "W/\"0x8D64FF0B9F47F67\"",
      "properties": {
        "state": "Active",
        "format": "zip",
        "lastActivationTime": "2017-06-27T18:48:09.9330991Z"
      }
    }
  ]
}

定义

名称	说明
ApplicationPackage	表示应用程序的特定版本的应用程序包。
CloudError	Batch 服务的错误响应。
CloudErrorBody	Batch 服务的错误响应。
ListApplicationPackagesResult	执行列表应用程序包的结果。
PackageState	应用程序包的当前状态。

ApplicationPackage

表示应用程序的特定版本的应用程序包。

名称	类型	说明
etag	string	资源的 ETag，用于并发语句。
id	string	资源的 ID。
name	string	资源的名称。
properties.format	string	应用程序包的格式（如果包处于活动状态）。
properties.lastActivationTime	string	上次激活包的时间（如果包处于活动状态）。
properties.state	PackageState	应用程序包的当前状态。
properties.storageUrl	string	Azure 存储中应用程序包的 URL。
properties.storageUrlExpiry	string	Azure 存储 URL 到期的 UTC 时间。
type	string	资源类型。

CloudError

Batch 服务的错误响应。

名称	类型	说明
error	CloudErrorBody	错误响应的正文。

CloudErrorBody

Batch 服务的错误响应。

名称	类型	说明
code	string	错误的标识符。 代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，该消息适用于在用户界面中显示。
target	string	特定错误的目标。 例如，属性的名称出错。

ListApplicationPackagesResult

执行列表应用程序包的结果。

名称	类型	说明
nextLink	string	用于获取下一组结果的 URL。
value	ApplicationPackage[]	应用程序包的列表。

PackageState

应用程序包的当前状态。

名称	类型	说明
Active	string	应用程序包已准备就绪，可供使用。
Pending	string	应用程序包已创建，但尚未激活。