Subscription - Accept Ownership

Service:

Subscription

API Version:

2021-10-01

Accept subscription ownership.

POST https://management.azure.com/providers/Microsoft.Subscription/subscriptions/{subscriptionId}/acceptOwnership?api-version=2021-10-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	Subscription Id.
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	AcceptOwnershipRequestProperties	Accept subscription ownership request properties.

Responses

Name	Type	Description
202 Accepted		Accept Subscription ownership is in progress Headers Location: string Retry-After: integer
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

AcceptOwnership

Sample Request

HTTP

POST https://management.azure.com/providers/Microsoft.Subscription/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05/acceptOwnership?api-version=2021-10-01

{
  "properties": {
    "displayName": "Test Subscription",
    "managementGroupId": null,
    "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 accept_subscription_ownership.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.subscription.begin_accept_ownership(
        subscription_id="291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
        body={
            "properties": {
                "displayName": "Test Subscription",
                "managementGroupId": None,
                "tags": {"tag1": "Messi", "tag2": "Ronaldo", "tag3": "Lebron"},
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/subscription/resource-manager/Microsoft.Subscription/stable/2021-10-01/examples/acceptSubscriptionOwnership.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/acceptSubscriptionOwnership.json
func ExampleClient_BeginAcceptOwnership() {
	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.NewClient().BeginAcceptOwnership(ctx, "291bba3f-e0a5-47bc-a099-3bdcb2a50a05", armsubscription.AcceptOwnershipRequest{
		Properties: &armsubscription.AcceptOwnershipRequestProperties{
			DisplayName: to.Ptr("Test Subscription"),
			Tags: map[string]*string{
				"tag1": to.Ptr("Messi"),
				"tag2": to.Ptr("Ronaldo"),
				"tag3": to.Ptr("Lebron"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

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 Accept subscription ownership.
 *
 * @summary Accept subscription ownership.
 * x-ms-original-file: specification/subscription/resource-manager/Microsoft.Subscription/stable/2021-10-01/examples/acceptSubscriptionOwnership.json
 */
async function acceptOwnership() {
  const subscriptionId = "291bba3f-e0a5-47bc-a099-3bdcb2a50a05";
  const body = {
    properties: {
      displayName: "Test Subscription",
      managementGroupId: undefined,
      tags: { tag1: "Messi", tag2: "Ronaldo", tag3: "Lebron" },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new SubscriptionClient(credential);
  const result = await client.subscriptionOperations.beginAcceptOwnershipAndWait(
    subscriptionId,
    body
  );
  console.log(result);
}

acceptOwnership().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/acceptSubscriptionOwnership.json
// this example is just showing the usage of "Subscription_AcceptOwnership" 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;

// invoke the operation
string subscriptionId = "291bba3f-e0a5-47bc-a099-3bdcb2a50a05";
AcceptOwnershipContent content = new AcceptOwnershipContent()
{
    Properties = new AcceptOwnershipRequestProperties("Test Subscription")
    {
        ManagementGroupId = null,
        Tags =
        {
        ["tag1"] = "Messi",
        ["tag2"] = "Ronaldo",
        ["tag3"] = "Lebron",
        },
    },
};
await tenantResource.AcceptSubscriptionOwnershipAsync(WaitUntil.Completed, subscriptionId, content);

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

Sample Response

Status code:

202

Location: https://management.azure.com/providers/Microsoft.Subscription/subscriptionOperations/ODdmYTU0MDktODc5YS00ZTEzLTg2MWItNTQ4ZjYxNzBlOTQw?api-version=2021-10-01
Retry-After: 8

Definitions

Name	Description
AcceptOwnershipRequest	The parameters required to accept subscription ownership.
AcceptOwnershipRequestProperties	Accept subscription ownership request properties.
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.

AcceptOwnershipRequest

The parameters required to accept subscription ownership.

Name	Type	Description
properties	AcceptOwnershipRequestProperties	Accept subscription ownership request properties.

AcceptOwnershipRequestProperties

Accept subscription ownership request properties.

Name	Type	Description
displayName	string	The friendly name of the subscription.
managementGroupId	string	Management group Id for the subscription.
tags	object	Tags for the subscription

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.