Server Keys - Get

  • リファレンス
サービス:
SQL Database
API バージョン:
2021-11-01

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

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

URI パラメーター

名前 / 必須 型 説明
keyName
 path True

string

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

string

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

string

サーバーの名前。
subscriptionId
 path True

string

Azure サブスクリプションを識別するサブスクリプション ID。
api-version
 query True

string

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

応答

名前 型 説明
200 OK

ServerKey

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

エラー応答: ***

  • 400 InvalidKeyName - サーバー キー名に無効な値が指定されました。

  • 400 InvalidKeyType - サーバー キーの作成の種類はサポートされていません。

  • 400 InvalidUpsertKeyType - サービスで管理される TDE キーは、サービスによって管理されます。 サービスマネージド TDE キーは、ユーザーによる作成または更新をサポートしていません。

  • 400 InvalidKeyUpsertRequest - サーバー キーの作成要求が存在しないか、プロパティ オブジェクトがありません。

  • 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした

  • 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソース グループとサブスクリプションに存在しません。

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

例

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=2021-11-01

応答のサンプル

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

定義

名前 説明
ServerKey

サーバー キー。
ServerKeyType

'ServiceManaged'、'AzureKeyVault' などのサーバー キーの種類。

ServerKey

サーバー キー。

名前 型 説明
id

string

リソースの ID
kind

string

暗号化保護機能の種類。 これは、Azure portal エクスペリエンスに使用されるメタデータです。
location

string

リソースの場所。
name

string

リソース名。
properties.autoRotationEnabled

boolean

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

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'
type

string

リソースの種類。

ServerKeyType

'ServiceManaged'、'AzureKeyVault' などのサーバー キーの種類。

名前 型 説明
AzureKeyVault

string

ServiceManaged

string