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

Subscriptions - Get

服务:

Resource Management

API 版本:

2022-12-01

获取有关指定订阅的详细信息。

GET https://management.azure.com/subscriptions/{subscriptionId}?api-version=2022-12-01

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	Subscription	确定 - 返回有关订阅的信息。
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

GetASingleSubscription

示例请求

HTTP

GET https://management.azure.com/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05?api-version=2022-12-01

Java

/**
 * Samples for Subscriptions Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscription.json
     */
    /**
     * Sample code: GetASingleSubscription.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getASingleSubscription(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().subscriptionClient().getSubscriptions()
            .getWithResponse("291bba3f-e0a5-47bc-a099-3bdcb2a50a05", 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.resource import SubscriptionClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python get_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 = SubscriptionClient(
        credential=DefaultAzureCredential(),
    )

    response = client.subscriptions.get(
        subscription_id="291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
    )
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscription.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 armsubscriptions_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armsubscriptions"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4f4073bdb028bc84bc3e6405c1cbaf8e89b83caf/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscription.json
func ExampleClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsubscriptions.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewClient().Get(ctx, "291bba3f-e0a5-47bc-a099-3bdcb2a50a05", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Subscription = armsubscriptions.Subscription{
	// 	AuthorizationSource: to.Ptr("Bypassed"),
	// 	DisplayName: to.Ptr("Example Subscription"),
	// 	ID: to.Ptr("/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05"),
	// 	ManagedByTenants: []*armsubscriptions.ManagedByTenant{
	// 		{
	// 			TenantID: to.Ptr("8f70baf1-1f6e-46a2-a1ff-238dac1ebfb7"),
	// 	}},
	// 	State: to.Ptr(armsubscriptions.SubscriptionStateEnabled),
	// 	SubscriptionID: to.Ptr("291bba3f-e0a5-47bc-a099-3bdcb2a50a05"),
	// 	SubscriptionPolicies: &armsubscriptions.SubscriptionPolicies{
	// 		LocationPlacementID: to.Ptr("Internal_2014-09-01"),
	// 		QuotaID: to.Ptr("Internal_2014-09-01"),
	// 		SpendingLimit: to.Ptr(armsubscriptions.SpendingLimitOff),
	// 	},
	// 	Tags: map[string]*string{
	// 		"tagKey1": to.Ptr("tagValue1"),
	// 		"tagKey2": to.Ptr("tagValue2"),
	// 	},
	// 	TenantID: to.Ptr("31c75423-32d6-4322-88b7-c478bdde4858"),
	// }
}

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

/**
 * This sample demonstrates how to Gets details about a specified subscription.
 *
 * @summary Gets details about a specified subscription.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscription.json
 */
async function getASingleSubscription() {
  const subscriptionId = "291bba3f-e0a5-47bc-a099-3bdcb2a50a05";
  const credential = new DefaultAzureCredential();
  const client = new SubscriptionClient(credential);
  const result = await client.subscriptions.get(subscriptionId);
  console.log(result);
}

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.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscription.json
// this example is just showing the usage of "Subscriptions_Get" 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 = "291bba3f-e0a5-47bc-a099-3bdcb2a50a05";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscription = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
SubscriptionResource result = await subscription.GetAsync();

// the variable result 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
SubscriptionData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

示例响应

状态代码:

200

{
  "id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
  "subscriptionId": "291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
  "tenantId": "31c75423-32d6-4322-88b7-c478bdde4858",
  "displayName": "Example Subscription",
  "state": "Enabled",
  "subscriptionPolicies": {
    "locationPlacementId": "Internal_2014-09-01",
    "quotaId": "Internal_2014-09-01",
    "spendingLimit": "Off"
  },
  "authorizationSource": "Bypassed",
  "managedByTenants": [
    {
      "tenantId": "8f70baf1-1f6e-46a2-a1ff-238dac1ebfb7"
    }
  ],
  "tags": {
    "tagKey1": "tagValue1",
    "tagKey2": "tagValue2"
  }
}

定义

名称	说明
CloudError	资源管理请求的错误响应。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ManagedByTenant	有关管理订阅的租户的信息。
spendingLimit	订阅支出限制。
Subscription	订阅信息。
SubscriptionPolicies	订阅策略。
SubscriptionState	订阅状态。 可能的值为 Enabled、Warned、PastDue、Disabled 和 Deleted。

CloudError

资源管理请求的错误响应。

名称	类型	说明
error	ErrorResponse	错误响应 对所有 Azure 资源管理器 API 的常见错误响应，可返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式.) 。

ErrorAdditionalInfo

资源管理错误附加信息。

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

ErrorDetail

错误详细信息。

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

ErrorResponse

错误响应

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

ManagedByTenant

有关管理订阅的租户的信息。

名称	类型	说明
tenantId	string	管理租户的租户 ID。 这是一个 GUID。

spendingLimit

订阅支出限制。

名称	类型	说明
CurrentPeriodOff	string
Off	string
On	string

Subscription

订阅信息。

名称	类型	说明
authorizationSource	string	请求的授权源。 有效值是旧版、RoleBased、Bypassed、Direct 和 Management 的一个或多个组合。 例如，“旧版，基于 RoleBased”。
displayName	string	订阅显示名称。
id	string	订阅的完全限定 ID。 例如，/subscriptions/8d65815f-a5b6-402f-9298-045155da7d74
managedByTenants	ManagedByTenant[]	包含管理订阅的租户的数组。
state	SubscriptionState	订阅状态。 可能的值为 Enabled、Warned、PastDue、Disabled 和 Deleted。
subscriptionId	string	订阅的 ID。
subscriptionPolicies	SubscriptionPolicies	订阅策略。
tags	object	附加到订阅的标记。
tenantId	string	订阅租户 ID。

SubscriptionPolicies

订阅策略。

名称	类型	说明
locationPlacementId	string	订阅位置放置 ID。 ID 指示订阅可见的区域。 例如，位置放置 ID 为 Public_2014-09-01 的订阅有权访问 Azure 公共区域。
quotaId	string	订阅配额 ID。
spendingLimit	spendingLimit	订阅支出限制。

SubscriptionState

订阅状态。 可能的值为 Enabled、Warned、PastDue、Disabled 和 Deleted。

名称	类型	说明
Deleted	string
Disabled	string
Enabled	string
PastDue	string
Warned	string