SshPublicKeys interface
表示 SshPublicKeys 的介面。
方法
| create(string, string, Ssh |
建立新的 SSH 公鑰資源。 |
| delete(string, string, Ssh |
刪除 SSH 公鑰。 |
| generate |
產生並傳回公開/私鑰組，並使用公鑰填入 SSH 公鑰資源。 金鑰的長度會是 3072 位。 此作業只能針對每個 SSH 公鑰資源執行一次。 |
| get(string, string, Ssh |
擷取 SSH 公鑰的相關信息。 |
| list |
列出指定資源群組中的所有 SSH 公鑰。 在回應中使用 nextLink 屬性來取得 SSH 公鑰的下一頁。 |
| list |
列出訂用帳戶中的所有 SSH 公鑰。 在回應中使用 nextLink 屬性來取得 SSH 公鑰的下一頁。 |
| update(string, string, Ssh |
更新新的 SSH 公鑰資源。 |
方法詳細資料
create(string, string, SshPublicKeyResource, SshPublicKeysCreateOptionalParams)
建立新的 SSH 公鑰資源。
function create(resourceGroupName: string, sshPublicKeyName: string, parameters: SshPublicKeyResource, options?: SshPublicKeysCreateOptionalParams): Promise<SshPublicKeyResource>參數
- resourceGroupName
-
string
資源群組的名稱。
- sshPublicKeyName
-
string
SSH 公鑰的名稱。
- parameters
- SshPublicKeyResource
提供用來建立 SSH 公鑰的參數。
選項參數。
傳回
Promise<SshPublicKeyResource>
delete(string, string, SshPublicKeysDeleteOptionalParams)
刪除 SSH 公鑰。
function delete(resourceGroupName: string, sshPublicKeyName: string, options?: SshPublicKeysDeleteOptionalParams): Promise<void>參數
- resourceGroupName
-
string
資源群組的名稱。
- sshPublicKeyName
-
string
SSH 公鑰的名稱。
選項參數。
傳回
Promise<void>
generateKeyPair(string, string, SshPublicKeysGenerateKeyPairOptionalParams)
產生並傳回公開/私鑰組，並使用公鑰填入 SSH 公鑰資源。 金鑰的長度會是 3072 位。 此作業只能針對每個 SSH 公鑰資源執行一次。
function generateKeyPair(resourceGroupName: string, sshPublicKeyName: string, options?: SshPublicKeysGenerateKeyPairOptionalParams): Promise<SshPublicKeyGenerateKeyPairResult>參數
- resourceGroupName
-
string
資源群組的名稱。
- sshPublicKeyName
-
string
SSH 公鑰的名稱。
選項參數。
傳回
Promise<SshPublicKeyGenerateKeyPairResult>
get(string, string, SshPublicKeysGetOptionalParams)
擷取 SSH 公鑰的相關信息。
function get(resourceGroupName: string, sshPublicKeyName: string, options?: SshPublicKeysGetOptionalParams): Promise<SshPublicKeyResource>參數
- resourceGroupName
-
string
資源群組的名稱。
- sshPublicKeyName
-
string
SSH 公鑰的名稱。
- options
- SshPublicKeysGetOptionalParams
選項參數。
傳回
Promise<SshPublicKeyResource>
listByResourceGroup(string, SshPublicKeysListByResourceGroupOptionalParams)
列出指定資源群組中的所有 SSH 公鑰。 在回應中使用 nextLink 屬性來取得 SSH 公鑰的下一頁。
function listByResourceGroup(resourceGroupName: string, options?: SshPublicKeysListByResourceGroupOptionalParams): PagedAsyncIterableIterator<SshPublicKeyResource, SshPublicKeyResource[], PageSettings>參數
- resourceGroupName
-
string
資源群組的名稱。
選項參數。
傳回
listBySubscription(SshPublicKeysListBySubscriptionOptionalParams)
列出訂用帳戶中的所有 SSH 公鑰。 在回應中使用 nextLink 屬性來取得 SSH 公鑰的下一頁。
function listBySubscription(options?: SshPublicKeysListBySubscriptionOptionalParams): PagedAsyncIterableIterator<SshPublicKeyResource, SshPublicKeyResource[], PageSettings>參數
選項參數。
傳回
update(string, string, SshPublicKeyUpdateResource, SshPublicKeysUpdateOptionalParams)
更新新的 SSH 公鑰資源。
function update(resourceGroupName: string, sshPublicKeyName: string, parameters: SshPublicKeyUpdateResource, options?: SshPublicKeysUpdateOptionalParams): Promise<SshPublicKeyResource>參數
- resourceGroupName
-
string
資源群組的名稱。
- sshPublicKeyName
-
string
SSH 公鑰的名稱。
- parameters
- SshPublicKeyUpdateResource
提供用來更新 SSH 公鑰的參數。
選項參數。
傳回
Promise<SshPublicKeyResource>