Alias - List

參考

服務:: Subscription

API 版本:: 2021-10-01

列出別名訂閱。

GET https://management.azure.com/providers/Microsoft.Subscription/aliases?api-version=2021-10-01

URI 參數

名稱	位於	必要	類型	Description
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。目前版本為 2021-10-01

回應

名稱	類型	Description
200 OK	SubscriptionAliasListResult	訂用帳戶詳細數據。
Other Status Codes	ErrorResponseBody	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

ListAlias

範例要求

GET https://management.azure.com/providers/Microsoft.Subscription/aliases?api-version=2021-10-01

from azure.identity import DefaultAzureCredential
from azure.mgmt.subscription import SubscriptionClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-subscription
# USAGE
    python list_alias.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.alias.list()
    print(response)


# x-ms-original-file: specification/subscription/resource-manager/Microsoft.Subscription/stable/2021-10-01/examples/listAlias.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

package armsubscription_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/subscription/armsubscription"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/subscription/resource-manager/Microsoft.Subscription/stable/2021-10-01/examples/listAlias.json
func ExampleAliasClient_List() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsubscription.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAliasClient().List(ctx, 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.AliasListResult = armsubscription.AliasListResult{
	// 	Value: []*armsubscription.AliasResponse{
	// 		{
	// 			Name: to.Ptr("string"),
	// 			Type: to.Ptr("string"),
	// 			ID: to.Ptr("string"),
	// 			Properties: &armsubscription.AliasResponseProperties{
	// 				AcceptOwnershipState: to.Ptr(armsubscription.AcceptOwnershipPending),
	// 				AcceptOwnershipURL: to.Ptr("/providers/Microsoft.Subscription/e2283d0f-acad-4904-b803-627dd74cc072/acceptOwnership"),
	// 				BillingScope: to.Ptr("/billingAccounts/af6231a7-7f8d-4fcc-a993-dd8466108d07:c663dac6-a9a5-405a-8938-cd903e12ab5b_2019_05_31/billingProfiles/QWDQ-QWHI-AUW-SJDO-DJH/invoiceSections/FEUF-EUHE-ISJ-SKDW-DJH"),
	// 				DisplayName: to.Ptr("Test Subscription"),
	// 				ProvisioningState: to.Ptr(armsubscription.ProvisioningStateSucceeded),
	// 				SubscriptionID: to.Ptr("e2283d0f-acad-4904-b803-627dd74cc072"),
	// 				SubscriptionOwnerID: to.Ptr("f09b39eb-c496-482c-9ab9-afd799572f4c"),
	// 				Tags: map[string]*string{
	// 					"tag1": to.Ptr("Messi"),
	// 					"tag2": to.Ptr("Ronaldo"),
	// 					"tag3": to.Ptr("Lebron"),
	// 				},
	// 				Workload: to.Ptr(armsubscription.WorkloadProduction),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("string"),
	// 			Type: to.Ptr("string"),
	// 			ID: to.Ptr("string"),
	// 			Properties: &armsubscription.AliasResponseProperties{
	// 				AcceptOwnershipState: to.Ptr(armsubscription.AcceptOwnershipPending),
	// 				AcceptOwnershipURL: to.Ptr("/providers/Microsoft.Subscription/091c6e56-a835-4422-a082-0427308ca9ee/acceptOwnership"),
	// 				BillingScope: to.Ptr("/billingAccounts/af6231a7-7f8d-4fcc-a993-dd8466108d07:c663dac6-a9a5-405a-8938-cd903e12ab5b_2019_05_31/billingProfiles/QWDQ-QWHI-AUW-SJDO-DJH/invoiceSections/FEUF-EUHE-ISJ-SKDW-DJH"),
	// 				DisplayName: to.Ptr("Test Subscription 2"),
	// 				ProvisioningState: to.Ptr(armsubscription.ProvisioningStateSucceeded),
	// 				SubscriptionID: to.Ptr("091c6e56-a835-4422-a082-0427308ca9ee"),
	// 				SubscriptionOwnerID: to.Ptr("f09b39eb-c496-482c-9ab9-afd799572f4c"),
	// 				Tags: map[string]*string{
	// 					"tag1": to.Ptr("Messi2"),
	// 					"tag2": to.Ptr("Ronaldo2"),
	// 					"tag3": to.Ptr("Lebron2"),
	// 				},
	// 				Workload: to.Ptr(armsubscription.WorkloadProduction),
	// 			},
	// 	}},
	// }
}

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

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

/**
 * This sample demonstrates how to List Alias Subscription.
 *
 * @summary List Alias Subscription.
 * x-ms-original-file: specification/subscription/resource-manager/Microsoft.Subscription/stable/2021-10-01/examples/listAlias.json
 */
async function listAlias() {
  const credential = new DefaultAzureCredential();
  const client = new SubscriptionClient(credential);
  const result = await client.alias.list();
  console.log(result);
}

listAlias().catch(console.error);

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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Subscription;
using Azure.ResourceManager.Subscription.Models;

// Generated from example definition: specification/subscription/resource-manager/Microsoft.Subscription/stable/2021-10-01/examples/listAlias.json
// this example is just showing the usage of "Alias_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 TenantResource created on azure
// for more information of creating TenantResource, please refer to the document of TenantResource
var tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// get the collection of this SubscriptionAliasResource
SubscriptionAliasCollection collection = tenantResource.GetSubscriptionAliases();

// invoke the operation and iterate over the result
await foreach (SubscriptionAliasResource 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
    SubscriptionAliasData 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": "string",
      "name": "string",
      "type": "string",
      "properties": {
        "subscriptionId": "e2283d0f-acad-4904-b803-627dd74cc072",
        "displayName": "Test Subscription",
        "provisioningState": "Accepted",
        "acceptOwnershipUrl": "/providers/Microsoft.Subscription/e2283d0f-acad-4904-b803-627dd74cc072/acceptOwnership",
        "acceptOwnershipState": "Pending",
        "billingScope": "/billingAccounts/af6231a7-7f8d-4fcc-a993-dd8466108d07:c663dac6-a9a5-405a-8938-cd903e12ab5b_2019_05_31/billingProfiles/QWDQ-QWHI-AUW-SJDO-DJH/invoiceSections/FEUF-EUHE-ISJ-SKDW-DJH",
        "workload": "Production",
        "resellerId": null,
        "subscriptionOwnerId": "f09b39eb-c496-482c-9ab9-afd799572f4c",
        "managementGroupId": null,
        "tags": {
          "tag1": "Messi",
          "tag2": "Ronaldo",
          "tag3": "Lebron"
        }
      }
    },
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "properties": {
        "subscriptionId": "091c6e56-a835-4422-a082-0427308ca9ee",
        "displayName": "Test Subscription 2",
        "provisioningState": "Accepted",
        "acceptOwnershipUrl": "/providers/Microsoft.Subscription/091c6e56-a835-4422-a082-0427308ca9ee/acceptOwnership",
        "acceptOwnershipState": "Pending",
        "billingScope": "/billingAccounts/af6231a7-7f8d-4fcc-a993-dd8466108d07:c663dac6-a9a5-405a-8938-cd903e12ab5b_2019_05_31/billingProfiles/QWDQ-QWHI-AUW-SJDO-DJH/invoiceSections/FEUF-EUHE-ISJ-SKDW-DJH",
        "workload": "Production",
        "resellerId": null,
        "subscriptionOwnerId": "f09b39eb-c496-482c-9ab9-afd799572f4c",
        "managementGroupId": null,
        "tags": {
          "tag1": "Messi2",
          "tag2": "Ronaldo2",
          "tag3": "Lebron2"
        }
      }
    }
  ],
  "nextLink": null
}

