次の方法で共有


Servers - Get

サーバーを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}?api-version=2021-11-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}?$expand={$expand}&api-version=2021-11-01

URI パラメーター

名前 / 必須 説明
resourceGroupName
path True

string

リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

serverName
path True

string

サーバーの名前。

subscriptionId
path True

string

Azure サブスクリプションを識別するサブスクリプション ID。

api-version
query True

string

要求で使用する API のバージョン。

$expand
query

string

応答に含める子リソース。

応答

名前 説明
200 OK

Server

指定したサーバーが正常に取得されました。

Other Status Codes

エラー応答: ***

  • 404 SubscriptionNotFound - 要求されたサブスクリプションが見つかりませんでした。

  • 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。

Get server
Get server with $expand=administrators/activedirectory

Get server

要求のサンプル

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645?api-version=2021-11-01

応答のサンプル

{
  "tags": {
    "tagKey1": "TagValue1"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645",
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers",
  "location": "japaneast",
  "kind": "v12.0",
  "properties": {
    "fullyQualifiedDomainName": "sqlcrudtest-4645.database.windows.net",
    "administratorLogin": "dummylogin",
    "version": "12.0",
    "state": "Ready",
    "workspaceFeature": "Connected",
    "publicNetworkAccess": "Enabled",
    "restrictOutboundNetworkAccess": "Enabled",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/privateEndpointConnections/private-endpoint-name-00000000-1111-2222-3333-444444444444",
        "properties": {
          "provisioningState": "Ready",
          "privateEndpoint": {
            "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Auto-approved",
            "actionsRequired": "None"
          }
        }
      }
    ]
  }
}

Get server with $expand=administrators/activedirectory

要求のサンプル

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645?api-version=2021-11-01

応答のサンプル

{
  "tags": {
    "tagKey1": "TagValue1"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645",
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers",
  "location": "japaneast",
  "kind": "v12.0",
  "properties": {
    "fullyQualifiedDomainName": "sqlcrudtest-4645.database.windows.net",
    "administratorLogin": "dummylogin",
    "version": "12.0",
    "state": "Ready",
    "workspaceFeature": "Connected",
    "publicNetworkAccess": "Enabled",
    "restrictOutboundNetworkAccess": "Enabled",
    "administrators": {
      "principalType": "User",
      "login": "bob@contoso.com",
      "sid": "00000011-1111-2222-2222-123456789111",
      "tenantId": "00000011-1111-2222-2222-123456789111",
      "azureADOnlyAuthentication": true
    },
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/privateEndpointConnections/private-endpoint-name-00000000-1111-2222-3333-444444444444",
        "properties": {
          "provisioningState": "Ready",
          "privateEndpoint": {
            "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Auto-approved",
            "actionsRequired": "None"
          }
        }
      }
    ]
  }
}

定義

名前 説明
AdministratorType

管理者の種類。

IdentityType

ID の種類。 リソースの Azure Active Directory プリンシパルを自動的に作成して割り当てるには、これを "SystemAssigned" に設定します。

PrincipalType

プリンシパル サーバー管理者の種類。

PrivateEndpointConnectionProperties

プライベート エンドポイント接続のプロパティ。

PrivateEndpointProperty
PrivateEndpointProvisioningState

プライベート エンドポイント接続の状態。

PrivateLinkServiceConnectionStateActionsRequire

プライベート リンク サービス接続に必要なアクション。

PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus

プライベート リンク サービスの接続状態。

ResourceIdentity

リソースの Azure Active Directory ID 構成。

Server

Azure SQL データベース サーバー。

ServerExternalAdministrator

Active Directory 管理者のプロパティ。

ServerNetworkAccessFlag

このサーバーに対してパブリック エンドポイント アクセスが許可されるかどうか。 値は省略可能ですが、渡された場合は 、'Enabled' または 'Disabled' である必要があります

ServerPrivateEndpointConnection

サーバー下のプライベート エンドポイント接続

ServerWorkspaceFeature

既存のサーバーにワークスペースが作成されているかどうか、およびワークスペースからの接続が許可されているかどうか

UserIdentity

リソースの Azure Active Directory ID 構成。

AdministratorType

管理者の種類。

名前 説明
ActiveDirectory

string

IdentityType

ID の種類。 リソースの Azure Active Directory プリンシパルを自動的に作成して割り当てるには、これを "SystemAssigned" に設定します。

名前 説明
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

PrincipalType

プリンシパル サーバー管理者の種類。

名前 説明
Application

string

Group

string

User

string

PrivateEndpointConnectionProperties

プライベート エンドポイント接続のプロパティ。

名前 説明
groupIds

string[]

グループ ID。

privateEndpoint

PrivateEndpointProperty

接続が属するプライベート エンドポイント。

privateLinkServiceConnectionState

PrivateLinkServiceConnectionStateProperty

プライベート エンドポイント接続の接続状態。

provisioningState

