Standby Container Group Pools - List By Subscription

服务:

Standby Pools

API 版本:

2025-03-01

按订阅 ID 列出 StandbyContainerGroupPoolResource 资源

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.StandbyPool/standbyContainerGroupPools?api-version=2025-03-01

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

响应

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

StandbyContainerGroupPools_ListBySubscription

示例请求

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000009/providers/Microsoft.StandbyPool/standbyContainerGroupPools?api-version=2025-03-01

Java

/**
 * Samples for StandbyContainerGroupPools List.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-03-01/StandbyContainerGroupPools_ListBySubscription.json
     */
    /**
     * Sample code: StandbyContainerGroupPools_ListBySubscription.
     * 
     * @param manager Entry point to StandbyPoolManager.
     */
    public static void
        standbyContainerGroupPoolsListBySubscription(com.azure.resourcemanager.standbypool.StandbyPoolManager manager) {
        manager.standbyContainerGroupPools().list(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.standbypool import StandbyPoolMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-standbypool
# USAGE
    python standby_container_group_pools_list_by_subscription.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 = StandbyPoolMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.standby_container_group_pools.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: 2025-03-01/StandbyContainerGroupPools_ListBySubscription.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 armstandbypool_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/standbypool/armstandbypool/v2"
)

// Generated from example definition: 2025-03-01/StandbyContainerGroupPools_ListBySubscription.json
func ExampleStandbyContainerGroupPoolsClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstandbypool.NewClientFactory("00000000-0000-0000-0000-000000000009", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewStandbyContainerGroupPoolsClient().NewListBySubscriptionPager(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 = armstandbypool.StandbyContainerGroupPoolsClientListBySubscriptionResponse{
		// 	StandbyContainerGroupPoolResourceListResult: armstandbypool.StandbyContainerGroupPoolResourceListResult{
		// 		Value: []*armstandbypool.StandbyContainerGroupPoolResource{
		// 			{
		// 				Properties: &armstandbypool.StandbyContainerGroupPoolResourceProperties{
		// 					ElasticityProfile: &armstandbypool.StandbyContainerGroupPoolElasticityProfile{
		// 						MaxReadyCapacity: to.Ptr[int64](688),
		// 						RefillPolicy: to.Ptr(armstandbypool.RefillPolicyAlways),
		// 					},
		// 					ProvisioningState: to.Ptr(armstandbypool.ProvisioningStateSucceeded),
		// 					ContainerGroupProperties: &armstandbypool.ContainerGroupProperties{
		// 						ContainerGroupProfile: &armstandbypool.ContainerGroupProfile{
		// 							ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.ContainerInstance/containerGroupProfiles/cgProfile"),
		// 							Revision: to.Ptr[int64](1),
		// 						},
		// 						SubnetIDs: []*armstandbypool.Subnet{
		// 							{
		// 								ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.Network/virtualNetworks/cgSubnet/subnets/cgSubnet"),
		// 							},
		// 						},
		// 					},
		// 					Zones: []*string{
		// 						to.Ptr("1"),
		// 						to.Ptr("2"),
		// 						to.Ptr("3"),
		// 					},
		// 				},
		// 				Tags: map[string]*string{
		// 				},
		// 				Location: to.Ptr("West US"),
		// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.StandbyPool/standbyContainerGroupPools/pool"),
		// 				Name: to.Ptr("pool"),
		// 				Type: to.Ptr("Microsoft.StandbyPool/standbyContainerGroupPools"),
		// 				SystemData: &armstandbypool.SystemData{
		// 					CreatedBy: to.Ptr("pooluser@microsoft.com"),
		// 					CreatedByType: to.Ptr(armstandbypool.CreatedByTypeUser),
		// 					CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-09-07T16:33:22.210Z"); return t}()),
		// 					LastModifiedBy: to.Ptr("pooluser@microsoft.com"),
		// 					LastModifiedByType: to.Ptr(armstandbypool.CreatedByTypeUser),
		// 					LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-09-07T16:33:22.210Z"); return t}()),
		// 				},
		// 			},
		// 		},
		// 		NextLink: to.Ptr("https://microsoft.com/a"),
		// 	},
		// }
	}
}

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

/**
 * This sample demonstrates how to list StandbyContainerGroupPoolResource resources by subscription ID
 *
 * @summary list StandbyContainerGroupPoolResource resources by subscription ID
 * x-ms-original-file: 2025-03-01/StandbyContainerGroupPools_ListBySubscription.json
 */
async function standbyContainerGroupPoolsListBySubscription() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000009";
  const client = new StandbyPoolManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.standbyContainerGroupPools.listBySubscription()) {
    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.Resources;
using Azure.ResourceManager.StandbyPool;

// Generated from example definition: 2025-03-01/StandbyContainerGroupPools_ListBySubscription.json
// this example is just showing the usage of "StandbyContainerGroupPoolResource_ListBySubscription" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-0000-0000-0000-000000000009";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (StandbyContainerGroupPoolResource item in subscriptionResource.GetStandbyContainerGroupPoolsAsync())
{
    // 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
    StandbyContainerGroupPoolData 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": [
    {
      "properties": {
        "elasticityProfile": {
          "maxReadyCapacity": 688,
          "refillPolicy": "always"
        },
        "provisioningState": "Succeeded",
        "containerGroupProperties": {
          "containerGroupProfile": {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.ContainerInstance/containerGroupProfiles/cgProfile",
            "revision": 1
          },
          "subnetIds": [
            {
              "id": "/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.Network/virtualNetworks/cgSubnet/subnets/cgSubnet"
            }
          ]
        },
        "zones": [
          "1",
          "2",
          "3"
        ]
      },
      "tags": {},
      "location": "West US",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.StandbyPool/standbyContainerGroupPools/pool",
      "name": "pool",
      "type": "Microsoft.StandbyPool/standbyContainerGroupPools",
      "systemData": {
        "createdBy": "pooluser@microsoft.com",
        "createdByType": "User",
        "createdAt": "2023-09-07T16:33:22.210Z",
        "lastModifiedBy": "pooluser@microsoft.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2023-09-07T16:33:22.210Z"
      }
    }
  ],
  "nextLink": "https://microsoft.com/a"
}

定义

名称	说明
ContainerGroupProfile	ContainerGroupProfile 的详细信息。
ContainerGroupProperties	ContainerGroupProperties 的详细信息。
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ProvisioningState	预配状态
RefillPolicy	备用池的重新填充策略
StandbyContainerGroupPoolElasticityProfile	指定备用容器组池的弹性配置文件。
StandbyContainerGroupPoolResource	StandbyContainerGroupPoolResource。
StandbyContainerGroupPoolResourceListResult	StandbyContainerGroupPoolResource 列表作的响应。
Subnet	容器组的子网
systemData	与创建和上次修改资源相关的元数据。

ContainerGroupProfile

Object

ContainerGroupProfile 的详细信息。

名称	类型	说明
id	string (arm-id)	指定备用容器组的容器组配置文件 ID。
revision	integer (int64)	指定容器组配置文件的修订。

ContainerGroupProperties

Object

ContainerGroupProperties 的详细信息。

名称	类型	说明
containerGroupProfile	ContainerGroupProfile	指定备用容器组的容器组配置文件。
subnetIds	Subnet[]	指定容器组的子网 ID。

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	错误对象。

ProvisioningState

枚举

预配状态

值	说明
Canceled	资源创建已取消。
Deleting	正在删除资源。
Failed	资源创建失败。
Succeeded	已创建资源。

RefillPolicy

枚举

备用池的重新填充策略

值	说明
always	备用池自动重新填充以维护 maxReadyCapacity 的重新填充策略。

StandbyContainerGroupPoolElasticityProfile

Object

指定备用容器组池的弹性配置文件。

名称	类型	说明
maxReadyCapacity	integer (int64) minimum: 0 maximum: 2000	指定备用池中备用容器组的最大数目。
refillPolicy	RefillPolicy	指定池的重新填充策略。

StandbyContainerGroupPoolResource

Object

StandbyContainerGroupPoolResource。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
location	string	资源所在的地理位置
name	string	资源的名称
properties.containerGroupProperties	ContainerGroupProperties	指定备用容器组池的容器组属性。
properties.elasticityProfile	StandbyContainerGroupPoolElasticityProfile	指定备用容器组池的弹性配置文件。
properties.provisioningState	ProvisioningState	上次作的状态。
properties.zones	string[]	指定备用容器组池的区域。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

StandbyContainerGroupPoolResourceListResult

Object

StandbyContainerGroupPoolResource 列表作的响应。

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

Subnet

Object

容器组的子网

名称	类型	说明
id	string (arm-id)	指定子网的 ARM 资源 ID。

systemData

Object

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

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