Cluster Managers - Get

Dienst:

Operator Nexus - Network Cloud

API-Version:

2024-07-01

Rufen Sie den Cluster-Manager ab.
Dient zum Abrufen der Eigenschaften des bereitgestellten Cluster-Managers.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusterManagers/{clusterManagerName}?api-version=2024-07-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
clusterManagerName	path	True	string pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$	Der Name des Cluster-Managers.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	ClusterManager	Die Ressource wurde erfolgreich abgerufen.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get cluster manager

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName?api-version=2024-07-01

Java

/**
 * Samples for ClusterManagers GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Get
     * .json
     */
    /**
     * Sample code: Get cluster manager.
     * 
     * @param manager Entry point to NetworkCloudManager.
     */
    public static void getClusterManager(com.azure.resourcemanager.networkcloud.NetworkCloudManager manager) {
        manager.clusterManagers().getByResourceGroupWithResponse("resourceGroupName", "clusterManagerName",
            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.networkcloud import NetworkCloudMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-networkcloud
# USAGE
    python cluster_managers_get.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 = NetworkCloudMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="123e4567-e89b-12d3-a456-426655440000",
    )

    response = client.cluster_managers.get(
        resource_group_name="resourceGroupName",
        cluster_manager_name="clusterManagerName",
    )
    print(response)


# x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Get.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 armnetworkcloud_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/networkcloud/armnetworkcloud"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c0a12a75b702054cf1e7fcd8c014d0fc116dea6e/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Get.json
func ExampleClusterManagersClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetworkcloud.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewClusterManagersClient().Get(ctx, "resourceGroupName", "clusterManagerName", 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.ClusterManager = armnetworkcloud.ClusterManager{
	// 	Name: to.Ptr("clusterManagerName"),
	// 	Type: to.Ptr("Microsoft.NetworkCloud/clusterManagers"),
	// 	ID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName"),
	// 	SystemData: &armnetworkcloud.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-22T13:27:03.008Z"); return t}()),
	// 		CreatedBy: to.Ptr("identityA"),
	// 		CreatedByType: to.Ptr(armnetworkcloud.CreatedByTypeApplication),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-22T13:29:03.001Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("identityB"),
	// 		LastModifiedByType: to.Ptr(armnetworkcloud.CreatedByTypeUser),
	// 	},
	// 	Location: to.Ptr("location"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("myvalue1"),
	// 		"key2": to.Ptr("myvalue2"),
	// 	},
	// 	Identity: &armnetworkcloud.ManagedServiceIdentity{
	// 		Type: to.Ptr(armnetworkcloud.ManagedServiceIdentityTypeSystemAssigned),
	// 		PrincipalID: to.Ptr("321e7654-e89b-12d3-a456-426655449999"),
	// 		TenantID: to.Ptr("199e9999-e89b-12d3-a456-426655441111"),
	// 	},
	// 	Properties: &armnetworkcloud.ClusterManagerProperties{
	// 		AnalyticsWorkspaceID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName"),
	// 		ClusterVersions: []*armnetworkcloud.ClusterAvailableVersion{
	// 			{
	// 				SupportExpiryDate: to.Ptr("2023-04-29"),
	// 				TargetClusterVersion: to.Ptr("1.0.0"),
	// 			},
	// 			{
	// 				SupportExpiryDate: to.Ptr("2025-01-01"),
	// 				TargetClusterVersion: to.Ptr("1.0.2"),
	// 		}},
	// 		DetailedStatus: to.Ptr(armnetworkcloud.ClusterManagerDetailedStatusAvailable),
	// 		DetailedStatusMessage: to.Ptr("cluster manager is up and running"),
	// 		FabricControllerID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName"),
	// 		ManagedResourceGroupConfiguration: &armnetworkcloud.ManagedResourceGroupConfiguration{
	// 			Name: to.Ptr("my-managed-rg"),
	// 			Location: to.Ptr("East US"),
	// 		},
	// 		ManagerExtendedLocation: &armnetworkcloud.ExtendedLocation{
	// 			Name: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName"),
	// 			Type: to.Ptr("CustomLocation"),
	// 		},
	// 		ProvisioningState: to.Ptr(armnetworkcloud.ClusterManagerProvisioningStateSucceeded),
	// 	},
	// }
}

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 { NetworkCloud } = require("@azure/arm-networkcloud");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Get the properties of the provided cluster manager.
 *
 * @summary Get the properties of the provided cluster manager.
 * x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Get.json
 */
async function getClusterManager() {
  const subscriptionId =
    process.env["NETWORKCLOUD_SUBSCRIPTION_ID"] || "123e4567-e89b-12d3-a456-426655440000";
  const resourceGroupName = process.env["NETWORKCLOUD_RESOURCE_GROUP"] || "resourceGroupName";
  const clusterManagerName = "clusterManagerName";
  const credential = new DefaultAzureCredential();
  const client = new NetworkCloud(credential, subscriptionId);
  const result = await client.clusterManagers.get(resourceGroupName, clusterManagerName);
  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.Models;
using Azure.ResourceManager.NetworkCloud.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.NetworkCloud;

// Generated from example definition: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Get.json
// this example is just showing the usage of "ClusterManagers_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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "123e4567-e89b-12d3-a456-426655440000";
string resourceGroupName = "resourceGroupName";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this NetworkCloudClusterManagerResource
NetworkCloudClusterManagerCollection collection = resourceGroupResource.GetNetworkCloudClusterManagers();

// invoke the operation
string clusterManagerName = "clusterManagerName";
NullableResponse<NetworkCloudClusterManagerResource> response = await collection.GetIfExistsAsync(clusterManagerName);
NetworkCloudClusterManagerResource 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
    NetworkCloudClusterManagerData 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

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName",
  "name": "clusterManagerName",
  "systemData": {
    "createdAt": "2021-01-22T13:27:03.008Z",
    "createdBy": "identityA",
    "createdByType": "Application",
    "lastModifiedAt": "2021-01-22T13:29:03.001Z",
    "lastModifiedBy": "identityB",
    "lastModifiedByType": "User"
  },
  "type": "Microsoft.NetworkCloud/clusterManagers",
  "location": "location",
  "tags": {
    "key1": "myvalue1",
    "key2": "myvalue2"
  },
  "identity": {
    "principalId": "321e7654-e89b-12d3-a456-426655449999",
    "tenantId": "199e9999-e89b-12d3-a456-426655441111",
    "type": "SystemAssigned"
  },
  "properties": {
    "managerExtendedLocation": {
      "type": "CustomLocation",
      "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName"
    },
    "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName",
    "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName",
    "clusterVersions": [
      {
        "targetClusterVersion": "1.0.0",
        "supportExpiryDate": "2023-04-29"
      },
      {
        "targetClusterVersion": "1.0.2",
        "supportExpiryDate": "2025-01-01"
      }
    ],
    "provisioningState": "Succeeded",
    "detailedStatus": "Available",
    "detailedStatusMessage": "cluster manager is up and running",
    "managedResourceGroupConfiguration": {
      "name": "my-managed-rg",
      "location": "East US"
    }
  }
}

Definitionen

Name	Beschreibung
ClusterAvailableVersion	ClusterAvailableVersion stellt die Clusterversion dar, die der Cluster-Manager zum Erstellen und Verwalten aufgefordert werden kann.
ClusterManager	ClusterManager stellt eine Steuerungsebene zum Verwalten eines oder mehrerer lokaler Cluster dar.
ClusterManagerDetailedStatus	Der detaillierte Status, der zusätzliche Informationen zum Cluster-Manager bereitstellt.
ClusterManagerProvisioningState	Der Bereitstellungsstatus des Cluster-Managers.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ExtendedLocation	ExtendedLocation stellt den benutzerdefinierten Azure-Speicherort dar, an dem die Ressource erstellt wird.
ManagedResourceGroupConfiguration	ManagedResourceGroupConfiguration stellt die Konfiguration der von Azure verwalteten Ressourcengruppe dar.
ManagedServiceIdentity	Verwaltete Dienstidentität (vom System zugewiesene und/oder vom Benutzer zugewiesene Identitäten)
ManagedServiceIdentityType	Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind).
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
UserAssignedIdentity	Benutzer zugewiesene Identitätseigenschaften

ClusterAvailableVersion

Objekt

ClusterAvailableVersion stellt die Clusterversion dar, die der Cluster-Manager zum Erstellen und Verwalten aufgefordert werden kann.

Name	Typ	Beschreibung
supportExpiryDate	string	Das letzte Datum, an dem die Version der Plattform unterstützt wird.
targetClusterVersion	string	Die Version des clusters, die bereitgestellt werden soll.

ClusterManager

Objekt

ClusterManager stellt eine Steuerungsebene zum Verwalten eines oder mehrerer lokaler Cluster dar.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	Die Identität des Cluster-Managers.
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.analyticsWorkspaceId	string (arm-id)	Die Ressourcen-ID des Log Analytics-Arbeitsbereichs, der für die Protokollsammlung verwendet wird.
properties.availabilityZones	string[]	Das Feld ist veraltet, dieser Wert beeinflusst nicht mehr den Cluster-Manager-Zuordnungsprozess und wird in einer zukünftigen Version entfernt. Die Azure-Verfügbarkeitszonen innerhalb der Region, die zur Unterstützung der Cluster-Manager-Ressource verwendet werden.
properties.clusterVersions	ClusterAvailableVersion[]	Die Liste der Clusterversionen, die der Manager unterstützt. Sie wird als Eingabe in der clusterVersion-Eigenschaft einer Clusterressource verwendet.
properties.detailedStatus	ClusterManagerDetailedStatus	Der detaillierte Status, der zusätzliche Informationen zum Cluster-Manager bereitstellt.
properties.detailedStatusMessage	string	Die beschreibende Meldung über den aktuellen detaillierten Status.
properties.fabricControllerId	string (arm-id)	Die Ressourcen-ID des Fabric-Controllers mit einer Zuordnung mit dem Cluster-Manager.
properties.managedResourceGroupConfiguration	ManagedResourceGroupConfiguration	ManagedResourceGroupConfiguration stellt die Konfiguration der von Azure verwalteten Ressourcengruppe dar. Die Konfiguration der verwalteten Ressourcengruppe, die der Ressource zugeordnet ist.
properties.managerExtendedLocation	ExtendedLocation	ExtendedLocation stellt den benutzerdefinierten Azure-Speicherort dar, an dem die Ressource erstellt wird. Die erweiterte Position (benutzerdefinierte Position), die den Standort des Clustermanagers an der Steuerebene darstellt. Dieser erweiterte Speicherort wird beim Erstellen von Cluster- und Rackmanifestressourcen verwendet.
properties.provisioningState	ClusterManagerProvisioningState	Der Bereitstellungsstatus des Cluster-Managers.
properties.vmSize	string	Das Feld ist veraltet, dieser Wert beeinflusst nicht mehr den Cluster-Manager-Zuordnungsprozess und wird in einer zukünftigen Version entfernt. Die Größe der virtuellen Azure-Computer, die zum Hosten der Cluster-Manager-Ressource verwendet werden sollen.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ClusterManagerDetailedStatus

Enumeration

Der detaillierte Status, der zusätzliche Informationen zum Cluster-Manager bereitstellt.

Wert	Beschreibung
Available
Error
Provisioning
ProvisioningFailed
UpdateFailed
Updating

ClusterManagerProvisioningState

Enumeration

Der Bereitstellungsstatus des Cluster-Managers.

Wert	Beschreibung
Accepted
Canceled
Failed
Provisioning
Succeeded
Updating

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ExtendedLocation

Objekt

ExtendedLocation stellt den benutzerdefinierten Azure-Speicherort dar, an dem die Ressource erstellt wird.

Name	Typ	Beschreibung
name	string	Die Ressourcen-ID des erweiterten Speicherorts, an dem die Ressource erstellt wird.
type	string	Der erweiterte Standorttyp, z. B. CustomLocation.

ManagedResourceGroupConfiguration

Objekt

ManagedResourceGroupConfiguration stellt die Konfiguration der von Azure verwalteten Ressourcengruppe dar.

Name	Typ	Beschreibung
location	string	Der Speicherort der verwalteten Ressourcengruppe. Wenn nicht angegeben, wird der Speicherort der übergeordneten Ressource ausgewählt.
name	string maxLength: 75	Der Name für die verwaltete Ressourcengruppe. Wenn nicht angegeben, wird der eindeutige Name automatisch generiert.

ManagedServiceIdentity

Objekt

Verwaltete Dienstidentität (vom System zugewiesene und/oder vom Benutzer zugewiesene Identitäten)

Name	Typ	Beschreibung
principalId	string (uuid)	Die Dienstprinzipal-ID der vom System zugewiesenen Identität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.
tenantId	string (uuid)	Die Mandanten-ID der vom System zugewiesenen Identität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.
type	ManagedServiceIdentityType	Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind).
userAssignedIdentities	<string,  UserAssignedIdentity>	User-Assigned Identitäten Die Gruppe der benutzerzuweisungen Identitäten, die der Ressource zugeordnet sind. Die Wörterbuchschlüssel "userAssignedIdentities" sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Die Wörterbuchwerte können leere Objekte ({}) in Anforderungen sein.

ManagedServiceIdentityType

Enumeration

Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind).

Wert	Beschreibung
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

UserAssignedIdentity

Objekt

Benutzer zugewiesene Identitätseigenschaften

Name	Typ	Beschreibung
clientId	string (uuid)	Die Client-ID der zugewiesenen Identität.
principalId	string (uuid)	Die Prinzipal-ID der zugewiesenen Identität.