Features - Register

Reference

Service:: Resource Management

API Version:: 2021-07-01

Registers the preview feature for the subscription.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Features/providers/{resourceProviderNamespace}/features/{featureName}/register?api-version=2021-07-01

URI Parameters

Name	In	Required	Type	Description
featureName	path	True	string	The name of the feature to register.
resourceProviderNamespace	path	True	string	The namespace of the resource provider.
subscriptionId	path	True	string	The Azure subscription ID.
api-version	query	True	string	The API version to use for this operation.

Responses

Name

Type

Description

200 OK

OK - Returns metadata about the registered feature. The metadata includes the name of the feature, the registration state, the resource ID, and resource type.

Media Types: "application/json", "text/json"

Other Status Codes

Error response describing the reason for operation failure.

Media Types: "application/json", "text/json"

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

Register feature

Sample request

POST https://management.azure.com/subscriptions/subid/providers/Microsoft.Features/providers/Resource Provider Namespace/features/feature/register?api-version=2021-07-01


/**
 * Samples for Features Register.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/registerFeature.json
     */
    /**
     * Sample code: Register feature.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void registerFeature(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().featureClient().getFeatures()
            .registerWithResponse("Resource Provider Namespace", "feature", com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource import FeatureClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python register_feature.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 = FeatureClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.features.register(
        resource_provider_namespace="Resource Provider Namespace",
        feature_name="feature",
    )
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/registerFeature.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 armfeatures_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armfeatures"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0cc5e2efd6ffccf30e80d1e150b488dd87198b94/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/registerFeature.json
func ExampleClient_Register() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armfeatures.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewClient().Register(ctx, "Resource Provider Namespace", "feature", 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.FeatureResult = armfeatures.FeatureResult{
	// 	Name: to.Ptr("Feature1"),
	// 	Type: to.Ptr("type1"),
	// 	ID: to.Ptr("feature_id1"),
	// 	Properties: &armfeatures.FeatureProperties{
	// 		State: to.Ptr("registered"),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Registers the preview feature for the subscription.
 *
 * @summary Registers the preview feature for the subscription.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/registerFeature.json
 */
async function registerFeature() {
  const subscriptionId = "subid";
  const resourceProviderNamespace = "Resource Provider Namespace";
  const featureName = "feature";
  const credential = new DefaultAzureCredential();
  const client = new FeatureClient(credential, subscriptionId);
  const result = await client.features.register(resourceProviderNamespace, featureName);
  console.log(result);
}

registerFeature().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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/registerFeature.json
// this example is just showing the usage of "Features_Register" 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://video2.skills-academy.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 FeatureResource created on azure
// for more information of creating FeatureResource, please refer to the document of FeatureResource
string subscriptionId = "subid";
string resourceProviderNamespace = "Resource Provider Namespace";
string featureName = "feature";
ResourceIdentifier featureResourceId = FeatureResource.CreateResourceIdentifier(subscriptionId, resourceProviderNamespace, featureName);
FeatureResource feature = client.GetFeatureResource(featureResourceId);

// invoke the operation
FeatureResource result = await feature.RegisterAsync();

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

{
  "name": "Feature1",
  "properties": {
    "state": "registered"
  },
  "id": "feature_id1",
  "type": "type1"
}

Definitions

Name	Description
ErrorDefinition	Error definition.
ErrorResponse	Error response indicates that the service is not able to process the incoming request.
FeatureProperties	Information about feature.
FeatureResult	Previewed feature information.

ErrorDefinition

Error definition.

Name	Type	Description
code	string	Service specific error code which serves as the substatus for the HTTP error code.
details	ErrorDefinition[]	Internal error details.
message	string	Description of the error.

ErrorResponse

Error response indicates that the service is not able to process the incoming request.

Name	Type	Description
error	ErrorDefinition	The error details.

FeatureProperties

Information about feature.

Name	Type	Description
state	string	The registration state of the feature for the subscription.

FeatureResult

Previewed feature information.

Name	Type	Description
id	string	The resource ID of the feature.
name	string	The name of the feature.
properties	FeatureProperties	Properties of the previewed feature.
type	string	The resource type of the feature.