Encryption Protectors - Get

サービス:

SQL Database

API バージョン:

2023-08-01

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

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

URI パラメーター

名前	/	必須	型	説明
encryptionProtectorName	path	True	EncryptionProtectorName	取得する暗号化保護機能の名前。
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	EncryptionProtector	指定したサーバー暗号化保護機能を正常に取得しました。
Other Status Codes	ErrorResponse	エラー応答: *** 400 ManagedInstanceStoppingOrStopped - インスタンスが停止/停止状態にある間に送信された操作の競合 400 ManagedInstanceStarting - インスタンスが開始状態の間に送信された操作の競合 400 InvalidKeyName - サーバー キー名に無効な値が指定されました。 400 InvalidKeyType - サーバー キーの作成の種類はサポートされていません。 400 InvalidUpsertKeyType - サービスで管理される TDE キーは、サービスによって管理されます。 サービスで管理される TDE キーは、ユーザーによる作成または更新をサポートしていません。 400 InvalidKeyUpsertRequest - サーバー キーの作成要求が存在しないか、プロパティ オブジェクトがありません。 400 InvalidEncryptionProtectorName - 暗号化保護機能キー名はサポートされていません。 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソース グループとサブスクリプションに存在しません。 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。

例

Get the encryption protector

要求のサンプル

HTTP

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

応答のサンプル

状態コード:

200

{
  "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",
    "autoRotationEnabled": false
  }
}

定義

名前	説明
EncryptionProtector	サーバー暗号化保護機能。
EncryptionProtectorName	取得する暗号化保護機能の名前。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ServerKeyType	"ServiceManaged"、"AzureKeyVault" などの暗号化保護機能の種類。

EncryptionProtector

Object

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

名前	型	説明
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	リソースの種類。

EncryptionProtectorName

列挙

取得する暗号化保護機能の名前。

値	説明
current

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

ServerKeyType

列挙

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

値	説明
AzureKeyVault
ServiceManaged