Alias - Create

Service:

Subscription

API Version:

2021-10-01

Criar assinatura do Alias.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
aliasName	path	True	string	AliasName é o nome da solicitação de criação da assinatura. Observe que isso não é o mesmo que o nome da assinatura e isso não tem nenhuma outra necessidade de ciclo de vida além da solicitação de criação da assinatura.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente. A versão atual é 2021-10-01

Corpo da solicitação

Nome	Tipo	Description
properties	PutAliasRequestProperties	Colocar propriedades de solicitação de alias.

Respostas

Nome	Tipo	Description
200 OK	SubscriptionAliasResponse	Resposta normal para uma consulta bem-sucedida.
201 Created	SubscriptionAliasResponse	Aceita. A criação da assinatura está em andamento.
Other Status Codes	ErrorResponseBody	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

CreateAlias

Sample Request

HTTP

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

Python

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

Go

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

JavaScript

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

dotnet

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

Definições

Nome	Description
AcceptOwnership	O estado de aceitação de propriedade do recurso.
createdByType	O tipo de identidade que criou o recurso.
ErrorResponse	Descreve o formato da resposta de erro.
ErrorResponseBody	A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.
ProvisioningState	O estado de provisionamento do recurso.
PutAliasRequest	Os parâmetros necessários para criar uma nova assinatura.
PutAliasRequestAdditionalProperties	Coloque propriedades adicionais da assinatura.
PutAliasRequestProperties	Coloque as propriedades da assinatura.
SubscriptionAliasResponse	Informações de assinatura com o alias.
SubscriptionAliasResponseProperties	Coloque as propriedades de resultado da criação da assinatura.
systemData	Metadados relativos à criação e à última modificação do recurso.
workload	O tipo de carga de trabalho da assinatura. Pode ser Produção ou DevTest.

AcceptOwnership

O estado de aceitação de propriedade do recurso.

Nome	Tipo	Description
Completed	string
Expired	string
Pending	string

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorResponse

Descreve o formato da resposta de erro.

Nome	Tipo	Description
code	string	Código do erro
message	string	Mensagem de erro indicando por que a operação falhou.

ErrorResponseBody

A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Nome	Tipo	Description
code	string	Código do erro
error	ErrorResponse	Os detalhes do erro.
message	string	Mensagem de erro indicando por que a operação falhou.

ProvisioningState

O estado de provisionamento do recurso.

Nome	Tipo	Description
Accepted	string
Pending	string
Succeeded	string

PutAliasRequest

Os parâmetros necessários para criar uma nova assinatura.

Nome	Tipo	Description
properties	PutAliasRequestProperties	Colocar propriedades de solicitação de alias.

PutAliasRequestAdditionalProperties

Coloque propriedades adicionais da assinatura.

Nome	Tipo	Description
managementGroupId	string	ID do grupo de gerenciamento para a assinatura.
subscriptionOwnerId	string	ID do proprietário da assinatura
subscriptionTenantId	string	ID do locatário da assinatura
tags	object	Marcas para a assinatura

PutAliasRequestProperties

Coloque as propriedades da assinatura.

Nome	Tipo	Description
additionalProperties	PutAliasRequestAdditionalProperties	Colocar propriedades adicionais de solicitação de alias.
billingScope	string	Escopo de cobrança da assinatura. Para CustomerLed e FieldLed – /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
displayName	string	O nome amigável da assinatura.
resellerId	string	ID do revendedor
subscriptionId	string	Esse parâmetro pode ser usado para criar alias para a ID de assinatura existente
workload	workload	O tipo de carga de trabalho da assinatura. Pode ser Produção ou DevTest.

SubscriptionAliasResponse

Informações de assinatura com o alias.

Nome	Tipo	Description
id	string	ID totalmente qualificada para o recurso de alias.
name	string	ID do alias.
properties	SubscriptionAliasResponseProperties	Propriedades de resposta do Alias da assinatura.
systemData	systemData	Metadados relativos à criação e à última modificação do recurso.
type	string	Tipo de recurso, Microsoft.Subscription/aliases.

SubscriptionAliasResponseProperties

Coloque as propriedades de resultado da criação da assinatura.

Nome	Tipo	Description
acceptOwnershipState	AcceptOwnership	O estado de aceitação de propriedade do recurso.
acceptOwnershipUrl	string	Url para aceitar a propriedade da assinatura.
billingScope	string	Escopo de cobrança da assinatura. Para CustomerLed e FieldLed – /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
createdTime	string	Hora de criação
displayName	string	O nome de exibição da assinatura.
managementGroupId	string	A ID do Grupo de Gerenciamento.
provisioningState	ProvisioningState	O estado de provisionamento do recurso.
resellerId	string	ID do revendedor
subscriptionId	string	ID de assinatura recém-criada.
subscriptionOwnerId	string	ID do proprietário da assinatura
tags	object	Marcas para a assinatura
workload	workload	O tipo de carga de trabalho da assinatura. Pode ser Produção ou DevTest.

systemData

Metadados relativos à criação e à última modificação do recurso.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

workload

O tipo de carga de trabalho da assinatura. Pode ser Produção ou DevTest.

Nome	Tipo	Description
DevTest	string
Production	string