Features - Register

Servicio:

Resource Management

Versión de la API:

2021-07-01

Registra la característica en versión preliminar de la suscripción.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
featureName	path	True	string	Nombre de la característica que se va a registrar.
resourceProviderNamespace	path	True	string	Espacio de nombres del proveedor de recursos.
subscriptionId	path	True	string	El identificador de la suscripción de Azure.
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	FeatureResult	Aceptar: devuelve metadatos sobre la característica registrada. Los metadatos incluyen el nombre de la característica, el estado de registro, el identificador de recurso y el tipo de recurso. Media Types: "application/json", "text/json"
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación. Media Types: "application/json", "text/json"

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Register feature

Solicitud de ejemplo

HTTP

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

Java

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

Python

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

Go

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

JavaScript

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

dotnet

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

Respuesta de muestra

status code:

200

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

Definiciones

Nombre	Description
ErrorDefinition	Definición de error.
ErrorResponse	La respuesta de error indica que el servicio no puede procesar la solicitud entrante.
FeatureProperties	Información sobre la característica.
FeatureResult	Información de características en versión preliminar.

ErrorDefinition

Definición de error.

Nombre	Tipo	Description
code	string	Código de error específico del servicio que actúa como subestado para el código de error HTTP.
details	ErrorDefinition[]	Detalles internos del error.
message	string	Descripción del error.

ErrorResponse

La respuesta de error indica que el servicio no puede procesar la solicitud entrante.

Nombre	Tipo	Description
error	ErrorDefinition	Los detalles del error.

FeatureProperties

Información sobre la característica.

Nombre	Tipo	Description
state	string	Estado de registro de la característica de la suscripción.

FeatureResult

Información de características en versión preliminar.

Nombre	Tipo	Description
id	string	Identificador de recurso de la característica.
name	string	Nombre de la característica.
properties	FeatureProperties	Propiedades de la característica en versión preliminar.
type	string	Tipo de recurso de la característica.