Organization interface

Пакет:

@azure/arm-confluent

Интерфейс, представляющий организацию.

Методы

beginCreate(string, string, OrganizationCreateOptionalParams)	Создание ресурса организации
beginCreateAndWait(string, string, OrganizationCreateOptionalParams)	Создание ресурса организации
beginDelete(string, string, OrganizationDeleteOptionalParams)	Удаление ресурса организации
beginDeleteAndWait(string, string, OrganizationDeleteOptionalParams)	Удаление ресурса организации
createAPIKey(string, string, string, string, CreateAPIKeyModel, OrganizationCreateAPIKeyOptionalParams)	Создает ключ API для идентификатора кластера реестра схемы или идентификатора кластера Kafka в среде.
deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)	Удаляет ключ API кластера реестра kafka или схемы.
get(string, string, OrganizationGetOptionalParams)	Получение свойств определенного ресурса Организации.
getClusterAPIKey(string, string, string, OrganizationGetClusterAPIKeyOptionalParams)	Получение сведений о разделе API для кластера реестра kafka или схемы
getClusterById(string, string, string, string, OrganizationGetClusterByIdOptionalParams)	Получение кластера по идентификатору
getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)	Получение сведений о среде по идентификатору среды
getSchemaRegistryClusterById(string, string, string, string, OrganizationGetSchemaRegistryClusterByIdOptionalParams)	Получение кластера реестра схемы по идентификатору
listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)	Выведите список всех организаций в указанной группе ресурсов.
listBySubscription(OrganizationListBySubscriptionOptionalParams)	Выведите список всех организаций в указанной подписке.
listClusters(string, string, string, OrganizationListClustersOptionalParams)	Списки всех кластеров в среде
listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)	Списки всех сред в организации
listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)	регионы поставщика облачных служб, доступные для создания кластеров Реестра схем.
listSchemaRegistryClusters(string, string, string, OrganizationListSchemaRegistryClustersOptionalParams)	Получение кластеров реестра схемы
update(string, string, OrganizationUpdateOptionalParams)	Обновление ресурса организации

Сведения о методе

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 в среде

options

OrganizationCreateAPIKeyOptionalParams

Параметры параметров.

Возвращаемое значение

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

options

OrganizationDeleteClusterAPIKeyOptionalParams

Параметры параметров.

Возвращаемое значение

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

options

OrganizationGetClusterAPIKeyOptionalParams

Параметры параметров.

Возвращаемое значение

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 или идентификатор кластера реестра схемы

options

OrganizationGetClusterByIdOptionalParams

Параметры параметров.

Возвращаемое значение

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

options

OrganizationGetEnvironmentByIdOptionalParams

Параметры параметров.

Возвращаемое значение

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 или идентификатор кластера реестра схемы

options

OrganizationGetSchemaRegistryClusterByIdOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<SchemaRegistryClusterRecord>

listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)

Выведите список всех организаций в указанной группе ресурсов.

function listByResourceGroup(resourceGroupName: string, options?: OrganizationListByResourceGroupOptionalParams): PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

Параметры

resourceGroupName

string

Имя группы ресурсов

options

OrganizationListByResourceGroupOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

listBySubscription(OrganizationListBySubscriptionOptionalParams)

Выведите список всех организаций в указанной подписке.

function listBySubscription(options?: OrganizationListBySubscriptionOptionalParams): PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

Параметры

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

options

OrganizationListClustersOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<SCClusterRecord, SCClusterRecord[], PageSettings>

listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)

Списки всех сред в организации

function listEnvironments(resourceGroupName: string, organizationName: string, options?: OrganizationListEnvironmentsOptionalParams): PagedAsyncIterableIterator<SCEnvironmentRecord, SCEnvironmentRecord[], PageSettings>

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

organizationName

string

Имя ресурса организации

options

OrganizationListEnvironmentsOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<SCEnvironmentRecord, SCEnvironmentRecord[], PageSettings>

listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)

регионы поставщика облачных служб, доступные для создания кластеров Реестра схем.

function listRegions(resourceGroupName: string, organizationName: string, body: ListAccessRequestModel, options?: OrganizationListRegionsOptionalParams): Promise<ListRegionsSuccessResponse>

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

organizationName

string

Имя ресурса организации

body

ListAccessRequestModel

Модель запроса на доступ к списку

options

OrganizationListRegionsOptionalParams

Параметры параметров.

Возвращаемое значение

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

options

OrganizationListSchemaRegistryClustersOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<SchemaRegistryClusterRecord, SchemaRegistryClusterRecord[], PageSettings>

update(string, string, OrganizationUpdateOptionalParams)

Обновление ресурса организации

function update(resourceGroupName: string, organizationName: string, options?: OrganizationUpdateOptionalParams): Promise<OrganizationResource>

Параметры

resourceGroupName

string

Имя группы ресурсов

organizationName

string

Имя ресурса организации

options

OrganizationUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<OrganizationResource>