Alias - Create

Usługa:: Subscription

Wersja interfejsu API:: 2021-10-01

Utwórz subskrypcję aliasu.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
aliasName	path	True	string	AliasName to nazwa żądania utworzenia subskrypcji. Należy pamiętać, że nie jest to takie samo jak nazwa subskrypcji i nie ma potrzeby innego cyklu życia poza żądaniem utworzenia subskrypcji.
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta. Bieżąca wersja to 2021-10-01

Treść żądania

Nazwa	Typ	Opis
properties	PutAliasRequestProperties	Umieść właściwości żądania aliasu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SubscriptionAliasResponse	Normalna odpowiedź dla pomyślnego zapytania.
201 Created	SubscriptionAliasResponse	Akceptowane. Tworzenie subskrypcji jest w toku.
Other Status Codes	ErrorResponseBody	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

CreateAlias

Przykładowe żądanie

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");
require("dotenv/config");

/**
 * 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);
}

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

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

Przykładowa odpowiedź

Kod stanu:: 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"
    }
  }
}

Kod stanu:: 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"
    }
  }
}

Definicje

Nazwa	Opis
AcceptOwnership	Stan akceptowania własności zasobu.
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorResponse	Opisuje format odpowiedzi Błąd.
ErrorResponseBody	Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć przychodzącego żądania. Przyczyna jest podana w komunikacie o błędzie.
ProvisioningState	Stan aprowizacji zasobu.
PutAliasRequest	Parametry wymagane do utworzenia nowej subskrypcji.
PutAliasRequestAdditionalProperties	Umieść dodatkowe właściwości subskrypcji.
PutAliasRequestProperties	Umieść właściwości subskrypcji.
SubscriptionAliasResponse	Informacje o subskrypcji z aliasem.
SubscriptionAliasResponseProperties	Umieść właściwości wyniku tworzenia subskrypcji.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
workload	Typ obciążenia subskrypcji. Może to być środowisko produkcyjne lub devTest.

AcceptOwnership

Wyliczanie

Stan akceptowania własności zasobu.

Wartość	Opis
Pending
Completed
Expired

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

ErrorResponse

Objekt

Opisuje format odpowiedzi Błąd.

Nazwa	Typ	Opis
code	string	Kod błędu
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

ErrorResponseBody

Objekt

Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć przychodzącego żądania. Przyczyna jest podana w komunikacie o błędzie.

Nazwa	Typ	Opis
code	string	Kod błędu
error	ErrorResponse	Szczegóły błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

ProvisioningState

Wyliczanie

Stan aprowizacji zasobu.

Wartość	Opis
Pending
Accepted
Succeeded

PutAliasRequest

Objekt

Parametry wymagane do utworzenia nowej subskrypcji.

Nazwa	Typ	Opis
properties	PutAliasRequestProperties	Umieść właściwości żądania aliasu.

PutAliasRequestAdditionalProperties

Objekt

Umieść dodatkowe właściwości subskrypcji.

Nazwa	Typ	Opis
managementGroupId	string	Identyfikator grupy zarządzania dla subskrypcji.
subscriptionOwnerId	string	Identyfikator właściciela subskrypcji
subscriptionTenantId	string	Identyfikator dzierżawy subskrypcji
tags	object	Tagi subskrypcji

PutAliasRequestProperties

Objekt

Umieść właściwości subskrypcji.

Nazwa	Typ	Opis
additionalProperties	PutAliasRequestAdditionalProperties	Umieść alias, aby zażądać dodatkowych właściwości.
billingScope	string	Zakres rozliczeniowy subskrypcji. W przypadku customerLed i FieldLed — /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} dla PartnerLed — /billingAccounts/{billingAccountName}/customers/{customerName} dla starszej wersji EA — /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
displayName	string	Przyjazna nazwa subskrypcji.
resellerId	string	Identyfikator odsprzedawcy
subscriptionId	string	Ten parametr może służyć do tworzenia aliasu dla istniejącego identyfikatora subskrypcji
workload	workload	Typ obciążenia subskrypcji. Może to być środowisko produkcyjne lub devTest.

SubscriptionAliasResponse

Objekt

Informacje o subskrypcji z aliasem.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu aliasu.
name	string	Identyfikator aliasu.
properties	SubscriptionAliasResponseProperties	Właściwości odpowiedzi aliasu subskrypcji.
systemData	systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
type	string	Typ zasobu, Microsoft.Subscription/aliases.

SubscriptionAliasResponseProperties

Objekt

Umieść właściwości wyniku tworzenia subskrypcji.

Nazwa	Typ	Opis
acceptOwnershipState	AcceptOwnership	Stan akceptowania własności zasobu.
acceptOwnershipUrl	string	Adres URL umożliwiający zaakceptowanie własności subskrypcji.
billingScope	string	Zakres rozliczeniowy subskrypcji. W przypadku customerLed i FieldLed — /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} dla PartnerLed — /billingAccounts/{billingAccountName}/customers/{customerName} dla starszej wersji EA — /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
createdTime	string	Czas utworzenia
displayName	string	Nazwa wyświetlana subskrypcji.
managementGroupId	string	Identyfikator grupy zarządzania.
provisioningState	ProvisioningState	Stan aprowizacji zasobu.
resellerId	string	Identyfikator odsprzedawcy
subscriptionId	string	Nowo utworzony identyfikator subskrypcji.
subscriptionOwnerId	string	Identyfikator właściciela subskrypcji
tags	object	Tagi subskrypcji
workload	workload	Typ obciążenia subskrypcji. Może to być środowisko produkcyjne lub devTest.

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

workload

Wyliczanie

Typ obciążenia subskrypcji. Może to być środowisko produkcyjne lub devTest.

Wartość	Opis
Production
DevTest

Udostępnij przez

Alias - Create

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

CreateAlias

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AcceptOwnership

createdByType

ErrorResponse

ErrorResponseBody

ProvisioningState

PutAliasRequest

PutAliasRequestAdditionalProperties

PutAliasRequestProperties

SubscriptionAliasResponse

SubscriptionAliasResponseProperties

systemData

workload