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 參數

名稱	位於	必要	類型	Description
encryptionProtectorName	path	True	EncryptionProtectorName	要擷取之加密保護裝置的名稱。
resourceGroupName	path	True	string	包含資源的資源群組名稱。 您可以從 Azure Resource Manager API 或入口網站取得此值。
serverName	path	True	string	伺服器的名稱。
subscriptionId	path	True	string	識別 Azure 訂用帳戶的訂用帳戶標識碼。
api-version	query	True	string	要用於要求的 API 版本。

回應

名稱	類型	Description
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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/EncryptionProtectorGet.json
// this example is just showing the usage of "EncryptionProtectors_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
string serverName = "sqlcrudtest-4645";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this EncryptionProtectorResource
EncryptionProtectorCollection collection = sqlServer.GetEncryptionProtectors();

// invoke the operation
EncryptionProtectorName encryptionProtectorName = EncryptionProtectorName.Current;
NullableResponse<EncryptionProtectorResource> response = await collection.GetIfExistsAsync(encryptionProtectorName);
EncryptionProtectorResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    EncryptionProtectorData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:

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
  }
}

定義

名稱	Description
EncryptionProtector	伺服器加密保護裝置。
EncryptionProtectorName	要擷取之加密保護裝置的名稱。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
ServerKeyType	加密保護裝置類型，例如 'ServiceManaged'、'AzureKeyVault'。

EncryptionProtector

Object

伺服器加密保護裝置。

名稱	類型	Description
id	string	資源標識碼。
kind	string	加密保護裝置的種類。 這是用於 Azure 入口網站體驗的元數據。
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

列舉型別

要擷取之加密保護裝置的名稱。

值	Description
current

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

ServerKeyType

列舉型別

加密保護裝置類型，例如 'ServiceManaged'、'AzureKeyVault'。

值	Description
ServiceManaged
AzureKeyVault