Servers - Create

リファレンス

サービス:: Analysis Services

API バージョン:: 2017-08-01

要求で指定された構成に基づいて、指定した Analysis Services サーバーをプロビジョニングします。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	特定の Analysis Services サーバーが含まれる Azure リソースグループの名前。この名前の長さは 1 文字以上、90 文字以下にする必要があります。
serverName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z][a-z0-9]*$	Analysis Services サーバーの名前。 3 文字以上、最大 63 文字にする必要があります。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションの一意識別子。サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	必須	型	説明
location	True	string	Analysis Services リソースの場所。
sku	True	ResourceSku	Analysis Services リソースの SKU。
properties.asAdministrators		ServerAdministrators	AS サーバー管理者のコレクション
properties.backupBlobContainerUri		string	バックアップコンテナーへの SAS コンテナー URI。
properties.gatewayDetails		GatewayDetails	AS サーバー用に構成されたゲートウェイの詳細。
properties.ipV4FirewallSettings		IPv4FirewallSettings	AS サーバーのファイアウォール設定。
properties.managedMode		ManagedMode (int32)	サーバーの管理モード (0 = 管理されていません、1 = マネージド)。
properties.querypoolConnectionMode		ConnectionMode	クエリプールへの読み取り/書き込みサーバーの参加を制御する方法。次の値を指定できます。 readOnly - 読み取り/書き込みサーバーがクエリ操作に参加しないことを示します all - 読み取り/書き込みサーバーがクエリ操作に参加できることを示します容量が 1 の場合に readOnly を指定すると、エラーが発生します。
properties.serverMonitorMode		ServerMonitorMode (int32)	AS サーバーのサーバーモニターモード
properties.sku		ResourceSku	Analysis Services リソースの SKU。
tags		object	追加のリソースプロビジョニングプロパティのキーと値のペア。

応答

名前	型	説明
200 OK	AnalysisServicesServer	わかりました。操作が正常に完了しました。
201 Created	AnalysisServicesServer	InProgress。操作はまだ完了しています。
202 Accepted	AnalysisServicesServer	準備。操作はまだ完了しています。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Create a server.

要求のサンプル

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

{
  "sku": {
    "capacity": 1,
    "name": "S1",
    "tier": "Standard"
  },
  "tags": {
    "testKey": "testValue"
  },
  "location": "West US",
  "properties": {
    "asAdministrators": {
      "members": [
        "azsdktest@microsoft.com",
        "azsdktest2@microsoft.com"
      ]
    }
  }
}

package armanalysisservices_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/createServer.json
func ExampleServersClient_BeginCreate() {
	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)
	}
	poller, err := clientFactory.NewServersClient().BeginCreate(ctx, "TestRG", "azsdktest", armanalysisservices.Server{
		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"),
					to.Ptr("azsdktest2@microsoft.com")},
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.Server = 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"),
	// 				to.Ptr("azsdktest2@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 Provisions the specified Analysis Services server based on the configuration specified in the request.
 *
 * @summary Provisions the specified Analysis Services server based on the configuration specified in the request.
 * x-ms-original-file: specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-08-01/examples/createServer.json
 */
async function createAServer() {
  const subscriptionId = "613192d7-503f-477a-9cfe-4efc3ee2bd60";
  const resourceGroupName = "TestRG";
  const serverName = "azsdktest";
  const serverParameters = {
    asAdministrators: {
      members: ["azsdktest@microsoft.com", "azsdktest2@microsoft.com"],
    },
    location: "West US",
    sku: { name: "S1", capacity: 1, tier: "Standard" },
    tags: { testKey: "testValue" },
  };
  const credential = new DefaultAzureCredential();
  const client = new AzureAnalysisServices(credential, subscriptionId);
  const result = await client.servers.beginCreateAndWait(
    resourceGroupName,
    serverName,
    serverParameters
  );
  console.log(result);
}

createAServer().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/createServer.json
// this example is just showing the usage of "Servers_Create" 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
string serverName = "azsdktest";
AnalysisServerData data = new AnalysisServerData(new AzureLocation("West US"), new AnalysisResourceSku("S1")
{
    Tier = AnalysisSkuTier.Standard,
    Capacity = 1,
})
{
    AsAdministratorIdentities =
    {
    "azsdktest@microsoft.com","azsdktest2@microsoft.com"
    },
    AnalysisServerSku = new AnalysisResourceSku("S1")
    {
        Tier = AnalysisSkuTier.Standard,
        Capacity = 1,
    },
    Tags =
    {
    ["testKey"] = "testValue",
    },
};
ArmOperation<AnalysisServerResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, serverName, data);
AnalysisServerResource result = lro.Value;

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

応答のサンプル

状態コード:: 200

{
  "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",
        "azsdktest2@microsoft.com"
      ]
    },
    "provisioningState": "Provisioning",
    "serverFullName": "asazure://nightly1.asazure-int.windows.net/azsdktest",
    "state": "Provisioning"
  },
  "sku": {
    "capacity": 1,
    "name": "S1",
    "tier": "Standard"
  },
  "tags": {
    "testKey": "testValue"
  }
}

