Alias - Get

サービス:

Subscription

API バージョン:

2021-10-01

エイリアス サブスクリプションを取得します。

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

URI パラメーター

名前	/	必須	型	説明
aliasName	path	True	string	AliasName は、サブスクリプション作成要求の名前です。 これはサブスクリプション名と同じではなく、サブスクリプションの作成要求を超える他のライフサイクルの必要性を持っていないことに注意してください。
api-version	query	True	string	クライアント要求で使用する API のバージョン。 現在のバージョンは 2021-10-01 です

応答

名前	型	説明
200 OK	SubscriptionAliasResponse	サブスクリプションの詳細。
Other Status Codes	ErrorResponseBody	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

GetAlias

要求のサンプル

HTTP

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

Python

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-subscription
# USAGE
    python get_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.get(
        alias_name="aliasForNewSub",
    )
    print(response)


# x-ms-original-file: specification/subscription/resource-manager/Microsoft.Subscription/stable/2021-10-01/examples/getAlias.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 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/getAlias.json
func ExampleAliasClient_Get() {
	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().Get(ctx, "aliasForNewSub", 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.AliasResponse = 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),
	// 	},
	// }
}

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

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

getAlias().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

dotnet

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

// Generated from example definition: specification/subscription/resource-manager/Microsoft.Subscription/stable/2021-10-01/examples/getAlias.json
// this example is just showing the usage of "Alias_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 SubscriptionAliasResource created on azure
// for more information of creating SubscriptionAliasResource, please refer to the document of SubscriptionAliasResource
string aliasName = "aliasForNewSub";
ResourceIdentifier subscriptionAliasResourceId = SubscriptionAliasResource.CreateResourceIdentifier(aliasName);
SubscriptionAliasResource subscriptionAlias = client.GetSubscriptionAliasResource(subscriptionAliasResourceId);

// invoke the operation
SubscriptionAliasResource result = await subscriptionAlias.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
SubscriptionAliasData 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": "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"
    }
  }
}

定義

名前	説明
AcceptOwnership	リソースの所有権の受け入れ状態。
createdByType	リソースを作成した ID の種類。
ErrorResponse	エラー応答の形式について説明します。
ErrorResponseBody	エラー応答は、サービスが受信要求を処理できないことを示します。 エラー メッセージに理由が示されます。
ProvisioningState	リソースのプロビジョニング状態。
SubscriptionAliasResponse	エイリアスを含むサブスクリプション情報。
SubscriptionAliasResponseProperties	サブスクリプション作成結果のプロパティを配置します。
systemData	リソースの作成と最後の変更に関連するメタデータ。
workload	サブスクリプションのワークロードの種類。 運用または DevTest のいずれかを指定できます。

AcceptOwnership

列挙

リソースの所有権の受け入れ状態。

値	説明
Completed
Expired
Pending

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

ErrorResponse

Object

エラー応答の形式について説明します。

名前	型	説明
code	string	エラー コード
message	string	操作が失敗した理由を示すエラー メッセージ。

ErrorResponseBody

Object

エラー応答は、サービスが受信要求を処理できないことを示します。 エラー メッセージに理由が示されます。

名前	型	説明
code	string	エラー コード
error	ErrorResponse	エラーの詳細。
message	string	操作が失敗した理由を示すエラー メッセージ。

ProvisioningState

列挙

リソースのプロビジョニング状態。

値	説明
Accepted
Pending
Succeeded

SubscriptionAliasResponse

Object

エイリアスを含むサブスクリプション情報。

名前	型	説明
id	string	エイリアス リソースの完全修飾 ID。
name	string	エイリアス ID。
properties	SubscriptionAliasResponseProperties	サブスクリプション エイリアスの応答プロパティ。
systemData	systemData	リソースの作成と最後の変更に関連するメタデータ。
type	string	リソースの種類、Microsoft.Subscription/aliases。

SubscriptionAliasResponseProperties

Object

サブスクリプション作成結果のプロパティを配置します。

名前	型	説明
acceptOwnershipState	AcceptOwnership	リソースの所有権の受け入れ状態。
acceptOwnershipUrl	string	サブスクリプションの所有権を受け入れる URL。
billingScope	string	サブスクリプションの課金スコープ。 CustomerLed および FieldLed の場合 - /billingAccountName}/billingProfileName}/billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
createdTime	string	作成時刻
displayName	string	サブスクリプションの表示名。
managementGroupId	string	管理グループ ID。
provisioningState	ProvisioningState	リソースのプロビジョニング状態。
resellerId	string	リセラー ID
subscriptionId	string	新しく作成されたサブスクリプション ID。
subscriptionOwnerId	string	サブスクリプションの所有者 ID
tags	object	サブスクリプションのタグ
workload	workload	サブスクリプションのワークロードの種類。 運用または DevTest のいずれかを指定できます。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

workload

列挙

サブスクリプションのワークロードの種類。 運用または DevTest のいずれかを指定できます。

値	説明
DevTest
Production