Server Keys - Get

サービス:
SQL Database
API バージョン:
2025-01-01

サーバー キーを取得します。

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

URI パラメーター

名前 / 必須 型 説明
keyName
 path True

string

取得するサーバー キーの名前。
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

リソース グループの名前。 名前の大文字と小文字は区別されません。
serverName
 path True

string

サーバーの名前。
subscriptionId
 path True

string (uuid)

ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version
 query True

string

minLength: 1

この操作に使用する API バージョン。

応答

名前 型 説明
200 OK

ServerKey

Azureの運用は無事に完了しました。
Other Status Codes

ErrorResponse

予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow.

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントを偽装する

例

Get the server key
Get the server key with versionless key

Get the server key

要求のサンプル

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

応答のサンプル

状態コード:
200 
{
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers/keys",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "kind": "azurekeyvault",
  "location": "Japan East",
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "creationDate": "2024-11-15T00:00:00Z",
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD"
  }
}

Get the server key with versionless key

要求のサンプル

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

応答のサンプル

状態コード:
200 
{
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers/keys",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "kind": "azurekeyvault",
  "location": "Japan East",
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "creationDate": "2024-11-15T00:00:00Z",
    "keyVersion": "01234567890123456789012345678901",
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD"
  }
}

定義

名前 説明
createdByType

リソースを作成した ID の種類。
ErrorAdditionalInfo

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

エラーの詳細。
ErrorResponse

エラー応答
ServerKey

サーバー キー。
ServerKeyType

"ServiceManaged"、"AzureKeyVault" などの暗号化保護機能の種類。
systemData

リソースの作成と最後の変更に関連するメタデータ。

createdByType

列挙

リソースを作成した ID の種類。

値 説明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

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

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細。
message

string

エラー メッセージ。
target

string

エラーターゲット。

ErrorResponse

Object

エラー応答

名前 型 説明
error

ErrorDetail

エラー オブジェクト。

ServerKey

Object

サーバー キー。

名前 型 説明
id

string (arm-id)

リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind

string

暗号化保護機能の種類。 これはAzureポータル体験で使用されるメタデータです。
location

string

リソースの場所。
name

string

リソースの名前
properties.autoRotationEnabled

boolean

キー自動ローテーションオプトイン フラグ。 true または false のいずれか。
properties.creationDate

string (date-time)

サーバー キーの作成日。
properties.keyVersion

string

サーバー キーのバージョン。
properties.serverKeyType

ServerKeyType

"ServiceManaged"、"AzureKeyVault" などのサーバー キーの種類。
properties.subregion

string

サーバー キーのサブ領域。
properties.thumbprint

string

サーバー キーの拇印。
properties.uri

string

サーバー キーの URI。 ServerKeyType が AzureKeyVault の場合は、URI が必要です。 AKV URI は、'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' または 'https://YourVaultName.vault.azure.net/keys/YourKeyName' の形式である必要があります。
systemData

systemData

create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。
type

string

リソースの型。 例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」

ServerKeyType

列挙

"ServiceManaged"、"AzureKeyVault" などの暗号化保護機能の種類。

値 説明
ServiceManaged

ServiceManaged
AzureKeyVault

AzureKeyVault

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前 型 説明
createdAt

string (date-time)

リソース作成のタイムスタンプ (UTC)。
createdBy

string

リソースを作成した ID。
createdByType

createdByType

リソースを作成した ID の種類。
lastModifiedAt

string (date-time)

リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy

string

リソースを最後に変更した ID。
lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。