Server Azure AD Administrators - List By Server

サービス:: SQL Database

API バージョン:: 2023-08-01

サーバー内の Azure Active Directory 管理者の一覧を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/administrators?api-version=2023-08-01

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースを含むリソースグループの名前。この値は、Azure Resource Manager API またはポータルから取得できます。
serverName	path	True	string	サーバーの名前。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求に使用する API バージョン。

応答

名前	型	説明
200 OK	AdministratorListResult	Azure Active Directory 管理者の一覧が正常に取得されました。
Other Status Codes	ErrorResponse	エラー応答: *** 400 ManagedInstanceStoppingOrStopped - インスタンスが停止/停止状態にある間に送信された操作の競合 400 ManagedInstanceStarting - インスタンスが開始状態の間に送信された操作の競合 400 InvalidServerAdministratorTypePropertyName - サーバーの Active Directory 管理者の種類を ActiveDirectory にする必要がある 400 InvalidResourceRequestBody - 要求本文のリソースまたはリソースのプロパティが空または無効です。 400 InvalidServerAzureADOnlyAuthenticationParameter - ユーザーが AzureADOnlyAuthentication パラメーターを false に設定しようとしましたが、これは許可されていません。代わりに azureADOnlyAuthentications API を使用してください。 400 InvalidServerAzureADAdminDeleteOperation - AzureADOnlyAuthentication が設定されているときにユーザーがサーバー Azure Active Azure 管理者を削除しようとしましたが、最初に azureADOnlyAuthentications API を使用してください。 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。

名前

型

説明

200 OK

AdministratorListResult

Azure Active Directory 管理者の一覧が正常に取得されました。

Other Status Codes

ErrorResponse

エラー応答: ***

400 ManagedInstanceStoppingOrStopped - インスタンスが停止/停止状態にある間に送信された操作の競合
400 ManagedInstanceStarting - インスタンスが開始状態の間に送信された操作の競合
400 InvalidServerAdministratorTypePropertyName - サーバーの Active Directory 管理者の種類を ActiveDirectory にする必要がある
400 InvalidResourceRequestBody - 要求本文のリソースまたはリソースのプロパティが空または無効です。
400 InvalidServerAzureADOnlyAuthenticationParameter - ユーザーが AzureADOnlyAuthentication パラメーターを false に設定しようとしましたが、これは許可されていません。代わりに azureADOnlyAuthentications API を使用してください。
400 InvalidServerAzureADAdminDeleteOperation - AzureADOnlyAuthentication が設定されているときにユーザーがサーバー Azure Active Azure 管理者を削除しようとしましたが、最初に azureADOnlyAuthentications API を使用してください。
404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。
404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした
404 ResourceNotFound - 要求されたリソースが見つかりませんでした。

例

Gets a list of Azure Active Directory administrator.

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-6440/administrators?api-version=2023-08-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/AdministratorList.json
// this example is just showing the usage of "ServerAzureADAdministrators_ListByServer" 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 SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-4799";
string serverName = "sqlcrudtest-6440";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SqlServerAzureADAdministratorResource
SqlServerAzureADAdministratorCollection collection = sqlServer.GetSqlServerAzureADAdministrators();

// invoke the operation and iterate over the result
await foreach (SqlServerAzureADAdministratorResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SqlServerAzureADAdministratorData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-6440/administrators/ActiveDirectory",
      "name": "ActiveDirectory",
      "type": "Microsoft.Sql/servers/administrators",
      "properties": {
        "administratorType": "ActiveDirectory",
        "login": "bob@contoso.com",
        "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
        "tenantId": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
        "azureADOnlyAuthentication": true
      }
    }
  ]
}

定義

名前	説明
AdministratorListResult	Active Directory 管理者の一覧。
AdministratorType	管理者の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ServerAzureADAdministrator	Azure Active Directory 管理者。

AdministratorListResult

Object

Active Directory 管理者の一覧。

名前	型	説明
nextLink	string	結果の次のページを取得するためのリンク。
value	ServerAzureADAdministrator[]	結果の配列。

AdministratorType

列挙

管理者の種類。

値	説明
ActiveDirectory

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

ServerAzureADAdministrator

Object

Azure Active Directory 管理者。

名前	型	説明
id	string	リソース ID。
name	string	リソース名。
properties.administratorType	AdministratorType	管理者の種類。
properties.azureADOnlyAuthentication	boolean	Azure Active Directory のみの認証が有効になっています。
properties.login	string	サーバー管理者のログイン名。
properties.sid	string (uuid)	サーバー管理者の SID (オブジェクト ID)。
properties.tenantId	string (uuid)	管理者のテナント ID。
type	string	リソースの種類。

次の方法で共有

Server Azure AD Administrators - List By Server

URI パラメーター

応答

例

Gets a list of Azure Active Directory administrator.

要求のサンプル

応答のサンプル

定義

AdministratorListResult

AdministratorType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServerAzureADAdministrator