Servers - List Gateway Status

Служба:

Analysis Services

Версия API:

2017-08-01

Возвращает состояние шлюза указанного экземпляра сервера служб Analysis Services.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Имя группы ресурсов Azure, частью которой является данный сервер служб Analysis Services. Это имя должно содержать не менее 1 символа и не более 90 символов.
serverName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z][a-z0-9]*$	Имя сервера служб Analysis Services.
subscriptionId	path	True	string	Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия КЛИЕНТСКОго API.

Ответы

Имя	Тип	Описание
200 OK	GatewayListStatusLive	Все в порядке.
Other Status Codes	GatewayListStatusError	Ответ по умолчанию в виде ошибки

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Get details of a server

Образец запроса

HTTP

POST https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.AnalysisServices/servers/azsdktest/listGatewayStatus?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/listGatewayStatus.json
func ExampleServersClient_ListGatewayStatus() {
	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().ListGatewayStatus(ctx, "TestRG", "azsdktest", 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.GatewayListStatusLive = armanalysisservices.GatewayListStatusLive{
	// 	Status: to.Ptr[int32](0),
	// }
}

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 Return the gateway status of the specified Analysis Services server instance.
 *
 * @summary Return the gateway status of the specified Analysis Services server instance.
 * x-ms-original-file: specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-08-01/examples/listGatewayStatus.json
 */
async function getDetailsOfAServer() {
  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.listGatewayStatus(resourceGroupName, serverName);
  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

dotnet

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/listGatewayStatus.json
// this example is just showing the usage of "Servers_ListGatewayStatus" 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 AnalysisServerResource created on azure
// for more information of creating AnalysisServerResource, please refer to the document of AnalysisServerResource
string subscriptionId = "613192d7-503f-477a-9cfe-4efc3ee2bd60";
string resourceGroupName = "TestRG";
string serverName = "azsdktest";
ResourceIdentifier analysisServerResourceId = AnalysisServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
AnalysisServerResource analysisServer = client.GetAnalysisServerResource(analysisServerResourceId);

// invoke the operation
AnalysisGatewayStatus result = await analysisServer.GetGatewayStatusAsync();

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Пример ответа

Код состояния:

200

{
  "status": 0
}

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
GatewayListStatusError	Состояние шлюза — ошибка.
GatewayListStatusLive	Состояние шлюза активно.
Status	Динамическое сообщение шлюза списков. Состояние: 0 — в режиме реального времени

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	метка времени для ошибки.

GatewayListStatusError

Object

Состояние шлюза — ошибка.

Имя	Тип	Описание
error	ErrorDetail	Ошибка состояния шлюза списка.

GatewayListStatusLive

Object

Состояние шлюза активно.

Имя	Тип	Описание
status	Status (int32)	Динамическое сообщение шлюза списков. Состояние: 0 — в режиме реального времени

Status

Перечисление

Динамическое сообщение шлюза списков. Состояние: 0 — в режиме реального времени

Значение	Описание
0