Organization interface

Pacote:

@azure/arm-confluent

Interface que representa uma Organização.

Métodos

beginCreate(string, string, OrganizationCreateOptionalParams)	Criar recurso da organização
beginCreateAndWait(string, string, OrganizationCreateOptionalParams)	Criar recurso da organização
beginDelete(string, string, OrganizationDeleteOptionalParams)	Excluir recurso da organização
beginDeleteAndWait(string, string, OrganizationDeleteOptionalParams)	Excluir recurso da organização
createAPIKey(string, string, string, string, CreateAPIKeyModel, OrganizationCreateAPIKeyOptionalParams)	Cria chave de API para um registro de esquema ID de cluster ou ID de cluster Kafka em um ambiente
deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)	Exclui a chave de API de um cluster de registro kafka ou esquema
get(string, string, OrganizationGetOptionalParams)	Obtenha as propriedades de um recurso específico da organização.
getClusterAPIKey(string, string, string, OrganizationGetClusterAPIKeyOptionalParams)	Obter detalhes da chave de API de um cluster de registro kafka ou esquema
getClusterById(string, string, string, string, OrganizationGetClusterByIdOptionalParams)	Obter cluster por Id
getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)	Obter detalhes do ambiente por ID do ambiente
getSchemaRegistryClusterById(string, string, string, string, OrganizationGetSchemaRegistryClusterByIdOptionalParams)	Obter cluster de registro de esquema por Id
listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)	Liste todas as organizações no grupo de recursos especificado.
listBySubscription(OrganizationListBySubscriptionOptionalParams)	Liste todas as organizações sob a assinatura especificada.
listClusters(string, string, string, OrganizationListClustersOptionalParams)	Listas de todos os clusters em um ambiente
listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)	Listas de todos os ambientes em uma organização
listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)	regiões do provedor de nuvem disponíveis para a criação de clusters do Registro de Esquema.
listSchemaRegistryClusters(string, string, string, OrganizationListSchemaRegistryClustersOptionalParams)	Obter clusters de registro de esquema
update(string, string, OrganizationUpdateOptionalParams)	Atualizar recurso da organização

Detalhes de Método

beginCreate(string, string, OrganizationCreateOptionalParams)

Criar recurso da organização

function beginCreate(resourceGroupName: string, organizationName: string, options?: OrganizationCreateOptionalParams): Promise<SimplePollerLike<OperationState<OrganizationResource>, OrganizationResource>>

Parâmetros

resourceGroupName

string

Nome do grupo de recursos

organizationName

string

Nome do recurso da organização

options

OrganizationCreateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<@azure/core-lro.SimplePollerLike<OperationState<OrganizationResource>, OrganizationResource>>

beginCreateAndWait(string, string, OrganizationCreateOptionalParams)

Criar recurso da organização

function beginCreateAndWait(resourceGroupName: string, organizationName: string, options?: OrganizationCreateOptionalParams): Promise<OrganizationResource>

Parâmetros

resourceGroupName

string

Nome do grupo de recursos

organizationName

string

Nome do recurso da organização

options

OrganizationCreateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<OrganizationResource>

beginDelete(string, string, OrganizationDeleteOptionalParams)

Excluir recurso da organização

function beginDelete(resourceGroupName: string, organizationName: string, options?: OrganizationDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parâmetros

resourceGroupName

string

Nome do grupo de recursos

organizationName

string

Nome do recurso da organização

options

OrganizationDeleteOptionalParams

Os parâmetros de opções.

Devoluções

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, OrganizationDeleteOptionalParams)

Excluir recurso da organização

function beginDeleteAndWait(resourceGroupName: string, organizationName: string, options?: OrganizationDeleteOptionalParams): Promise<void>

Parâmetros

resourceGroupName

string

Nome do grupo de recursos

organizationName

string

Nome do recurso da organização

options

OrganizationDeleteOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

createAPIKey(string, string, string, string, CreateAPIKeyModel, OrganizationCreateAPIKeyOptionalParams)

Cria chave de API para um registro de esquema ID de cluster ou ID de cluster Kafka em um ambiente

function createAPIKey(resourceGroupName: string, organizationName: string, environmentId: string, clusterId: string, body: CreateAPIKeyModel, options?: OrganizationCreateAPIKeyOptionalParams): Promise<APIKeyRecord>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

organizationName

string

Nome do recurso da organização

environmentId

string

Id do ambiente confluente

clusterId

string

Kafka confluente ou id do cluster de registro de esquema

body

CreateAPIKeyModel

Solicitar carga útil para obter a criação de chave de API para registro de esquema ID de cluster ou ID de cluster Kafka em um ambiente

options

OrganizationCreateAPIKeyOptionalParams

Os parâmetros de opções.

Devoluções

Promise<APIKeyRecord>

deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)

Exclui a chave de API de um cluster de registro kafka ou esquema

function deleteClusterAPIKey(resourceGroupName: string, organizationName: string, apiKeyId: string, options?: OrganizationDeleteClusterAPIKeyOptionalParams): Promise<void>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

organizationName

string

Nome do recurso da organização

apiKeyId

string

ID da chave de API confluente

options

OrganizationDeleteClusterAPIKeyOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

get(string, string, OrganizationGetOptionalParams)

