你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
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>