Servers - List Operation Statuses

Service:

Analysis Services

API Version:

2017-08-01

List the status of operation.

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

URI Parameters

Name	In	Required	Type	Description
location	path	True	string	The region name which the operation will lookup into.
operationId	path	True	string	The target operation Id.
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	OperationStatus	OK. The operation completed.
202 Accepted	OperationStatus	Accepted. The operation is ongoing.
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

Get details of a server

Sample Request

HTTP

GET https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/providers/Microsoft.AnalysisServices/locations/West US/operationstatuses/testoperationid?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/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-08-01/examples/operationStatuses.json
func ExampleServersClient_ListOperationStatuses() {
	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)
	}
	res, err := clientFactory.NewServersClient().ListOperationStatuses(ctx, "West US", "testoperationid", 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.OperationStatus = armanalysisservices.OperationStatus{
	// 	Name: to.Ptr("testoperationid"),
	// 	EndTime: to.Ptr("2017-01-01T16:13:13.933Z"),
	// 	ID: to.Ptr("/subscriptions/id/locations/westus/operationstatuses/testoperationid"),
	// 	StartTime: to.Ptr("2017-01-01T13:13:13.933Z"),
	// 	Status: to.Ptr("Succeeded"),
	// }
}

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 { AzureAnalysisServices } = require("@azure/arm-analysisservices");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List the status of operation.
 *
 * @summary List the status of operation.
 * x-ms-original-file: specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-08-01/examples/operationStatuses.json
 */
async function getDetailsOfAServer() {
  const subscriptionId = "613192d7-503f-477a-9cfe-4efc3ee2bd60";
  const location = "West US";
  const operationId = "testoperationid";
  const credential = new DefaultAzureCredential();
  const client = new AzureAnalysisServices(credential, subscriptionId);
  const result = await client.servers.listOperationStatuses(location, operationId);
  console.log(result);
}

getDetailsOfAServer().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

Sample Response

Status code:

200

{
  "id": "/subscriptions/id/locations/westus/operationstatuses/testoperationid",
  "name": "testoperationid",
  "startTime": "2017-01-01T13:13:13.933Z",
  "endTime": "2017-01-01T16:13:13.933Z",
  "status": "Succeeded"
}

Status code:

202

{
  "id": "/subscriptions/id/locations/westus/operationstatuses/testoperationid",
  "name": "testoperationid",
  "startTime": "2017-01-01T13:13:13.933Z",
  "status": "Running"
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Describes the format of Error response.
OperationStatus	The status of operation.

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

OperationStatus

The status of operation.

Name	Type	Description
endTime	string	The end time of the operation.
error	ErrorDetail	The error detail of the operation if any.
id	string	The operation Id.
name	string	The operation name.
startTime	string	The start time of the operation.
status	string	The status of the operation.