Servers - List By Resource Group

Referenz

Dienst:: Analysis Services

API-Version:: 2017-08-01

Ruft alle Analysis Services-Server für die angegebene Ressourcengruppe ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers?api-version=2017-08-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Der Name der Azure-Ressourcengruppe, von der ein bestimmter Analysis Services-Server Teil ist. Dieser Name muss mindestens 1 Zeichen lang und nicht mehr als 90 Zeichen lang sein.
subscriptionId	path	True	string	Ein eindeutiger Bezeichner für ein Microsoft Azure-Abonnement. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Die Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	AnalysisServicesServers	OKAY
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

List existing servers in the resource group.

Beispielanforderung

GET https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.AnalysisServices/servers?api-version=2017-08-01

package armanalysisservices_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/analysisservices/armanalysisservices"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-08-01/examples/listServersInResourceGroup.json
func ExampleServersClient_NewListByResourceGroupPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armanalysisservices.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewServersClient().NewListByResourceGroupPager("TestRG", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.Servers = armanalysisservices.Servers{
		// 	Value: []*armanalysisservices.Server{
		// 		{
		// 			Name: to.Ptr("azsdktest"),
		// 			ID: to.Ptr("/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.AnalysisServices/servers/azsdktest"),
		// 			Location: to.Ptr("West US"),
		// 			SKU: &armanalysisservices.ResourceSKU{
		// 				Name: to.Ptr("S1"),
		// 				Capacity: to.Ptr[int32](1),
		// 				Tier: to.Ptr(armanalysisservices.SKUTierStandard),
		// 			},
		// 			Tags: map[string]*string{
		// 				"testKey": to.Ptr("testValue"),
		// 			},
		// 			Properties: &armanalysisservices.ServerProperties{
		// 				AsAdministrators: &armanalysisservices.ServerAdministrators{
		// 					Members: []*string{
		// 						to.Ptr("azsdktest@microsoft.com")},
		// 					},
		// 					ProvisioningState: to.Ptr(armanalysisservices.ProvisioningStateSucceeded),
		// 					ServerFullName: to.Ptr("asazure://nightly1.asazure-int.windows.net/azsdktest"),
		// 					State: to.Ptr(armanalysisservices.StateProvisioning),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("azsdktest2"),
		// 				ID: to.Ptr("/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.AnalysisServices/servers/azsdktest"),
		// 				Location: to.Ptr("West US"),
		// 				SKU: &armanalysisservices.ResourceSKU{
		// 					Name: to.Ptr("S0"),
		// 					Capacity: to.Ptr[int32](1),
		// 					Tier: to.Ptr(armanalysisservices.SKUTierStandard),
		// 				},
		// 				Tags: map[string]*string{
		// 					"testKey": to.Ptr("testValue"),
		// 				},
		// 				Properties: &armanalysisservices.ServerProperties{
		// 					AsAdministrators: &armanalysisservices.ServerAdministrators{
		// 						Members: []*string{
		// 							to.Ptr("azsdktest@microsoft.com")},
		// 						},
		// 						ProvisioningState: to.Ptr(armanalysisservices.ProvisioningStateSucceeded),
		// 						ServerFullName: to.Ptr("asazure://nightly1.asazure-int.windows.net/azsdktest"),
		// 						State: to.Ptr(armanalysisservices.StateProvisioning),
		// 					},
		// 			}},
		// 		}
	}
}

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

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

/**
 * This sample demonstrates how to Gets all the Analysis Services servers for the given resource group.
 *
 * @summary Gets all the Analysis Services servers for the given resource group.
 * x-ms-original-file: specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-08-01/examples/listServersInResourceGroup.json
 */
