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)
在環境中建立架構登錄叢集標識碼或 Kafka 叢集識別碼的 API 金鑰
function createAPIKey(resourceGroupName: string, organizationName: string, environmentId: string, clusterId: string, body: CreateAPIKeyModel, options?: OrganizationCreateAPIKeyOptionalParams): Promise<APIKeyRecord>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- organizationName
-
string
組織資源名稱
- environmentId
-
string
Confluent 環境標識碼
- clusterId
-
string
Confluent kafka 或架構登錄叢集標識符
- body
- CreateAPIKeyModel
要求承載以取得架構登錄叢集標識碼或環境中 Kafka 叢集識別碼的 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 金鑰標識碼
選項參數。
傳回
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 金鑰標識碼
選項參數。
傳回
Promise<APIKeyRecord>
getClusterById(string, string, string, string, OrganizationGetClusterByIdOptionalParams)
依標識碼取得叢集
function getClusterById(resourceGroupName: string, organizationName: string, environmentId: string, clusterId: string, options?: OrganizationGetClusterByIdOptionalParams): Promise<SCClusterRecord>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- organizationName
-
string
組織資源名稱
- environmentId
-
string
Confluent 環境標識碼
- clusterId
-
string
Confluent kafka 或架構登錄叢集標識符
選項參數。
傳回
Promise<SCClusterRecord>
getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)
依環境標識碼取得環境詳細數據
function getEnvironmentById(resourceGroupName: string, organizationName: string, environmentId: string, options?: OrganizationGetEnvironmentByIdOptionalParams): Promise<SCEnvironmentRecord>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- organizationName
-
string
組織資源名稱
- environmentId
-
string
Confluent 環境標識碼
選項參數。
傳回
Promise<SCEnvironmentRecord>
getSchemaRegistryClusterById(string, string, string, string, OrganizationGetSchemaRegistryClusterByIdOptionalParams)
依標識元取得架構登錄叢集
function getSchemaRegistryClusterById(resourceGroupName: string, organizationName: string, environmentId: string, clusterId: string, options?: OrganizationGetSchemaRegistryClusterByIdOptionalParams): Promise<SchemaRegistryClusterRecord>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- organizationName
-
string
組織資源名稱
- environmentId
-
string
Confluent 環境標識碼
- clusterId
-
string
Confluent kafka 或架構登錄叢集標識符
選項參數。
傳回
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 環境標識碼
選項參數。
傳回
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 環境標識碼
選項參數。
傳回
update(string, string, OrganizationUpdateOptionalParams)
更新組織資源
function update(resourceGroupName: string, organizationName: string, options?: OrganizationUpdateOptionalParams): Promise<OrganizationResource>參數
- resourceGroupName
-
string
資源群組名稱
- organizationName
-
string
組織資源名稱
- options
- OrganizationUpdateOptionalParams
選項參數。
傳回
Promise<OrganizationResource>