Arc Settings - Consent And Install Default Extensions

Servicio:

Azure Stack HCI

Versión de la API:

2024-04-01

Agregar tiempo de consentimiento para las extensiones predeterminadas e iniciar la instalación de extensiones

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/consentAndInstallDefaultExtensions?api-version=2024-04-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
arcSettingName	path	True	string	Nombre del recurso proxy que contiene los detalles de la información de ArcSetting de HCI.
clusterName	path	True	string	Nombre del clúster.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	ArcSetting	De acuerdo
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

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	suplantar la cuenta de usuario

Ejemplos

Consent And Install Default Extensions

Solicitud de ejemplo

HTTP

POST https://management.azure.com/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/consentAndInstallDefaultExtensions?api-version=2024-04-01

Java

/**
 * Samples for ArcSettings ConsentAndInstallDefaultExtensions.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/
     * ConsentAndInstallDefaultExtensions.json
     */
    /**
     * Sample code: Consent And Install Default Extensions.
     * 
     * @param manager Entry point to AzureStackHciManager.
     */
    public static void
        consentAndInstallDefaultExtensions(com.azure.resourcemanager.azurestackhci.AzureStackHciManager manager) {
        manager.arcSettings().consentAndInstallDefaultExtensionsWithResponse("test-rg", "myCluster", "default",
            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.azurestackhci import AzureStackHCIClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-azurestackhci
# USAGE
    python consent_and_install_default_extensions.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 = AzureStackHCIClient(
        credential=DefaultAzureCredential(),
        subscription_id="fd3c3665-1729-4b7b-9a38-238e83b0f98b",
    )

    response = client.arc_settings.consent_and_install_default_extensions(
        resource_group_name="test-rg",
        cluster_name="myCluster",
        arc_setting_name="default",
    )
    print(response)


# x-ms-original-file: specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ConsentAndInstallDefaultExtensions.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 armazurestackhci_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/azurestackhci/armazurestackhci/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ConsentAndInstallDefaultExtensions.json
func ExampleArcSettingsClient_ConsentAndInstallDefaultExtensions() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewArcSettingsClient().ConsentAndInstallDefaultExtensions(ctx, "test-rg", "myCluster", "default", 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.ArcSetting = armazurestackhci.ArcSetting{
	// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters/arcSettings"),
	// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default"),
	// 	SystemData: &armazurestackhci.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
	// 		CreatedBy: to.Ptr("user1"),
	// 		CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-02T17:18:19.123Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user2"),
	// 		LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 	},
	// 	Properties: &armazurestackhci.ArcSettingProperties{
	// 		AggregateState: to.Ptr(armazurestackhci.ArcSettingAggregateStateCreating),
	// 		ArcInstanceResourceGroup: to.Ptr("ArcInstance-rg"),
	// 		ConnectivityProperties: map[string]any{
	// 			"enabled": false,
	// 			"serviceConfigurations":[]any{
	// 			},
	// 		},
	// 		DefaultExtensions: []*armazurestackhci.DefaultExtensionDetails{
	// 			{
	// 				Category: to.Ptr("Telemetry"),
	// 				ConsentTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-01T17:18:19.123Z"); return t}()),
	// 		}},
	// 		PerNodeDetails: []*armazurestackhci.PerNodeState{
	// 			{
	// 				Name: to.Ptr("Node-1"),
	// 				ArcInstance: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1"),
	// 				State: to.Ptr(armazurestackhci.NodeArcStateCreating),
	// 			},
	// 			{
	// 				Name: to.Ptr("Node-2"),
	// 				ArcInstance: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2"),
	// 				State: to.Ptr(armazurestackhci.NodeArcStateCreating),
	// 		}},
	// 		ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
	// 	},
	// }
}

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 { AzureStackHCIClient } = require("@azure/arm-azurestackhci");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Add consent time for default extensions and initiate extensions installation
 *
 * @summary Add consent time for default extensions and initiate extensions installation
 * x-ms-original-file: specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ConsentAndInstallDefaultExtensions.json
 */
async function consentAndInstallDefaultExtensions() {
  const subscriptionId =
    process.env["AZURESTACKHCI_SUBSCRIPTION_ID"] || "fd3c3665-1729-4b7b-9a38-238e83b0f98b";
  const resourceGroupName = process.env["AZURESTACKHCI_RESOURCE_GROUP"] || "test-rg";
  const clusterName = "myCluster";
  const arcSettingName = "default";
  const credential = new DefaultAzureCredential();
  const client = new AzureStackHCIClient(credential, subscriptionId);
  const result = await client.arcSettings.consentAndInstallDefaultExtensions(
    resourceGroupName,
    clusterName,
    arcSettingName,
  );
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Hci.Models;
using Azure.ResourceManager.Hci;

// Generated from example definition: specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ConsentAndInstallDefaultExtensions.json
// this example is just showing the usage of "ArcSettings_ConsentAndInstallDefaultExtensions" 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 ArcSettingResource created on azure
// for more information of creating ArcSettingResource, please refer to the document of ArcSettingResource
string subscriptionId = "fd3c3665-1729-4b7b-9a38-238e83b0f98b";
string resourceGroupName = "test-rg";
string clusterName = "myCluster";
string arcSettingName = "default";
ResourceIdentifier arcSettingResourceId = ArcSettingResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, clusterName, arcSettingName);
ArcSettingResource arcSetting = client.GetArcSettingResource(arcSettingResourceId);

// invoke the operation
ArcSettingResource result = await arcSetting.ConsentAndInstallDefaultExtensionsAsync();

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

{
  "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default",
  "type": "Microsoft.AzureStackHCI/clusters/arcSettings",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "arcInstanceResourceGroup": "ArcInstance-rg",
    "aggregateState": "Creating",
    "perNodeDetails": [
      {
        "name": "Node-1",
        "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1",
        "state": "Creating"
      },
      {
        "name": "Node-2",
        "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2",
        "state": "Creating"
      }
    ],
    "connectivityProperties": {
      "enabled": false,
      "serviceConfigurations": []
    },
    "defaultExtensions": [
      {
        "category": "Telemetry",
        "consentTime": "2023-01-01T17:18:19.1234567Z"
      }
    ]
  }
}

Definiciones

Nombre	Description
ArcConnectivityProperties	Configuración relacionada con la conectividad requerida por arc server.
ArcSetting	Detalles de ArcSetting.
ArcSettingAggregateState	Estado agregado del agente de Arc en los nodos de este clúster de HCI.
createdByType	Tipo de identidad que creó el recurso.
DefaultExtensionDetails	Propiedades de una categoría de extensión predeterminada determinada.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
NodeArcState	Estado del agente de Arc en este nodo.
PerNodeState	Estado del agente de Arc para un nodo determinado en el clúster de HCI.
ProvisioningState	Estado de aprovisionamiento del recurso proxy arcSetting.
ServiceConfiguration	Detalles de configuración del servicio
serviceName	Nombre del servicio.
systemData	Metadatos relativos a la creación y última modificación del recurso.

ArcConnectivityProperties

Object

Configuración relacionada con la conectividad requerida por arc server.

Nombre	Tipo	Description
enabled	boolean	True indica que la conectividad de ARC está habilitada.
serviceConfigurations	ServiceConfiguration[]	Configuraciones de servicio asociadas al recurso de conectividad. El servidor solo los procesa si la propiedad "enabled" está establecida en "true".

ArcSetting

Object

Detalles de ArcSetting.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nombre del recurso
properties.aggregateState	ArcSettingAggregateState	Estado agregado del agente de Arc en los nodos de este clúster de HCI.
properties.arcApplicationClientId	string	Id. de aplicación de la identidad de arc AAD.
properties.arcApplicationObjectId	string	Id. de objeto de la identidad de AAD de arco.
properties.arcApplicationTenantId	string	Identificador de inquilino de la identidad de arc AAD.
properties.arcInstanceResourceGroup	string	El grupo de recursos que hospeda los agentes de Arc, es decir, . Recursos de la máquina de proceso híbrido.
properties.arcServicePrincipalObjectId	string	Id. de objeto de la entidad de servicio de Arc AAD.
properties.connectivityProperties	ArcConnectivityProperties[]	contiene la configuración relacionada con la conectividad para los recursos de ARC.
properties.defaultExtensions	DefaultExtensionDetails[]	Propiedades para cada una de las categorías de extensiones predeterminadas
properties.perNodeDetails	PerNodeState[]	Estado del agente de Arc en cada uno de los nodos.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso proxy arcSetting.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ArcSettingAggregateState

Enumeración

Estado agregado del agente de Arc en los nodos de este clúster de HCI.

Valor	Description
Accepted
Canceled
Connected
Creating
Deleted
Deleting
DisableInProgress
Disconnected
Error
Failed
InProgress
Moving
NotSpecified
PartiallyConnected
PartiallySucceeded
Provisioning
Succeeded
Updating

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

DefaultExtensionDetails

Object

Propiedades de una categoría de extensión predeterminada determinada.

Nombre	Tipo	Description
category	string	Categoría de extensión predeterminada
consentTime	string (date-time)	Tiempo de consentimiento para la categoría de extensión

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

NodeArcState

Enumeración

Estado del agente de Arc en este nodo.

Valor	Description
Accepted
Canceled
Connected
Creating
Deleted
Deleting
DisableInProgress
Disconnected
Error
Failed
InProgress
Moving
NotSpecified
PartiallyConnected
PartiallySucceeded
Provisioning
Succeeded
Updating

PerNodeState

Object

Estado del agente de Arc para un nodo determinado en el clúster de HCI.

Nombre	Tipo	Description
arcInstance	string	Identificador de recurso completo para el agente de Arc de este nodo.
arcNodeServicePrincipalObjectId	string	Identificador de entidad de servicio del arco para el nodo de servidor
name	string	Nombre del nodo en el clúster de HCI
state	NodeArcState	Estado del agente de Arc en este nodo.

ProvisioningState

Enumeración

Estado de aprovisionamiento del recurso proxy arcSetting.

Valor	Description
Accepted
Canceled
Connected
Creating
Deleted
Deleting
DisableInProgress
Disconnected
Error
Failed
InProgress
Moving
NotSpecified
PartiallyConnected
PartiallySucceeded
Provisioning
Succeeded
Updating

ServiceConfiguration

Object

Detalles de configuración del servicio

Nombre	Tipo	Description
port	integer (int64)	Puerto en el que está habilitado el servicio.
serviceName	serviceName	Nombre del servicio.

serviceName

Enumeración

Nombre del servicio.

Valor	Description
WAC

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.