async function listExistingServersInTheResourceGroup() {
  const subscriptionId = "613192d7-503f-477a-9cfe-4efc3ee2bd60";
  const resourceGroupName = "TestRG";
  const credential = new DefaultAzureCredential();
  const client = new AzureAnalysisServices(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.servers.listByResourceGroup(resourceGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

listExistingServersInTheResourceGroup().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.Analysis;
using Azure.ResourceManager.Analysis.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-08-01/examples/listServersInResourceGroup.json
// this example is just showing the usage of "Servers_ListByResourceGroup" 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 = "613192d7-503f-477a-9cfe-4efc3ee2bd60";
string resourceGroupName = "TestRG";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this AnalysisServerResource
AnalysisServerCollection collection = resourceGroupResource.GetAnalysisServers();

// invoke the operation and iterate over the result
await foreach (AnalysisServerResource item in collection.GetAllAsync())
{
    // the variable item 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
    AnalysisServerData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "value": [
    {
      "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.AnalysisServices/servers/azsdktest",
      "location": "West US",
      "name": "azsdktest",
      "properties": {
        "asAdministrators": {
          "members": [
            "azsdktest@microsoft.com"
          ]
        },
        "provisioningState": "Provisioning",
        "serverFullName": "asazure://nightly1.asazure-int.windows.net/azsdktest",
        "state": "Provisioning"
      },
      "sku": {
        "capacity": 1,
        "name": "S1",
        "tier": "Standard"
      },
      "tags": {
        "testKey": "testValue"
      }
    },
    {
      "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.AnalysisServices/servers/azsdktest",
      "location": "West US",
      "name": "azsdktest2",
      "properties": {
        "asAdministrators": {
          "members": [
            "azsdktest@microsoft.com"
          ]
        },
        "provisioningState": "Provisioning",
        "serverFullName": "asazure://nightly1.asazure-int.windows.net/azsdktest",
        "state": "Provisioning"
      },
      "sku": {
        "capacity": 1,
        "name": "S0",
        "tier": "Standard"
      },
      "tags": {
        "testKey": "testValue"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
AnalysisServicesServer	Stellt eine Instanz einer Analysis Services-Ressource dar.
AnalysisServicesServers	Ein Array von Analysis Services-Ressourcen.
ConnectionMode	Wie die Teilnahme des Lese-/Schreibservers am Abfragepool gesteuert wird. Sie kann die folgenden Werte aufweisen: readOnly – gibt an, dass der Lese-/Schreibserver nicht an Abfragevorgängen teilnehmen soll. all – gibt an, dass der Lese-/Schreibserver an Abfragevorgängen teilnehmen kann. Die Angabe von "readOnly", wenn kapazität 1 ist, führt zu Einem Fehler.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Beschreibt das Format der Fehlerantwort.
GatewayDetails	Die Gatewaydetails.
IPv4FirewallRule	Die Details der Firewallregel.
IPv4FirewallSettings	Ein Array von Firewallregeln.
ManagedMode	Der verwaltete Modus des Servers (0 = nicht verwaltet, 1 = verwaltet).
ProvisioningState	Der aktuelle Bereitstellungsstatus der Analysis Services-Ressource. Der provisioningState ist das Angeben von Status für die Ressourcenbereitstellung.
ResourceSku	Stellt den SKU-Namen und die Azure-Preisstufe für die Analysis Services-Ressource dar.
ServerAdministrators	Ein Array von Administratorbenutzeridentitäten.
ServerMonitorMode	Der Serverüberwachungsmodus für AS-Server
SkuTier	Der Name des Azure-Preisniveaus, auf das die SKU angewendet wird.
State	Der aktuelle Status der Analysis Services-Ressource. Der Zustand besteht darin, weitere Zustände außerhalb der Ressourcenbereitstellung anzugeben.

AnalysisServicesServer

Objekt

Stellt eine Instanz einer Analysis Services-Ressource dar.

Name	Typ	Standardwert	Beschreibung
id	string		Ein Bezeichner, der die Analysis Services-Ressource darstellt.
location	string		Speicherort der Analysis Services-Ressource.
name	string		Der Name der Analysis Services-Ressource.
properties.asAdministrators	ServerAdministrators		Eine Sammlung von AS-Serveradministratoren
properties.backupBlobContainerUri	string		Der SAS-Container-URI für den Sicherungscontainer.
properties.gatewayDetails	GatewayDetails		Die Gatewaydetails, die für den AS-Server konfiguriert sind.
properties.ipV4FirewallSettings	IPv4FirewallSettings		Die Firewalleinstellungen für den AS-Server.
properties.managedMode	ManagedMode (int32)	1	Der verwaltete Modus des Servers (0 = nicht verwaltet, 1 = verwaltet).
properties.provisioningState	ProvisioningState		Der aktuelle Bereitstellungsstatus der Analysis Services-Ressource. Der provisioningState ist das Angeben von Status für die Ressourcenbereitstellung.
properties.querypoolConnectionMode	ConnectionMode	All	Wie die Teilnahme des Lese-/Schreibservers am Abfragepool gesteuert wird. Sie kann die folgenden Werte aufweisen: readOnly – gibt an, dass der Lese-/Schreibserver nicht an Abfragevorgängen teilnehmen soll. all – gibt an, dass der Lese-/Schreibserver an Abfragevorgängen teilnehmen kann. Die Angabe von "readOnly", wenn kapazität 1 ist, führt zu Einem Fehler.
properties.serverFullName	string		Der vollständige Name der Analysis Services-Ressource.
properties.serverMonitorMode	ServerMonitorMode (int32)	1	Der Serverüberwachungsmodus für AS-Server
properties.sku	ResourceSku		Die SKU der Analysis Services-Ressource.
properties.state	State		Der aktuelle Status der Analysis Services-Ressource. Der Zustand besteht darin, weitere Zustände außerhalb der Ressourcenbereitstellung anzugeben.
sku	ResourceSku		Die SKU der Analysis Services-Ressource.
tags	object		Schlüsselwertpaare zusätzlicher Ressourcenbereitstellungseigenschaften.
type	string		Der Typ der Analysis Services-Ressource.

AnalysisServicesServers

Objekt

Ein Array von Analysis Services-Ressourcen.

Name	Typ	Beschreibung
value	AnalysisServicesServer[]	Ein Array von Analysis Services-Ressourcen.

ConnectionMode

Enumeration

Wie die Teilnahme des Lese-/Schreibservers am Abfragepool gesteuert wird.
Sie kann die folgenden Werte aufweisen:

readOnly – gibt an, dass der Lese-/Schreibserver nicht an Abfragevorgängen teilnehmen soll.
all – gibt an, dass der Lese-/Schreibserver an Abfragevorgängen teilnehmen kann.

Die Angabe von "readOnly", wenn kapazität 1 ist, führt zu Einem Fehler.

Wert	Beschreibung
All
ReadOnly

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.
httpStatusCode	integer (int32)	Http-Statuscode
message	string	Die Fehlermeldung.
subCode	integer (int32)	Der Fehleruntercode
target	string	Das Fehlerziel.
timeStamp	string	den Zeitstempel für den Fehler.

ErrorResponse

Objekt

Beschreibt das Format der Fehlerantwort.

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt

GatewayDetails

Objekt

Die Gatewaydetails.

Name	Typ	Beschreibung
dmtsClusterUri	string	URI des DMTS-Clusters.
gatewayObjectId	string	Gatewayobjekt-ID aus dem DMTS-Cluster für die Gatewayressource.
gatewayResourceId	string	Gatewayressource, die dem Server zugeordnet werden soll.

IPv4FirewallRule

Objekt

Die Details der Firewallregel.

Name	Typ	Beschreibung
firewallRuleName	string	Der Regelname.
rangeEnd	string	Der Endbereich von IPv4.
rangeStart	string	Der Startbereich von IPv4.

IPv4FirewallSettings

Objekt

Ein Array von Firewallregeln.

Name	Typ	Beschreibung
enablePowerBIService	boolean	Der Indikator zum Aktivieren des PBI-Diensts.
firewallRules	IPv4FirewallRule[]	Ein Array von Firewallregeln.

ManagedMode

Enumeration

Der verwaltete Modus des Servers (0 = nicht verwaltet, 1 = verwaltet).

Wert	Beschreibung
0
1

ProvisioningState

Enumeration

Der aktuelle Bereitstellungsstatus der Analysis Services-Ressource. Der provisioningState ist das Angeben von Status für die Ressourcenbereitstellung.

Wert	Beschreibung
Deleting
Failed
Paused
Pausing
Preparing
Provisioning
Resuming
Scaling
Succeeded
Suspended
Suspending
Updating

ResourceSku

Objekt

Stellt den SKU-Namen und die Azure-Preisstufe für die Analysis Services-Ressource dar.

Name	Typ	Standardwert	Beschreibung
capacity	integer (int32) minimum: 1 maximum: 8	1	Die Anzahl der Instanzen im schreibgeschützten Abfragepool.
name	string		Name der SKU-Ebene.
tier	SkuTier		Der Name des Azure-Preisniveaus, auf das die SKU angewendet wird.

ServerAdministrators

Objekt

Ein Array von Administratorbenutzeridentitäten.

Name	Typ	Beschreibung
members	string[]	Ein Array von Administratorbenutzeridentitäten.

ServerMonitorMode

Enumeration

Der Serverüberwachungsmodus für AS-Server

Wert	Beschreibung
0
1

SkuTier

Enumeration

Der Name des Azure-Preisniveaus, auf das die SKU angewendet wird.

Wert	Beschreibung
Basic
Development
Standard

State

Enumeration

Der aktuelle Status der Analysis Services-Ressource. Der Zustand besteht darin, weitere Zustände außerhalb der Ressourcenbereitstellung anzugeben.

Wert	Beschreibung
Deleting
Failed
Paused
Pausing
Preparing
Provisioning
Resuming
Scaling
Succeeded
Suspended
Suspending
Updating

Freigeben über

Servers - List By Resource Group

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

List existing servers in the resource group.

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AnalysisServicesServer

AnalysisServicesServers

ConnectionMode

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GatewayDetails

IPv4FirewallRule

IPv4FirewallSettings

ManagedMode

ProvisioningState

ResourceSku

ServerAdministrators

ServerMonitorMode

SkuTier

State

Zusätzliche Ressourcen