Roles interface

パッケージ:

@azure/arm-cosmosdbforpostgresql

ロールを表すインターフェイス。

メソッド

beginCreate(string, string, string, Role, RolesCreateOptionalParams)	新しいロールを作成するか、既存のロールを更新します。
beginCreateAndWait(string, string, string, Role, RolesCreateOptionalParams)	新しいロールを作成するか、既存のロールを更新します。
beginDelete(string, string, string, RolesDeleteOptionalParams)	クラスター ロールを削除します。
beginDeleteAndWait(string, string, string, RolesDeleteOptionalParams)	クラスター ロールを削除します。
get(string, string, string, RolesGetOptionalParams)	クラスター ロールに関する情報を取得します。
listByCluster(string, string, RolesListByClusterOptionalParams)	特定のクラスター内のすべてのロールを一覧表示します。

メソッドの詳細

beginCreate(string, string, string, Role, RolesCreateOptionalParams)

新しいロールを作成するか、既存のロールを更新します。

function beginCreate(resourceGroupName: string, clusterName: string, roleName: string, parameters: Role, options?: RolesCreateOptionalParams): Promise<SimplePollerLike<OperationState<Role>, Role>>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

clusterName

string

クラスターの名前です。

roleName

string

クラスター ロールの名前。

parameters

Role

ロールを作成または更新するために必要なパラメーター。

options

RolesCreateOptionalParams

options パラメーター。

戻り値

Promise<@azure/core-lro.SimplePollerLike<OperationState<Role>, Role>>

beginCreateAndWait(string, string, string, Role, RolesCreateOptionalParams)

新しいロールを作成するか、既存のロールを更新します。

function beginCreateAndWait(resourceGroupName: string, clusterName: string, roleName: string, parameters: Role, options?: RolesCreateOptionalParams): Promise<Role>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

clusterName

string

クラスターの名前です。

roleName

string

クラスター ロールの名前。

parameters

Role

ロールを作成または更新するために必要なパラメーター。

options

RolesCreateOptionalParams

options パラメーター。

戻り値

Promise<Role>

beginDelete(string, string, string, RolesDeleteOptionalParams)

クラスター ロールを削除します。

function beginDelete(resourceGroupName: string, clusterName: string, roleName: string, options?: RolesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<RolesDeleteHeaders>, RolesDeleteHeaders>>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

clusterName

string

クラスターの名前です。

roleName

string

クラスター ロールの名前。

options

RolesDeleteOptionalParams

options パラメーター。

戻り値

Promise<@azure/core-lro.SimplePollerLike<OperationState<RolesDeleteHeaders>, RolesDeleteHeaders>>

beginDeleteAndWait(string, string, string, RolesDeleteOptionalParams)

クラスター ロールを削除します。

function beginDeleteAndWait(resourceGroupName: string, clusterName: string, roleName: string, options?: RolesDeleteOptionalParams): Promise<RolesDeleteHeaders>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

clusterName

string

クラスターの名前です。

roleName

string

クラスター ロールの名前。

options

RolesDeleteOptionalParams

options パラメーター。

戻り値

Promise<RolesDeleteHeaders>

get(string, string, string, RolesGetOptionalParams)

クラスター ロールに関する情報を取得します。

function get(resourceGroupName: string, clusterName: string, roleName: string, options?: RolesGetOptionalParams): Promise<Role>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

clusterName

string

クラスターの名前です。

roleName

string

クラスター ロールの名前。

options

RolesGetOptionalParams

options パラメーター。

戻り値

Promise<Role>

listByCluster(string, string, RolesListByClusterOptionalParams)

特定のクラスター内のすべてのロールを一覧表示します。

function listByCluster(resourceGroupName: string, clusterName: string, options?: RolesListByClusterOptionalParams): PagedAsyncIterableIterator<Role, Role[], PageSettings>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

clusterName

string

クラスターの名前です。

options

RolesListByClusterOptionalParams

options パラメーター。

戻り値

PagedAsyncIterableIterator<Role, Role[], PageSettings>