Encryption Protectors - List By Server

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

サーバー暗号化保護機能の一覧を取得します

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/encryptionProtector?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 のバージョン。

応答

名前 型 説明
200 OK

EncryptionProtectorListResult

サーバー暗号化保護機能の一覧が正常に取得されました。
Other Status Codes

エラー応答: ***

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

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

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

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

  • 400 InvalidEncryptionProtectorName - 暗号化保護機能のキー名はサポートされていません。

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

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

例

List encryption protectors by server

要求のサンプル

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

応答のサンプル

状態コード:
200 
{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector/current",
      "name": "current",
      "type": "Microsoft.Sql/servers/encryptionProtector",
      "location": "Japan East",
      "kind": "azurekeyvault",
      "properties": {
        "serverKeyName": "someVault_someKey_01234567890123456789012345678901",
        "serverKeyType": "AzureKeyVault",
        "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"
      }
    }
  ]
}

定義

名前 説明
EncryptionProtector

サーバー暗号化保護機能。
EncryptionProtectorListResult

サーバー暗号化保護機能の一覧。
ServerKeyType

暗号化プロテクタの種類 ('ServiceManaged'、'AzureKeyVault' など)。

EncryptionProtector

サーバー暗号化保護機能。

名前 型 説明
id

string

リソースの ID
kind

string

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

string

リソースの場所。
name

string

リソース名。
properties.autoRotationEnabled

boolean

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

string

サーバー キーの名前。
properties.serverKeyType

ServerKeyType

暗号化プロテクタの種類 ('ServiceManaged'、'AzureKeyVault' など)。
properties.subregion

string

暗号化プロテクタのサブ領域。
properties.thumbprint

string

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

string

サーバー キーの URI。
type

string

リソースの種類。

EncryptionProtectorListResult

サーバー暗号化保護機能の一覧。

名前 型 説明
nextLink

string

結果の次のページを取得するためのリンク。
value

EncryptionProtector[]

結果の配列。

ServerKeyType

暗号化プロテクタの種類 ('ServiceManaged'、'AzureKeyVault' など)。

名前 型 説明
AzureKeyVault

string

ServiceManaged

string