Share via

Servers - List Gateway Status

Service:
Analysis Services
API Version:
2017-08-01

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
resourceGroupName
 path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+$

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.
serverName
 path True

string

minLength: 3
maxLength: 63
pattern: ^[a-z][a-z0-9]*$

The name of the Analysis Services server.
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

GatewayListStatusLive

OK.
Other Status Codes

GatewayListStatusError

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 code:
200 
{
  "status": 0
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
GatewayListStatusError

Status of gateway is error.
GatewayListStatusLive

Status of gateway is live.
Status

Live message of list gateway. Status: 0 - Live

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
httpStatusCode

integer (int32)

The http status code
message

string

The error message.
subCode

integer (int32)

The error sub code
target

string

The error target.
timeStamp

string

the timestamp for the error.

GatewayListStatusError

Object

Status of gateway is error.

Name Type Description
error

ErrorDetail

Error of the list gateway status.

GatewayListStatusLive

Object

Status of gateway is live.

Name Type Description
status

Status (int32)

Live message of list gateway. Status: 0 - Live

Status

Enumeration

Live message of list gateway. Status: 0 - Live

Value Description
0