ServerKeys interface
代表 ServerKeys 的介面。
方法
方法詳細資料
beginCreateOrUpdate(string, string, string, ServerKey, ServerKeysCreateOrUpdateOptionalParams)
建立或更新伺服器金鑰。
function beginCreateOrUpdate(resourceGroupName: string, serverName: string, keyName: string, parameters: ServerKey, options?: ServerKeysCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ServerKey>, ServerKey>>
參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure Resource Manager API 或入口網站取得此值。
- serverName
-
string
伺服器的名稱。
- keyName
-
string
要作的伺服器金鑰名稱(已更新或建立)。 金鑰名稱必須是格式為 『vault_key_version』。 例如,如果keyId是 https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion,則伺服器金鑰名稱的格式應為:YourVaultName_YourKeyName_YourKeyVersion
- parameters
- ServerKey
要求的伺服器金鑰資源狀態。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ServerKey>, ServerKey>>
beginCreateOrUpdateAndWait(string, string, string, ServerKey, ServerKeysCreateOrUpdateOptionalParams)
建立或更新伺服器金鑰。
function beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, keyName: string, parameters: ServerKey, options?: ServerKeysCreateOrUpdateOptionalParams): Promise<ServerKey>
參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure Resource Manager API 或入口網站取得此值。
- serverName
-
string
伺服器的名稱。
- keyName
-
string
要作的伺服器金鑰名稱(已更新或建立)。 金鑰名稱必須是格式為 『vault_key_version』。 例如,如果keyId是 https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion,則伺服器金鑰名稱的格式應為:YourVaultName_YourKeyName_YourKeyVersion
- parameters
- ServerKey
要求的伺服器金鑰資源狀態。
選項參數。
傳回
Promise<ServerKey>
beginDelete(string, string, string, ServerKeysDeleteOptionalParams)
刪除具有指定名稱的伺服器金鑰。
function beginDelete(resourceGroupName: string, serverName: string, keyName: string, options?: ServerKeysDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure Resource Manager API 或入口網站取得此值。
- serverName
-
string
伺服器的名稱。
- keyName
-
string
要刪除的伺服器金鑰名稱。
- options
- ServerKeysDeleteOptionalParams
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, ServerKeysDeleteOptionalParams)
刪除具有指定名稱的伺服器金鑰。
function beginDeleteAndWait(resourceGroupName: string, serverName: string, keyName: string, options?: ServerKeysDeleteOptionalParams): Promise<void>
參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure Resource Manager API 或入口網站取得此值。
- serverName
-
string
伺服器的名稱。
- keyName
-
string
要刪除的伺服器金鑰名稱。
- options
- ServerKeysDeleteOptionalParams
選項參數。
傳回
Promise<void>
get(string, string, string, ServerKeysGetOptionalParams)
取得伺服器金鑰。
function get(resourceGroupName: string, serverName: string, keyName: string, options?: ServerKeysGetOptionalParams): Promise<ServerKey>
參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure Resource Manager API 或入口網站取得此值。
- serverName
-
string
伺服器的名稱。
- keyName
-
string
要擷取的伺服器金鑰名稱。
- options
- ServerKeysGetOptionalParams
選項參數。
傳回
Promise<ServerKey>
listByServer(string, string, ServerKeysListByServerOptionalParams)
取得伺服器金鑰的清單。
function listByServer(resourceGroupName: string, serverName: string, options?: ServerKeysListByServerOptionalParams): PagedAsyncIterableIterator<ServerKey, ServerKey[], PageSettings>
參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure Resource Manager API 或入口網站取得此值。
- serverName
-
string
伺服器的名稱。
選項參數。