PrivateEndpointProvisioningState

プライベート エンドポイント接続の状態。

PrivateEndpointProperty

名前 説明
id

string

プライベート エンドポイントのリソース ID。

PrivateEndpointProvisioningState

プライベート エンドポイント接続の状態。

名前 説明
Approving

string

Dropping

string

Failed

string

Ready

string

Rejecting

string

PrivateLinkServiceConnectionStateActionsRequire

プライベート リンク サービス接続に必要なアクション。

名前 説明
None

string

PrivateLinkServiceConnectionStateProperty

名前 説明
actionsRequired

PrivateLinkServiceConnectionStateActionsRequire

プライベート リンク サービス接続に必要なアクション。

description

string

プライベート リンク サービスの接続の説明。

status

PrivateLinkServiceConnectionStateStatus

プライベート リンク サービスの接続状態。

PrivateLinkServiceConnectionStateStatus

プライベート リンク サービスの接続状態。

名前 説明
Approved

string

Disconnected

string

Pending

string

Rejected

string

ResourceIdentity

リソースの Azure Active Directory ID 構成。

名前 説明
principalId

string

Azure Active Directory プリンシパル ID。

tenantId

string

Azure Active Directory テナント ID。

type

IdentityType

ID の種類。 リソースの Azure Active Directory プリンシパルを自動的に作成して割り当てるには、これを "SystemAssigned" に設定します。

userAssignedIdentities

<string,  UserIdentity>

使用するユーザー割り当て ID のリソース ID

Server

Azure SQL データベース サーバー。

名前 説明
id

string

リソースの ID

identity

ResourceIdentity

サーバーの Azure Active Directory ID。

kind

string

SQL Server の種類。 これは、Azure portal エクスペリエンスに使用されるメタデータです。

location

string

リソースの場所。

name

string

リソース名。

properties.administratorLogin

string

サーバーの管理者ユーザー名。 一度作成すると、変更できません。

properties.administratorLoginPassword

string

管理者ログイン パスワード (サーバーの作成に必要)。

properties.administrators

ServerExternalAdministrator

サーバーの Azure Active Directory 管理者。

properties.federatedClientId

string

テナント間 CMK シナリオに使用されるクライアント ID

properties.fullyQualifiedDomainName

string

サーバーの完全修飾ドメイン名。

properties.keyId

string

暗号化に使用するキーの CMK URI。

properties.minimalTlsVersion

string

最小 TLS バージョン。 使用できる値: '1.0'、'1.1'、'1.2'

properties.primaryUserAssignedIdentityId

string

既定で使用されるユーザー割り当て ID のリソース ID。

properties.privateEndpointConnections

ServerPrivateEndpointConnection[]

サーバー上のプライベート エンドポイント接続の一覧

properties.publicNetworkAccess

ServerNetworkAccessFlag

このサーバーに対してパブリック エンドポイント アクセスが許可されるかどうか。 値は省略可能ですが、渡された場合は 、'Enabled' または 'Disabled' である必要があります

properties.restrictOutboundNetworkAccess

ServerNetworkAccessFlag

このサーバーの送信ネットワーク アクセスを制限するかどうか。 値は省略可能ですが、渡された場合は 、'Enabled' または 'Disabled' である必要があります

properties.state

string

サーバーの状態。

properties.version

string

サーバーのバージョンです。

properties.workspaceFeature

ServerWorkspaceFeature

既存のサーバーにワークスペースが作成されているかどうか、およびワークスペースからの接続が許可されているかどうか

tags

object

リソース タグ。

type

string

リソースの種類。

ServerExternalAdministrator

Active Directory 管理者のプロパティ。

名前 説明
administratorType

AdministratorType

管理者の種類。

azureADOnlyAuthentication

boolean

Azure Active Directory のみ認証が有効になっています。

login

string

サーバー管理者のログイン名。

principalType

PrincipalType

プリンシパル サーバー管理者の種類。

sid

string

サーバー管理者の SID (オブジェクト ID)。

tenantId

string

管理者のテナント ID。

ServerNetworkAccessFlag

このサーバーに対してパブリック エンドポイント アクセスが許可されるかどうか。 値は省略可能ですが、渡された場合は 、'Enabled' または 'Disabled' である必要があります

名前 説明
Disabled

string

Enabled

string

ServerPrivateEndpointConnection

サーバー下のプライベート エンドポイント接続

名前 説明
id

string

リソースの ID

properties

PrivateEndpointConnectionProperties

プライベート エンドポイント接続のプロパティ

ServerWorkspaceFeature

既存のサーバーにワークスペースが作成されているかどうか、およびワークスペースからの接続が許可されているかどうか

名前 説明
Connected

string

Disconnected

string

UserIdentity

リソースの Azure Active Directory ID 構成。

名前 説明
clientId

string

Azure Active Directory クライアント ID。

principalId

string

Azure Active Directory プリンシパル ID。