定義

名稱	Description
AcceptOwnership	接受資源的擁有權狀態。
createdByType	建立資源的身分識別類型。
ErrorResponse	描述錯誤回應的格式。
ErrorResponseBody	錯誤回應表示服務無法處理傳入要求。錯誤訊息中提供了原因。
ProvisioningState	資源的布建狀態。
SubscriptionAliasListResult	別名清單。
SubscriptionAliasResponse	具有別名的訂用帳戶資訊。
SubscriptionAliasResponseProperties	放置訂用帳戶建立結果屬性。
systemData	與建立和上次修改資源相關的元數據。
workload	訂用帳戶的工作負載類型。它可以是 Production 或 DevTest。

AcceptOwnership

Enumeration

接受資源的擁有權狀態。

值	Description
Completed
Expired
Pending

createdByType

Enumeration

建立資源的身分識別類型。

值	Description
Application
Key
ManagedIdentity
User

ErrorResponse

Object

描述錯誤回應的格式。

名稱	類型	Description
code	string	錯誤碼
message	string	指出作業失敗原因的錯誤訊息。

ErrorResponseBody

Object

錯誤回應表示服務無法處理傳入要求。錯誤訊息中提供了原因。

名稱	類型	Description
code	string	錯誤碼
error	ErrorResponse	錯誤的詳細數據。
message	string	指出作業失敗原因的錯誤訊息。

ProvisioningState

Enumeration

資源的布建狀態。

值	Description
Accepted
Pending
Succeeded

SubscriptionAliasListResult

Object

別名清單。

名稱	類型	Description
nextLink	string	連結 (url) 至下一頁的結果。
value	SubscriptionAliasResponse[]	別名清單。

SubscriptionAliasResponse

Object

具有別名的訂用帳戶資訊。

名稱	類型	Description
id	string	別名資源的完整標識碼。
name	string	別名標識碼。
properties	SubscriptionAliasResponseProperties	訂用帳戶別名響應屬性。
systemData	systemData	與建立和上次修改資源相關的元數據。
type	string	資源類型，Microsoft.Subscription/aliases。

SubscriptionAliasResponseProperties

Object

放置訂用帳戶建立結果屬性。

名稱	類型	Description
acceptOwnershipState	AcceptOwnership	接受資源的擁有權狀態。
acceptOwnershipUrl	string	接受訂用帳戶擁有權的 URL。
billingScope	string	訂用帳戶的計費範圍。針對 CustomerLed 和 FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
createdTime	string	建立時間
displayName	string	訂用帳戶的顯示名稱。
managementGroupId	string	管理群組標識碼。
provisioningState	ProvisioningState	資源的布建狀態。
resellerId	string	轉銷商標識碼
subscriptionId	string	新建立的訂用帳戶標識碼。
subscriptionOwnerId	string	訂用帳戶的擁有者標識碼
tags	object	訂用帳戶的標記
workload	workload	訂用帳戶的工作負載類型。它可以是 Production 或 DevTest。

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳 (UTC) 。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳 (UTC)
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

workload

Enumeration

訂用帳戶的工作負載類型。它可以是 Production 或 DevTest。

值	Description
DevTest
Production

共用方式為

Alias - List

URI 參數

回應

安全性

azure_auth

範圍

範例

ListAlias

範例要求

範例回覆

定義

AcceptOwnership

createdByType

ErrorResponse

ErrorResponseBody

ProvisioningState

SubscriptionAliasListResult

SubscriptionAliasResponse

SubscriptionAliasResponseProperties

systemData

workload

其他資源