Obtenha as propriedades de um recurso específico da organização.

function get(resourceGroupName: string, organizationName: string, options?: OrganizationGetOptionalParams): Promise<OrganizationResource>

Parâmetros

resourceGroupName

string

Nome do grupo de recursos

organizationName

string

Nome do recurso da organização

options

OrganizationGetOptionalParams

Os parâmetros de opções.

Devoluções

Promise<OrganizationResource>

getClusterAPIKey(string, string, string, OrganizationGetClusterAPIKeyOptionalParams)

Obter detalhes da chave de API de um cluster de registro kafka ou esquema

function getClusterAPIKey(resourceGroupName: string, organizationName: string, apiKeyId: string, options?: OrganizationGetClusterAPIKeyOptionalParams): Promise<APIKeyRecord>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

organizationName

string

Nome do recurso da organização

apiKeyId

string

ID da chave de API confluente

options

OrganizationGetClusterAPIKeyOptionalParams

Os parâmetros de opções.

Devoluções

Promise<APIKeyRecord>

getClusterById(string, string, string, string, OrganizationGetClusterByIdOptionalParams)

Obter cluster por Id

function getClusterById(resourceGroupName: string, organizationName: string, environmentId: string, clusterId: string, options?: OrganizationGetClusterByIdOptionalParams): Promise<SCClusterRecord>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

organizationName

string

Nome do recurso da organização

environmentId

string

Id do ambiente confluente

clusterId

string

Kafka confluente ou id do cluster de registro de esquema

options

OrganizationGetClusterByIdOptionalParams

Os parâmetros de opções.

Devoluções

Promise<SCClusterRecord>

getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)

Obter detalhes do ambiente por ID do ambiente

function getEnvironmentById(resourceGroupName: string, organizationName: string, environmentId: string, options?: OrganizationGetEnvironmentByIdOptionalParams): Promise<SCEnvironmentRecord>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

organizationName

string

Nome do recurso da organização

environmentId

string

Id do ambiente confluente

options

OrganizationGetEnvironmentByIdOptionalParams

Os parâmetros de opções.

Devoluções

Promise<SCEnvironmentRecord>

getSchemaRegistryClusterById(string, string, string, string, OrganizationGetSchemaRegistryClusterByIdOptionalParams)

Obter cluster de registro de esquema por Id

function getSchemaRegistryClusterById(resourceGroupName: string, organizationName: string, environmentId: string, clusterId: string, options?: OrganizationGetSchemaRegistryClusterByIdOptionalParams): Promise<SchemaRegistryClusterRecord>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

organizationName

string

Nome do recurso da organização

environmentId

string

Id do ambiente confluente

clusterId

string

Kafka confluente ou id do cluster de registro de esquema

options

OrganizationGetSchemaRegistryClusterByIdOptionalParams

Os parâmetros de opções.

Devoluções

Promise<SchemaRegistryClusterRecord>

listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)

Liste todas as organizações no grupo de recursos especificado.

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

Parâmetros

resourceGroupName

string

Nome do grupo de recursos

options

OrganizationListByResourceGroupOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

listBySubscription(OrganizationListBySubscriptionOptionalParams)

Liste todas as organizações sob a assinatura especificada.

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

Parâmetros

options

OrganizationListBySubscriptionOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

listClusters(string, string, string, OrganizationListClustersOptionalParams)

Listas de todos os clusters em um ambiente

function listClusters(resourceGroupName: string, organizationName: string, environmentId: string, options?: OrganizationListClustersOptionalParams): PagedAsyncIterableIterator<SCClusterRecord, SCClusterRecord[], PageSettings>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

organizationName

string

Nome do recurso da organização

environmentId

string

Id do ambiente confluente

options

OrganizationListClustersOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<SCClusterRecord, SCClusterRecord[], PageSettings>

listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)

Listas de todos os ambientes em uma organização

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

organizationName

string

Nome do recurso da organização

options

OrganizationListEnvironmentsOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<SCEnvironmentRecord, SCEnvironmentRecord[], PageSettings>

listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)

regiões do provedor de nuvem disponíveis para a criação de clusters do Registro de Esquema.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

organizationName

string

Nome do recurso da organização

body

ListAccessRequestModel

Modelo de solicitação de acesso à lista

options

OrganizationListRegionsOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ListRegionsSuccessResponse>

listSchemaRegistryClusters(string, string, string, OrganizationListSchemaRegistryClustersOptionalParams)

Obter clusters de registro de esquema

function listSchemaRegistryClusters(resourceGroupName: string, organizationName: string, environmentId: string, options?: OrganizationListSchemaRegistryClustersOptionalParams): PagedAsyncIterableIterator<SchemaRegistryClusterRecord, SchemaRegistryClusterRecord[], PageSettings>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

organizationName

string

Nome do recurso da organização

environmentId

string

Id do ambiente confluente

options

OrganizationListSchemaRegistryClustersOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<SchemaRegistryClusterRecord, SchemaRegistryClusterRecord[], PageSettings>

update(string, string, OrganizationUpdateOptionalParams)

Atualizar recurso da organização

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

Parâmetros

resourceGroupName

string

Nome do grupo de recursos

organizationName

string

Nome do recurso da organização

options

OrganizationUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<OrganizationResource>