Servers - Suspend

Service:

Analysis Services

API Version:

2017-08-01

Suspends operation of the specified Analysis Services server instance.

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90. Regex pattern: ^[-\w\._\(\)]+$
serverName	path	True	string	The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63. Regex pattern: ^[a-z][a-z0-9]*$
subscriptionId	path	True	string	A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	The client API version.

Responses

Name	Type	Description
200 OK		OK.
202 Accepted		Accepted.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Suspend a server.

Sample Request

HTTP

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

Go

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/tree/main/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-08-01/examples/suspendServer.json
func ExampleServersClient_BeginSuspend() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armanalysisservices.NewServersClient("613192d7-503f-477a-9cfe-4efc3ee2bd60", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginSuspend(ctx,
		"TestRG",
		"azsdktest",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

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

/**
 * This sample demonstrates how to Suspends operation of the specified Analysis Services server instance.
 *
 * @summary Suspends operation of the specified Analysis Services server instance.
 * x-ms-original-file: specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-08-01/examples/suspendServer.json
 */
async function suspendAServer() {
  const subscriptionId = "613192d7-503f-477a-9cfe-4efc3ee2bd60";
  const resourceGroupName = "TestRG";
  const serverName = "azsdktest";
  const credential = new DefaultAzureCredential();
  const client = new AzureAnalysisServices(credential, subscriptionId);
  const result = await client.servers.beginSuspendAndWait(resourceGroupName, serverName);
  console.log(result);
}

suspendAServer().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

Status code:

202

Definitions

ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Describes the format of Error response.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
httpStatusCode	integer	The http status code
message	string	The error message.
subCode	integer	The error sub code
target	string	The error target.
timeStamp	string	the timestamp for the error.

ErrorResponse

Describes the format of Error response.

Name	Type	Description
error	ErrorDetail	The error object