Organization interface
組織を表すインターフェイス。
メソッド
メソッドの詳細
beginCreate(string, string, OrganizationCreateOptionalParams)
組織のリソースを作成する
function beginCreate(resourceGroupName: string, organizationName: string, options?: OrganizationCreateOptionalParams): Promise<SimplePollerLike<OperationState<OrganizationResource>, OrganizationResource>>パラメーター
- resourceGroupName
-
string
リソース グループ名
- organizationName
-
string
組織のリソース名
- options
- OrganizationCreateOptionalParams
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<OrganizationResource>, OrganizationResource>>
beginCreateAndWait(string, string, OrganizationCreateOptionalParams)
組織のリソースを作成する
function beginCreateAndWait(resourceGroupName: string, organizationName: string, options?: OrganizationCreateOptionalParams): Promise<OrganizationResource>パラメーター
- resourceGroupName
-
string
リソース グループ名
- organizationName
-
string
組織のリソース名
- options
- OrganizationCreateOptionalParams
オプション パラメーター。
戻り値
Promise<OrganizationResource>
beginDelete(string, string, OrganizationDeleteOptionalParams)
組織のリソースを削除する
function beginDelete(resourceGroupName: string, organizationName: string, options?: OrganizationDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>パラメーター
- resourceGroupName
-
string
リソース グループ名
- organizationName
-
string
組織のリソース名
- options
- OrganizationDeleteOptionalParams
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, OrganizationDeleteOptionalParams)
組織のリソースを削除する
function beginDeleteAndWait(resourceGroupName: string, organizationName: string, options?: OrganizationDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループ名
- organizationName
-
string
組織のリソース名
- options
- OrganizationDeleteOptionalParams
オプション パラメーター。
戻り値
Promise<void>
createAPIKey(string, string, string, string, CreateAPIKeyModel, OrganizationCreateAPIKeyOptionalParams)
環境内のスキーマ レジストリ クラスター ID または Kafka クラスター ID の API キーを作成します
function createAPIKey(resourceGroupName: string, organizationName: string, environmentId: string, clusterId: string, body: CreateAPIKeyModel, options?: OrganizationCreateAPIKeyOptionalParams): Promise<APIKeyRecord>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- organizationName
-
string
組織のリソース名
- environmentId
-
string
Confluent 環境 ID
- clusterId
-
string
Confluent kafka またはスキーマ レジストリ クラスター ID
- body
- CreateAPIKeyModel
環境内のスキーマ レジストリ クラスター ID または Kafka クラスター ID の API キーを作成するための要求ペイロード
オプション パラメーター。
戻り値
Promise<APIKeyRecord>
deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)
kafka またはスキーマ レジストリ クラスターの API キーを削除します
function deleteClusterAPIKey(resourceGroupName: string, organizationName: string, apiKeyId: string, options?: OrganizationDeleteClusterAPIKeyOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- organizationName
-
string
組織のリソース名
- apiKeyId
-
string
Confluent API キー ID
オプション パラメーター。
戻り値
Promise<void>
get(string, string, OrganizationGetOptionalParams)
特定の組織リソースのプロパティを取得します。
function get(resourceGroupName: string, organizationName: string, options?: OrganizationGetOptionalParams): Promise<OrganizationResource>パラメーター
- resourceGroupName
-
string
リソース グループ名
- organizationName
-
string
組織のリソース名
- options
- OrganizationGetOptionalParams
オプション パラメーター。
戻り値
Promise<OrganizationResource>
getClusterAPIKey(string, string, string, OrganizationGetClusterAPIKeyOptionalParams)
kafka またはスキーマ レジストリ クラスターの API キーの詳細を取得する
function getClusterAPIKey(resourceGroupName: string, organizationName: string, apiKeyId: string, options?: OrganizationGetClusterAPIKeyOptionalParams): Promise<APIKeyRecord>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- organizationName
-
string
組織のリソース名
- apiKeyId
-
string
Confluent API キー ID
オプション パラメーター。
戻り値
Promise<APIKeyRecord>
getClusterById(string, string, string, string, OrganizationGetClusterByIdOptionalParams)
ID でクラスターを取得する
function getClusterById(resourceGroupName: string, organizationName: string, environmentId: string, clusterId: string, options?: OrganizationGetClusterByIdOptionalParams): Promise<SCClusterRecord>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- organizationName
-
string
組織のリソース名
- environmentId
-
string
Confluent 環境 ID
- clusterId
-
string
Confluent kafka またはスキーマ レジストリ クラスター ID
オプション パラメーター。
戻り値
Promise<SCClusterRecord>
getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)
環境 ID で環境の詳細を取得する
function getEnvironmentById(resourceGroupName: string, organizationName: string, environmentId: string, options?: OrganizationGetEnvironmentByIdOptionalParams): Promise<SCEnvironmentRecord>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- organizationName
-
string
組織のリソース名
- environmentId
-
string
Confluent 環境 ID
オプション パラメーター。
戻り値
Promise<SCEnvironmentRecord>
getSchemaRegistryClusterById(string, string, string, string, OrganizationGetSchemaRegistryClusterByIdOptionalParams)
ID でスキーマ レジストリ クラスターを取得する
function getSchemaRegistryClusterById(resourceGroupName: string, organizationName: string, environmentId: string, clusterId: string, options?: OrganizationGetSchemaRegistryClusterByIdOptionalParams): Promise<SchemaRegistryClusterRecord>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- organizationName
-
string
組織のリソース名
- environmentId
-
string
Confluent 環境 ID
- clusterId
-
string
Confluent kafka またはスキーマ レジストリ クラスター ID
オプション パラメーター。
戻り値
Promise<SchemaRegistryClusterRecord>
listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)
指定したリソース グループのすべての組織を一覧表示します。
function listByResourceGroup(resourceGroupName: string, options?: OrganizationListByResourceGroupOptionalParams): PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループ名
オプション パラメーター。
戻り値
listBySubscription(OrganizationListBySubscriptionOptionalParams)
指定したサブスクリプションのすべての組織を一覧表示します。
function listBySubscription(options?: OrganizationListBySubscriptionOptionalParams): PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>パラメーター
オプション パラメーター。
戻り値
listClusters(string, string, string, OrganizationListClustersOptionalParams)
環境内のすべてのクラスターの一覧
function listClusters(resourceGroupName: string, organizationName: string, environmentId: string, options?: OrganizationListClustersOptionalParams): PagedAsyncIterableIterator<SCClusterRecord, SCClusterRecord[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- organizationName
-
string
組織のリソース名
- environmentId
-
string
Confluent 環境 ID
オプション パラメーター。
戻り値
listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)
組織内のすべての環境の一覧
function listEnvironments(resourceGroupName: string, organizationName: string, options?: OrganizationListEnvironmentsOptionalParams): PagedAsyncIterableIterator<SCEnvironmentRecord, SCEnvironmentRecord[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- organizationName
-
string
組織のリソース名
オプション パラメーター。
戻り値
listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)
スキーマ レジストリ クラスターを作成するために使用できるクラウド プロバイダー リージョン。
function listRegions(resourceGroupName: string, organizationName: string, body: ListAccessRequestModel, options?: OrganizationListRegionsOptionalParams): Promise<ListRegionsSuccessResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- organizationName
-
string
組織のリソース名
リスト アクセス要求モデル
オプション パラメーター。
戻り値
Promise<ListRegionsSuccessResponse>
listSchemaRegistryClusters(string, string, string, OrganizationListSchemaRegistryClustersOptionalParams)
スキーマ レジストリ クラスターを取得する
function listSchemaRegistryClusters(resourceGroupName: string, organizationName: string, environmentId: string, options?: OrganizationListSchemaRegistryClustersOptionalParams): PagedAsyncIterableIterator<SchemaRegistryClusterRecord, SchemaRegistryClusterRecord[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- organizationName
-
string
組織のリソース名
- environmentId
-
string
Confluent 環境 ID
オプション パラメーター。
戻り値
update(string, string, OrganizationUpdateOptionalParams)
組織のリソースを更新する
function update(resourceGroupName: string, organizationName: string, options?: OrganizationUpdateOptionalParams): Promise<OrganizationResource>パラメーター
- resourceGroupName
-
string
リソース グループ名
- organizationName
-
string
組織のリソース名
- options
- OrganizationUpdateOptionalParams
オプション パラメーター。
戻り値
Promise<OrganizationResource>