SshPublicKeys interface
SshPublicKeys を表すインターフェイス。
メソッド
| create(string, string, Ssh |
新しい SSH 公開キー リソースを作成します。 |
| delete(string, string, Ssh |
SSH 公開キーを削除します。 |
| generate |
公開キーと秘密キーのペアを生成して返し、SSH 公開キー リソースに公開キーを設定します。 キーの長さは 3072 ビットです。 この操作は、SSH 公開キー リソースごとに 1 回だけ実行できます。 |
| 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 公開キーを作成するために指定されたパラメーター。
options パラメーター。
戻り値
Promise<SshPublicKeyResource>
delete(string, string, SshPublicKeysDeleteOptionalParams)
SSH 公開キーを削除します。
function delete(resourceGroupName: string, sshPublicKeyName: string, options?: SshPublicKeysDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。
- sshPublicKeyName
-
string
SSH 公開キーの名前。
options パラメーター。
戻り値
Promise<void>
generateKeyPair(string, string, SshPublicKeysGenerateKeyPairOptionalParams)
公開キーと秘密キーのペアを生成して返し、SSH 公開キー リソースに公開キーを設定します。 キーの長さは 3072 ビットです。 この操作は、SSH 公開キー リソースごとに 1 回だけ実行できます。
function generateKeyPair(resourceGroupName: string, sshPublicKeyName: string, options?: SshPublicKeysGenerateKeyPairOptionalParams): Promise<SshPublicKeyGenerateKeyPairResult>パラメーター
- resourceGroupName
-
string
リソース グループの名前。
- sshPublicKeyName
-
string
SSH 公開キーの名前。
options パラメーター。
戻り値
Promise<SshPublicKeyGenerateKeyPairResult>
get(string, string, SshPublicKeysGetOptionalParams)
SSH 公開キーに関する情報を取得します。
function get(resourceGroupName: string, sshPublicKeyName: string, options?: SshPublicKeysGetOptionalParams): Promise<SshPublicKeyResource>パラメーター
- resourceGroupName
-
string
リソース グループの名前。
- sshPublicKeyName
-
string
SSH 公開キーの名前。
- options
- SshPublicKeysGetOptionalParams
options パラメーター。
戻り値
Promise<SshPublicKeyResource>
listByResourceGroup(string, SshPublicKeysListByResourceGroupOptionalParams)
指定したリソース グループ内のすべての SSH 公開キーを一覧表示します。 応答で nextLink プロパティを使用して、SSH 公開キーの次のページを取得します。
function listByResourceGroup(resourceGroupName: string, options?: SshPublicKeysListByResourceGroupOptionalParams): PagedAsyncIterableIterator<SshPublicKeyResource, SshPublicKeyResource[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。
options パラメーター。
戻り値
listBySubscription(SshPublicKeysListBySubscriptionOptionalParams)
サブスクリプション内のすべての SSH 公開キーを一覧表示します。 応答で nextLink プロパティを使用して、SSH 公開キーの次のページを取得します。
function listBySubscription(options?: SshPublicKeysListBySubscriptionOptionalParams): PagedAsyncIterableIterator<SshPublicKeyResource, SshPublicKeyResource[], PageSettings>パラメーター
options パラメーター。
戻り値
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 公開キーを更新するために指定されたパラメーター。
options パラメーター。
戻り値
Promise<SshPublicKeyResource>