你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Servers - List

参考

Service:: Analysis Services

API Version:: 2017-08-01

列出给定订阅的所有 Analysis Services 服务器。

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

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string	Microsoft Azure 订阅的唯一标识符。此订阅 ID 是每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	AnalysisServicesServers	确定
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

List existing servers under the subscription.

Sample Request

GET https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/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/listServers.json
func ExampleServersClient_NewListPager() {
	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().NewListPager(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/TestRG2/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 Lists all the Analysis Services servers for the given subscription.
 *
 * @summary Lists all the Analysis Services servers for the given subscription.
 * x-ms-original-file: specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-08-01/examples/listServers.json
 */
async function listExistingServersUnderTheSubscription() {
  const subscriptionId = "613192d7-503f-477a-9cfe-4efc3ee2bd60";
  const credential = new DefaultAzureCredential();
  const client = new AzureAnalysisServices(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.servers.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

listExistingServersUnderTheSubscription().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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
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/listServers.json
// this example is just showing the usage of "Servers_List" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "613192d7-503f-477a-9cfe-4efc3ee2bd60";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (AnalysisServerResource item in subscriptionResource.GetAnalysisServersAsync())
{
    // 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

Sample Response

Status code:: 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/TestRG2/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"
      }
    }
  ]
}

定义

名称	说明
AnalysisServicesServer	表示 Analysis Services 资源的实例。
AnalysisServicesServers	Analysis Services 资源的数组。
ConnectionMode	如何控制读写服务器参与查询池。该选项可具有以下值： readOnly - 指示读写服务器不打算参与查询操作 all - 指示读写服务器可以参与查询操作当容量为 1 时指定 readOnly 会导致错误。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	描述错误响应的格式。
GatewayDetails	网关详细信息。
IPv4FirewallRule	防火墙规则的详细信息。
IPv4FirewallSettings	防火墙规则数组。
ManagedMode	服务器的托管模式 (0 = 非托管，1 = 托管) 。
ProvisioningState	Analysis Services 资源的当前部署状态。 provisioningState 用于指示资源预配的状态。
ResourceSku	表示 Analysis Services 资源的 SKU 名称和 Azure 定价层。
ServerAdministrators	管理员用户标识的数组。
ServerMonitorMode	AS 服务器的服务器监视模式
SkuTier	SKU 应用到的 Azure 定价层的名称。
State	Analysis Services 资源的当前状态。状态是指示资源预配之外的更多状态。

AnalysisServicesServer

表示 Analysis Services 资源的实例。

名称	类型	默认值	说明
id	string		表示 Analysis Services 资源的标识符。
location	string		Analysis Services 资源的位置。
name	string		Analysis Services 资源的名称。
properties.asAdministrators	ServerAdministrators		AS 服务器管理员的集合
properties.backupBlobContainerUri	string		备份容器的 SAS 容器 URI。
properties.gatewayDetails	GatewayDetails		为 AS 服务器配置的网关详细信息。
properties.ipV4FirewallSettings	IPv4FirewallSettings		AS 服务器的防火墙设置。
properties.managedMode	ManagedMode	1	服务器的托管模式 (0 = 非托管，1 = 托管) 。
properties.provisioningState	ProvisioningState		Analysis Services 资源的当前部署状态。 provisioningState 用于指示资源预配的状态。
properties.querypoolConnectionMode	ConnectionMode	All	如何控制读写服务器参与查询池。该选项可具有以下值： readOnly - 指示读写服务器不打算参与查询操作 all - 指示读写服务器可以参与查询操作当容量为 1 时指定 readOnly 会导致错误。
properties.serverFullName	string		Analysis Services 资源的全名。
properties.serverMonitorMode	ServerMonitorMode	1	AS 服务器的服务器监视模式
properties.sku	ResourceSku		Analysis Services 资源的 SKU。
properties.state	State		Analysis Services 资源的当前状态。状态是指示资源预配之外的更多状态。
sku	ResourceSku		Analysis Services 资源的 SKU。
tags	object		其他资源预配属性的键值对。
type	string		Analysis Services 资源的类型。

AnalysisServicesServers

Analysis Services 资源的数组。

名称	类型	说明
value	AnalysisServicesServer[]	Analysis Services 资源的数组。

ConnectionMode

如何控制读写服务器参与查询池。
该选项可具有以下值：

readOnly - 指示读写服务器不打算参与查询操作
all - 指示读写服务器可以参与查询操作

当容量为 1 时指定 readOnly 会导致错误。

名称	类型	说明
All	string
ReadOnly	string

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
httpStatusCode	integer	http 状态代码
message	string	错误消息。
subCode	integer	错误子代码
target	string	错误目标。
timeStamp	string	错误的时间戳。

ErrorResponse

描述错误响应的格式。

名称	类型	说明
error	ErrorDetail	错误对象

GatewayDetails

网关详细信息。

名称	类型	说明
dmtsClusterUri	string	DMTS 群集的 URI。
gatewayObjectId	string	网关资源的 DMTS 群集中的网关对象 ID。
gatewayResourceId	string	要与服务器关联的网关资源。

IPv4FirewallRule

防火墙规则的详细信息。

名称	类型	说明
firewallRuleName	string	规则名称。
rangeEnd	string	IPv4 的结束范围。
rangeStart	string	IPv4 的起始范围。

IPv4FirewallSettings

防火墙规则数组。

名称	类型	说明
enablePowerBIService	boolean	启用 PBI 服务的指示器。
firewallRules	IPv4FirewallRule[]	防火墙规则数组。

ManagedMode

服务器的托管模式 (0 = 非托管，1 = 托管) 。

名称	类型	说明
0	Integer
1	Integer

ProvisioningState

Analysis Services 资源的当前部署状态。 provisioningState 用于指示资源预配的状态。

名称	类型	说明
Deleting	string
Failed	string
Paused	string
Pausing	string
Preparing	string
Provisioning	string
Resuming	string
Scaling	string
Succeeded	string
Suspended	string
Suspending	string
Updating	string

ResourceSku

表示 Analysis Services 资源的 SKU 名称和 Azure 定价层。

名称	类型	默认值	说明
capacity	integer	1	只读查询池中的实例数。
name	string		SKU 级别的名称。
tier	SkuTier		SKU 应用到的 Azure 定价层的名称。

ServerAdministrators

管理员用户标识的数组。

名称	类型	说明
members	string[]	管理员用户标识的数组。

ServerMonitorMode

AS 服务器的服务器监视模式

名称	类型	说明
0	Integer
1	Integer

SkuTier

SKU 应用到的 Azure 定价层的名称。

名称	类型	说明
Basic	string
Development	string
Standard	string

State

Analysis Services 资源的当前状态。状态是指示资源预配之外的更多状态。

名称	类型	说明
Deleting	string
Failed	string
Paused	string
Pausing	string
Preparing	string
Provisioning	string
Resuming	string
Scaling	string
Succeeded	string
Suspended	string
Suspending	string
Updating	string

Servers - List

URI 参数

响应

安全性

azure_auth

Scopes

示例

List existing servers under the subscription.

Sample Request

Sample Response

定义

AnalysisServicesServer

AnalysisServicesServers

ConnectionMode

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GatewayDetails

IPv4FirewallRule

IPv4FirewallSettings

ManagedMode

ProvisioningState

ResourceSku

ServerAdministrators

ServerMonitorMode

SkuTier

State

其他资源