状態コード:: 201

{
  "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",
        "azsdktest2@microsoft.com"
      ]
    },
    "provisioningState": "Provisioning",
    "serverFullName": "asazure://nightly1.asazure-int.windows.net/azsdktest",
    "state": "Provisioning"
  },
  "sku": {
    "capacity": 1,
    "name": "S1",
    "tier": "Standard"
  },
  "tags": {
    "testKey": "testValue"
  }
}

状態コード:: 202

{
  "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",
        "azsdktest2@microsoft.com"
      ]
    },
    "provisioningState": "Preparing",
    "serverFullName": "asazure://nightly1.asazure-int.windows.net/azsdktest",
    "state": "Preparing"
  },
  "sku": {
    "capacity": 1,
    "name": "S1",
    "tier": "Standard"
  },
  "tags": {
    "testKey": "testValue"
  }
}

定義

名前	説明
AnalysisServicesServer	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	管理者ユーザー ID の配列。
ServerMonitorMode	AS サーバーのサーバーモニターモード
SkuTier	SKU が適用される Azure 価格レベルの名前。
State	Analysis Services リソースの現在の状態。状態は、リソースプロビジョニングの外部でより多くの状態を示します。

AnalysisServicesServer

Object

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 (int32)	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 (int32)	1	AS サーバーのサーバーモニターモード
properties.sku	ResourceSku		Analysis Services リソースの SKU。
properties.state	State		Analysis Services リソースの現在の状態。状態は、リソースプロビジョニングの外部でより多くの状態を示します。
sku	ResourceSku		Analysis Services リソースの SKU。
tags	object		追加のリソースプロビジョニングプロパティのキーと値のペア。
type	string		Analysis Services リソースの種類。

ConnectionMode

列挙

クエリプールへの読み取り/書き込みサーバーの参加を制御する方法。
次の値を指定できます。

readOnly - 読み取り/書き込みサーバーがクエリ操作に参加しないことを示します
all - 読み取り/書き込みサーバーがクエリ操作に参加できることを示します

容量が 1 の場合に readOnly を指定すると、エラーが発生します。

値	説明
All
ReadOnly

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
httpStatusCode	integer (int32)	http 状態コード
message	string	エラーメッセージ。
subCode	integer (int32)	エラーサブコード
target	string	エラーターゲット。
timeStamp	string	エラーのタイムスタンプ。

ErrorResponse

Object

エラー応答の形式について説明します。

名前	型	説明
error	ErrorDetail	エラーオブジェクト

GatewayDetails

Object

ゲートウェイの詳細。

名前	型	説明
dmtsClusterUri	string	DMTS クラスターの URI。
gatewayObjectId	string	ゲートウェイリソースの DMTS クラスターからのゲートウェイオブジェクト ID。
gatewayResourceId	string	サーバーに関連付けるゲートウェイリソース。

IPv4FirewallRule

Object

ファイアウォール規則の詳細。

名前	型	説明
firewallRuleName	string	ルール名。
rangeEnd	string	IPv4 の終了範囲。
rangeStart	string	IPv4 の開始範囲。

IPv4FirewallSettings

Object

ファイアウォール規則の配列。

名前	型	説明
enablePowerBIService	boolean	PBI サービスを有効にするインジケーター。
firewallRules	IPv4FirewallRule[]	ファイアウォール規則の配列。

ManagedMode

列挙

サーバーの管理モード (0 = 管理されていません、1 = マネージド)。

値	説明
0
1

ProvisioningState

列挙

Analysis Services リソースの現在のデプロイ状態。 provisioningState は、リソースプロビジョニングの状態を示します。

値	説明
Deleting
Failed
Paused
Pausing
Preparing
Provisioning
Resuming
Scaling
Succeeded
Suspended
Suspending
Updating

ResourceSku

Object

Analysis Services リソースの SKU 名と Azure 価格レベルを表します。

名前	型	規定値	説明
capacity	integer (int32) minimum: 1 maximum: 8	1	読み取り専用クエリプール内のインスタンスの数。
name	string		SKU レベルの名前。
tier	SkuTier		SKU が適用される Azure 価格レベルの名前。

ServerAdministrators

Object

管理者ユーザー ID の配列。

名前	型	説明
members	string[]	管理者ユーザー ID の配列。

ServerMonitorMode

列挙

AS サーバーのサーバーモニターモード

値	説明
0
1

SkuTier

列挙

SKU が適用される Azure 価格レベルの名前。

値	説明
Basic
Development
Standard

State

列挙

Analysis Services リソースの現在の状態。状態は、リソースプロビジョニングの外部でより多くの状態を示します。

値	説明
Deleting
Failed
Paused
Pausing
Preparing
Provisioning
Resuming
Scaling
Succeeded
Suspended
Suspending
Updating

次の方法で共有

Servers - Create

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

Create a server.

要求のサンプル

応答のサンプル

定義

AnalysisServicesServer

ConnectionMode

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GatewayDetails

IPv4FirewallRule

IPv4FirewallSettings

ManagedMode

ProvisioningState

ResourceSku

ServerAdministrators

ServerMonitorMode

SkuTier

State

その他のリソース