Alias - Create

Reference

Service:: Subscription

API Version:: 2021-10-01

Create Alias Subscription.

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

URI Parameters

Name	In	Required	Type	Description
aliasName	path	True	string	AliasName is the name for the subscription creation request. Note that this is not the same as subscription name and this doesn’t have any other lifecycle need beyond the request for subscription creation.
api-version	query	True	string	Version of the API to be used with the client request. Current version is 2021-10-01

Request Body

Name	Type	Description
properties	PutAliasRequestProperties	Put alias request properties.

Responses

Name	Type	Description
200 OK	SubscriptionAliasResponse	Normal response for a successful query.
201 Created	SubscriptionAliasResponse	Accepted. Subscription creation is in progress.
Other Status Codes	ErrorResponseBody	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

CreateAlias

Sample Request

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

{
  "properties": {
    "displayName": "Test Subscription",
    "workload": "Production",
    "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",
    "subscriptionId": null,
    "additionalProperties": {
      "managementGroupId": null,
      "subscriptionTenantId": "66f6e4d6-07dc-4aea-94ea-e12d3026a3c8",
      "subscriptionOwnerId": "f09b39eb-c496-482c-9ab9-afd799572f4c",
      "tags": {
        "tag1": "Messi",
        "tag2": "Ronaldo",
        "tag3": "Lebron"
      }
    }
  }
}

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-subscription
# USAGE
    python create_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.begin_create(
        alias_name="aliasForNewSub",
        body={
            "properties": {
                "additionalProperties": {
                    "managementGroupId": None,
                    "subscriptionOwnerId": "f09b39eb-c496-482c-9ab9-afd799572f4c",
                    "subscriptionTenantId": "66f6e4d6-07dc-4aea-94ea-e12d3026a3c8",
                    "tags": {"tag1": "Messi", "tag2": "Ronaldo", "tag3": "Lebron"},
                },
                "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",
                "displayName": "Test Subscription",
                "subscriptionId": None,
                "workload": "Production",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/subscription/resource-manager/Microsoft.Subscription/stable/2021-10-01/examples/createAlias.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/azcore/to"
	"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/createAlias.json
func ExampleAliasClient_BeginCreate() {
	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)
	}
	poller, err := clientFactory.NewAliasClient().BeginCreate(ctx, "aliasForNewSub", armsubscription.PutAliasRequest{
		Properties: &armsubscription.PutAliasRequestProperties{
			AdditionalProperties: &armsubscription.PutAliasRequestAdditionalProperties{
				SubscriptionOwnerID:  to.Ptr("f09b39eb-c496-482c-9ab9-afd799572f4c"),
				SubscriptionTenantID: to.Ptr("66f6e4d6-07dc-4aea-94ea-e12d3026a3c8"),
				Tags: map[string]*string{
					"tag1": to.Ptr("Messi"),
					"tag2": to.Ptr("Ronaldo"),
					"tag3": to.Ptr("Lebron"),
				},
			},
			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"),
			Workload:     to.Ptr(armsubscription.WorkloadProduction),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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

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

/**
 * This sample demonstrates how to Create Alias Subscription.
 *
 * @summary Create Alias Subscription.
 * x-ms-original-file: specification/subscription/resource-manager/Microsoft.Subscription/stable/2021-10-01/examples/createAlias.json
 */
async function createAlias() {
  const aliasName = "aliasForNewSub";
  const body = {
    properties: {
      additionalProperties: {
        managementGroupId: undefined,
        subscriptionOwnerId: "f09b39eb-c496-482c-9ab9-afd799572f4c",
        subscriptionTenantId: "66f6e4d6-07dc-4aea-94ea-e12d3026a3c8",
        tags: { tag1: "Messi", tag2: "Ronaldo", tag3: "Lebron" },
      },
      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",
      displayName: "Test Subscription",
      subscriptionId: undefined,
      workload: "Production",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new SubscriptionClient(credential);
  const result = await client.alias.beginCreateAndWait(aliasName, body);
  console.log(result);
}

createAlias().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/createAlias.json
// this example is just showing the usage of "Alias_Create" 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
SubscriptionAliasCreateOrUpdateContent content = new SubscriptionAliasCreateOrUpdateContent()
{
    DisplayName = "Test Subscription",
    Workload = SubscriptionWorkload.Production,
    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",
    SubscriptionId = null,
    AdditionalProperties = new SubscriptionAliasAdditionalProperties()
    {
        ManagementGroupId = null,
        SubscriptionTenantId = Guid.Parse("66f6e4d6-07dc-4aea-94ea-e12d3026a3c8"),
        SubscriptionOwnerId = "f09b39eb-c496-482c-9ab9-afd799572f4c",
        Tags =
        {
        ["tag1"] = "Messi",
        ["tag2"] = "Ronaldo",
        ["tag3"] = "Lebron",
        },
    },
};
ArmOperation<SubscriptionAliasResource> lro = await subscriptionAlias.UpdateAsync(WaitUntil.Completed, content);
SubscriptionAliasResource result = lro.Value;

// 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

Sample Response

Status code:: 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"
    }
  }
}

Status code:: 201

{
  "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"
    }
  }
}

Definitions

Name	Description
AcceptOwnership	The accept ownership state of the resource.
createdByType	The type of identity that created the resource.
ErrorResponse	Describes the format of Error response.
ErrorResponseBody	Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
ProvisioningState	The provisioning state of the resource.
PutAliasRequest	The parameters required to create a new subscription.
PutAliasRequestAdditionalProperties	Put subscription additional properties.
PutAliasRequestProperties	Put subscription properties.
SubscriptionAliasResponse	Subscription Information with the alias.
SubscriptionAliasResponseProperties	Put subscription creation result properties.
systemData	Metadata pertaining to creation and last modification of the resource.
workload	The workload type of the subscription. It can be either Production or DevTest.

AcceptOwnership

The accept ownership state of the resource.

Name	Type	Description
Completed	string
Expired	string
Pending	string

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorResponse

Describes the format of Error response.

Name	Type	Description
code	string	Error code
message	string	Error message indicating why the operation failed.

ErrorResponseBody

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Name	Type	Description
code	string	Error code
error	ErrorResponse	The details of the error.
message	string	Error message indicating why the operation failed.

ProvisioningState

The provisioning state of the resource.

Name	Type	Description
Accepted	string
Pending	string
Succeeded	string

PutAliasRequest

The parameters required to create a new subscription.

Name	Type	Description
properties	PutAliasRequestProperties	Put alias request properties.

PutAliasRequestAdditionalProperties

Put subscription additional properties.

Name	Type	Description
managementGroupId	string	Management group Id for the subscription.
subscriptionOwnerId	string	Owner Id of the subscription
subscriptionTenantId	string	Tenant Id of the subscription
tags	object	Tags for the subscription

PutAliasRequestProperties

Put subscription properties.

Name	Type	Description
additionalProperties	PutAliasRequestAdditionalProperties	Put alias request additional properties.
billingScope	string	Billing scope of the subscription. For CustomerLed and FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
displayName	string	The friendly name of the subscription.
resellerId	string	Reseller Id
subscriptionId	string	This parameter can be used to create alias for existing subscription Id
workload	workload	The workload type of the subscription. It can be either Production or DevTest.

SubscriptionAliasResponse

Subscription Information with the alias.

Name	Type	Description
id	string	Fully qualified ID for the alias resource.
name	string	Alias ID.
properties	SubscriptionAliasResponseProperties	Subscription Alias response properties.
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
type	string	Resource type, Microsoft.Subscription/aliases.

SubscriptionAliasResponseProperties

Put subscription creation result properties.

Name	Type	Description
acceptOwnershipState	AcceptOwnership	The accept ownership state of the resource.
acceptOwnershipUrl	string	Url to accept ownership of the subscription.
billingScope	string	Billing scope of the subscription. For CustomerLed and FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
createdTime	string	Created Time
displayName	string	The display name of the subscription.
managementGroupId	string	The Management Group Id.
provisioningState	ProvisioningState	The provisioning state of the resource.
resellerId	string	Reseller Id
subscriptionId	string	Newly created subscription Id.
subscriptionOwnerId	string	Owner Id of the subscription
tags	object	Tags for the subscription
workload	workload	The workload type of the subscription. It can be either Production or DevTest.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

workload

The workload type of the subscription. It can be either Production or DevTest.

Name	Type	Description
DevTest	string
Production	string

Alias - Create

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

CreateAlias

Sample Request

Sample Response

Definitions

AcceptOwnership

createdByType

ErrorResponse

ErrorResponseBody

ProvisioningState

PutAliasRequest

PutAliasRequestAdditionalProperties

PutAliasRequestProperties

SubscriptionAliasResponse

SubscriptionAliasResponseProperties

systemData

workload

Additional resources