Servers - List Gateway Status

Return the gateway status of the specified Analysis Services server instance.

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

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

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.

Regex pattern: ^[a-z][a-z0-9]*$

api-version
query True
  • string

The client API version.

Responses

Name Type Description
200 OK

OK.

Other Status Codes

Default response as an error

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

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

Sample Response

{
  "status": "Live"
}

Definitions

GatewayError

Detail of gateway errors.

GatewayListStatusError

Status of gateway is error.

GatewayListStatusLive

Status of gateway is live.

Status

Live message of list gateway.

GatewayError

Detail of gateway errors.

Name Type Description
code
  • string

Error code of list gateway.

message
  • string

Error message of list gateway.

GatewayListStatusError

Status of gateway is error.

Name Type Description
error

Error of the list gateway status.

GatewayListStatusLive

Status of gateway is live.

Name Type Description
status

Live message of list gateway.

Status

Live message of list gateway.

Name Type Description
Live
  • string