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)
Создает ключ API для идентификатора кластера реестра схем или идентификатора кластера Kafka в среде
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
Запрос полезных данных для создания ключа API для идентификатора кластера реестра схем или идентификатора кластера Kafka в среде
Параметры параметров.
Возвращаемое значение
Promise<APIKeyRecord>
deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)
Удаляет ключ API кластера kafka или реестра схем
function deleteClusterAPIKey(resourceGroupName: string, organizationName: string, apiKeyId: string, options?: OrganizationDeleteClusterAPIKeyOptionalParams): Promise<void>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Имя не учитывает регистр.
- organizationName
-
string
Имя ресурса организации
- apiKeyId
-
string
Идентификатор ключа API Confluent
Параметры параметров.
Возвращаемое значение
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)
Получение сведений о разделе API кластера kafka или реестра схем
function getClusterAPIKey(resourceGroupName: string, organizationName: string, apiKeyId: string, options?: OrganizationGetClusterAPIKeyOptionalParams): Promise<APIKeyRecord>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Имя не учитывает регистр.
- organizationName
-
string
Имя ресурса организации
- apiKeyId
-
string
Идентификатор ключа API Confluent
Параметры параметров.
Возвращаемое значение
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>