Extensions - Get

Szolgáltatás:

Azure Stack HCI

API-verzió:

2024-04-01

A HCI-fürt adott Arc-bővítményének lekérése.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
arcSettingName	path	True	string	A HCI ArcSetting információit tartalmazó proxyerőforrás neve.
clusterName	path	True	string	A fürt neve.
extensionName	path	True	string	A gép bővítményének neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string minLength: 1	A cél-előfizetés azonosítója.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	Extension	OKÉ
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Get ArcSettings Extension

Mintakérelem

HTTP

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

Java

/**
 * Samples for Extensions Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/
     * GetExtension.json
     */
    /**
     * Sample code: Get ArcSettings Extension.
     * 
     * @param manager Entry point to AzureStackHciManager.
     */
    public static void getArcSettingsExtension(com.azure.resourcemanager.azurestackhci.AzureStackHciManager manager) {
        manager.extensions().getWithResponse("test-rg", "myCluster", "default", "MicrosoftMonitoringAgent",
            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 get_extension.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.extensions.get(
        resource_group_name="test-rg",
        cluster_name="myCluster",
        arc_setting_name="default",
        extension_name="MicrosoftMonitoringAgent",
    )
    print(response)


# x-ms-original-file: specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetExtension.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/GetExtension.json
func ExampleExtensionsClient_Get() {
	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.NewExtensionsClient().Get(ctx, "test-rg", "myCluster", "default", "MicrosoftMonitoringAgent", 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.Extension = armazurestackhci.Extension{
	// 	Name: to.Ptr("MicrosoftMonitoringAgent"),
	// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters/arcSettings/extensions"),
	// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent"),
	// 	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.ExtensionProperties{
	// 		AggregateState: to.Ptr(armazurestackhci.ExtensionAggregateStatePartiallySucceeded),
	// 		ExtensionParameters: &armazurestackhci.ExtensionParameters{
	// 			Type: to.Ptr("string"),
	// 			AutoUpgradeMinorVersion: to.Ptr(false),
	// 			EnableAutomaticUpgrade: to.Ptr(true),
	// 			Publisher: to.Ptr("Microsoft.Compute"),
	// 			Settings: map[string]any{
	// 				"workspaceId": "xx",
	// 			},
	// 			TypeHandlerVersion: to.Ptr("1.10.3"),
	// 		},
	// 		ManagedBy: to.Ptr(armazurestackhci.ExtensionManagedByAzure),
	// 		PerNodeExtensionDetails: []*armazurestackhci.PerNodeExtensionState{
	// 			{
	// 				Name: to.Ptr("Node-1"),
	// 				Extension: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent"),
	// 				InstanceView: &armazurestackhci.ExtensionInstanceView{
	// 					Name: to.Ptr("MicrosoftMonitoringAgent"),
	// 					Type: to.Ptr("MicrosoftMonitoringAgent"),
	// 					Status: &armazurestackhci.ExtensionInstanceViewStatus{
	// 						Code: to.Ptr("success"),
	// 						DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 						Level: to.Ptr(armazurestackhci.StatusLevelTypes("Information")),
	// 						Message: to.Ptr("Finished executing command, StdOut: , StdErr:"),
	// 						Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-08-08T20:42:10.999Z"); return t}()),
	// 					},
	// 					TypeHandlerVersion: to.Ptr("1.10.0"),
	// 				},
	// 				State: to.Ptr(armazurestackhci.NodeExtensionStateSucceeded),
	// 				TypeHandlerVersion: to.Ptr("1.10.0"),
	// 			},
	// 			{
	// 				Name: to.Ptr("Node-2"),
	// 				Extension: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent"),
	// 				InstanceView: &armazurestackhci.ExtensionInstanceView{
	// 					Name: to.Ptr("MicrosoftMonitoringAgent"),
	// 					Type: to.Ptr("MicrosoftMonitoringAgent"),
	// 					Status: &armazurestackhci.ExtensionInstanceViewStatus{
	// 						Code: to.Ptr("error"),
	// 						DisplayStatus: to.Ptr("Provisioning failed"),
	// 						Level: to.Ptr(armazurestackhci.StatusLevelTypesError),
	// 						Message: to.Ptr("Finished executing command, StdOut: , StdErr:"),
	// 						Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-08-08T20:42:10.999Z"); return t}()),
	// 					},
	// 					TypeHandlerVersion: to.Ptr("1.10.3"),
	// 				},
	// 				State: to.Ptr(armazurestackhci.NodeExtensionStateFailed),
	// 				TypeHandlerVersion: to.Ptr("1.10.3"),
	// 		}},
	// 		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 Get particular Arc Extension of HCI Cluster.
 *
 * @summary Get particular Arc Extension of HCI Cluster.
 * x-ms-original-file: specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetExtension.json
 */
async function getArcSettingsExtension() {
  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 extensionName = "MicrosoftMonitoringAgent";
  const credential = new DefaultAzureCredential();
  const client = new AzureStackHCIClient(credential, subscriptionId);
  const result = await client.extensions.get(
    resourceGroupName,
    clusterName,
    arcSettingName,
    extensionName,
  );
  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;

// Generated from example definition: specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetExtension.json
// this example is just showing the usage of "Extensions_Get" 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);

// get the collection of this ArcExtensionResource
ArcExtensionCollection collection = arcSetting.GetArcExtensions();

// invoke the operation
string extensionName = "MicrosoftMonitoringAgent";
NullableResponse<ArcExtensionResource> response = await collection.GetIfExistsAsync(extensionName);
ArcExtensionResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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
    ArcExtensionData 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

Mintaválasz

Állapotkód:

200

{
  "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent",
  "name": "MicrosoftMonitoringAgent",
  "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions",
  "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",
    "extensionParameters": {
      "publisher": "Microsoft.Compute",
      "type": "string",
      "typeHandlerVersion": "1.10.3",
      "autoUpgradeMinorVersion": false,
      "enableAutomaticUpgrade": true,
      "settings": {
        "workspaceId": "xx"
      }
    },
    "aggregateState": "PartiallySucceeded",
    "perNodeExtensionDetails": [
      {
        "name": "Node-1",
        "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent",
        "state": "Succeeded",
        "typeHandlerVersion": "1.10.0",
        "instanceView": {
          "name": "MicrosoftMonitoringAgent",
          "type": "MicrosoftMonitoringAgent",
          "typeHandlerVersion": "1.10.0",
          "status": {
            "code": "success",
            "level": "Information",
            "displayStatus": "Provisioning succeeded",
            "message": "Finished executing command, StdOut: , StdErr:",
            "time": "2019-08-08T20:42:10.999Z"
          }
        }
      },
      {
        "name": "Node-2",
        "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent",
        "state": "Failed",
        "typeHandlerVersion": "1.10.3",
        "instanceView": {
          "name": "MicrosoftMonitoringAgent",
          "type": "MicrosoftMonitoringAgent",
          "typeHandlerVersion": "1.10.3",
          "status": {
            "code": "error",
            "level": "Error",
            "displayStatus": "Provisioning failed",
            "message": "Finished executing command, StdOut: , StdErr:",
            "time": "2019-08-08T20:42:10.999Z"
          }
        }
      }
    ],
    "managedBy": "Azure"
  }
}

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
Extension	A HCI-fürt egy adott bővítményének részletei.
ExtensionAggregateState	Az Arc-bővítmények összesített állapota a HCI-fürt csomópontjai között.
ExtensionInstanceView	A bővítménypéldány nézetet ismerteti.
ExtensionManagedBy	Azt jelzi, hogy a bővítményt az Azure vagy a felhasználó kezeli-e.
NodeExtensionState	Az Arc-bővítmény állapota ebben a csomópontban.
PerNodeExtensionState	A HCI-fürt egy adott csomópontjához tartozó Arc-bővítmény állapota.
ProvisioningState	A bővítményproxy-erőforrás kiépítési állapota.
Status	Példánynézet állapota.
StatusLevelTypes	A szintkód.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

Extension

Objektum

A HCI-fürt egy adott bővítményének részletei.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.aggregateState	ExtensionAggregateState	Az Arc-bővítmények összesített állapota a HCI-fürt csomópontjai között.
properties.extensionParameters.autoUpgradeMinorVersion	boolean	Azt jelzi, hogy a bővítménynek egy újabb alverziót kell-e használnia, ha az üzembe helyezéskor elérhető. Az üzembe helyezés után azonban a bővítmény csak akkor frissíti az alverziókat, ha újra üzembe helyezi, még akkor sem, ha ez a tulajdonság igaz értékre van állítva.
properties.extensionParameters.enableAutomaticUpgrade	boolean	Azt jelzi, hogy a bővítményt automatikusan frissítenie kell-e a platformnak, ha újabb verzió érhető el.
properties.extensionParameters.forceUpdateTag	string	Hogyan kell a bővítménykezelőt frissíteni, még akkor is, ha a bővítménykonfiguráció nem változott.
properties.extensionParameters.protectedSettings	object	Védett beállítások (titkos kódokat tartalmazhatnak).
properties.extensionParameters.publisher	string	A bővítménykezelő közzétevőjének neve.
properties.extensionParameters.settings	object	Json formátumú nyilvános beállítások a bővítményhez.
properties.extensionParameters.type	string	Megadja a bővítmény típusát; Ilyen például a "CustomScriptExtension".
properties.extensionParameters.typeHandlerVersion	string	A szkriptkezelő verzióját adja meg. Ha nincs megadva, a legújabb verzió lesz használva.
properties.managedBy	ExtensionManagedBy	Azt jelzi, hogy a bővítményt az Azure vagy a felhasználó kezeli-e.
properties.perNodeExtensionDetails	PerNodeExtensionState[]	Az Arc-bővítmény állapota az egyes csomópontokban.
properties.provisioningState	ProvisioningState	A bővítményproxy-erőforrás kiépítési állapota.
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

ExtensionAggregateState

Enumerálás

Az Arc-bővítmények összesített állapota a HCI-fürt csomópontjai között.

Érték	Description
Accepted
Canceled
Connected
Creating
Deleted
Deleting
Disconnected
Error
Failed
InProgress
Moving
NotSpecified
PartiallyConnected
PartiallySucceeded
Provisioning
Succeeded
Updating
UpgradeFailedRollbackSucceeded

ExtensionInstanceView

Objektum

A bővítménypéldány nézetet ismerteti.

Name	Típus	Description
name	string	A bővítmény neve.
status	Status	Példánynézet állapota.
type	string	Megadja a bővítmény típusát; Ilyen például a "MicrosoftMonitoringAgent".
typeHandlerVersion	string	A szkriptkezelő verzióját adja meg.

ExtensionManagedBy

Enumerálás

Azt jelzi, hogy a bővítményt az Azure vagy a felhasználó kezeli-e.

Érték	Description
Azure
User

NodeExtensionState

Enumerálás

Az Arc-bővítmény állapota ebben a csomópontban.

Érték	Description
Accepted
Canceled
Connected
Creating
Deleted
Deleting
Disconnected
Error
Failed
InProgress
Moving
NotSpecified
PartiallyConnected
PartiallySucceeded
Provisioning
Succeeded
Updating

PerNodeExtensionState

Objektum

A HCI-fürt egy adott csomópontjához tartozó Arc-bővítmény állapota.

Name	Típus	Description
extension	string	A csomópont adott Arc-bővítményének teljes erőforrás-azonosítója.
instanceView	ExtensionInstanceView	A bővítménypéldány nézete.
name	string	A HCI-fürt csomópontjának neve.
state	NodeExtensionState	Az Arc-bővítmény állapota ebben a csomópontban.
typeHandlerVersion	string	A szkriptkezelő verzióját adja meg.

ProvisioningState

Enumerálás

A bővítményproxy-erőforrás kiépítési állapota.

Érték	Description
Accepted
Canceled
Connected
Creating
Deleted
Deleting
Disconnected
Error
Failed
InProgress
Moving
NotSpecified
PartiallyConnected
PartiallySucceeded
Provisioning
Succeeded
Updating

Status

Objektum

Példánynézet állapota.

Name	Típus	Description
code	string	Az állapotkód.
displayStatus	string	Az állapot rövid honosítható címkéje.
level	StatusLevelTypes	A szintkód.
message	string	A részletes állapotüzenet, beleértve a riasztásokat és a hibaüzeneteket is.
time	string (date-time)	Az állapot időpontja.

StatusLevelTypes

Enumerálás

A szintkód.

Érték	Description
Error
Info
Warning

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.