Organization interface

Pacchetto:

@azure/arm-confluent

Interfaccia che rappresenta un'organizzazione.

Metodi

beginCreate(string, string, OrganizationCreateOptionalParams)	Creare una risorsa organizzazione
beginCreateAndWait(string, string, OrganizationCreateOptionalParams)	Creare una risorsa organizzazione
beginDelete(string, string, OrganizationDeleteOptionalParams)	Elimina risorsa organizzazione
beginDeleteAndWait(string, string, OrganizationDeleteOptionalParams)	Elimina risorsa organizzazione
createAPIKey(string, string, string, string, CreateAPIKeyModel, OrganizationCreateAPIKeyOptionalParams)	Crea la chiave API per un ID cluster del Registro di sistema dello schema o un ID cluster Kafka in un ambiente
deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)	Elimina la chiave API di un cluster del Registro di sistema kafka o dello schema
get(string, string, OrganizationGetOptionalParams)	Ottenere le proprietà di una risorsa organizzazione specifica.
getClusterAPIKey(string, string, string, OrganizationGetClusterAPIKeyOptionalParams)	Ottenere i dettagli della chiave API di un cluster del Registro di sistema kafka o dello schema
getClusterById(string, string, string, string, OrganizationGetClusterByIdOptionalParams)	Ottenere il cluster in base all'ID
getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)	Ottenere i dettagli dell'ambiente in base all'ID ambiente
getSchemaRegistryClusterById(string, string, string, string, OrganizationGetSchemaRegistryClusterByIdOptionalParams)	Ottenere il cluster del Registro di sistema dello schema in base all'ID
listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)	Elencare tutte le organizzazioni nel gruppo di risorse specificato.
listBySubscription(OrganizationListBySubscriptionOptionalParams)	Elencare tutte le organizzazioni nella sottoscrizione specificata.
listClusters(string, string, string, OrganizationListClustersOptionalParams)	Elenchi di tutti i cluster in un ambiente
listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)	Elenchi di tutti gli ambienti in un'organizzazione
listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)	aree del provider di servizi cloud disponibili per la creazione di cluster del Registro schemi.
listSchemaRegistryClusters(string, string, string, OrganizationListSchemaRegistryClustersOptionalParams)	Ottenere i cluster del Registro di sistema dello schema
update(string, string, OrganizationUpdateOptionalParams)	Aggiornare la risorsa organizzazione

Dettagli metodo

beginCreate(string, string, OrganizationCreateOptionalParams)

Creare una risorsa organizzazione

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

Parametri

resourceGroupName

string

Nome gruppo di risorse

organizationName

string

Nome risorsa organizzazione

options

OrganizationCreateOptionalParams

Parametri delle opzioni.

Restituisce

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

beginCreateAndWait(string, string, OrganizationCreateOptionalParams)

Creare una risorsa organizzazione

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

Parametri

resourceGroupName

string

Nome gruppo di risorse

organizationName

string

Nome risorsa organizzazione

options

OrganizationCreateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<OrganizationResource>

beginDelete(string, string, OrganizationDeleteOptionalParams)

Elimina risorsa organizzazione

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

Parametri

resourceGroupName

string

Nome gruppo di risorse

organizationName

string

Nome risorsa organizzazione

options

OrganizationDeleteOptionalParams

Parametri delle opzioni.

Restituisce

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

beginDeleteAndWait(string, string, OrganizationDeleteOptionalParams)

Elimina risorsa organizzazione

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

Parametri

resourceGroupName

string

Nome gruppo di risorse

organizationName

string

Nome risorsa organizzazione

options

OrganizationDeleteOptionalParams

Parametri delle opzioni.

Restituisce

Promise<void>

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

Crea la chiave API per un ID cluster del Registro di sistema dello schema o un ID cluster Kafka in un ambiente

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

organizationName

string

Nome risorsa organizzazione

environmentId

string

ID ambiente Confluent

clusterId

string

ID cluster del Registro di sistema confluent kafka o schema

body

CreateAPIKeyModel

Payload della richiesta per ottenere la creazione della chiave API per l'ID cluster del Registro di sistema dello schema o l'ID cluster Kafka in un ambiente

options

OrganizationCreateAPIKeyOptionalParams

Parametri delle opzioni.

Restituisce

Promise<APIKeyRecord>

deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)

Elimina la chiave API di un cluster del Registro di sistema kafka o dello schema

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

organizationName

string

Nome risorsa organizzazione

apiKeyId

string

ID chiave API Confluent

options

OrganizationDeleteClusterAPIKeyOptionalParams

Parametri delle opzioni.

Restituisce

Promise<void>

get(string, string, OrganizationGetOptionalParams)

Ottenere le proprietà di una risorsa organizzazione specifica.

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

Parametri

resourceGroupName

string

Nome gruppo di risorse

organizationName

string

Nome risorsa organizzazione

options

OrganizationGetOptionalParams

Parametri delle opzioni.

Restituisce

Promise<OrganizationResource>

getClusterAPIKey(string, string, string, OrganizationGetClusterAPIKeyOptionalParams)

Ottenere i dettagli della chiave API di un cluster del Registro di sistema kafka o dello schema

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

organizationName

string

Nome risorsa organizzazione

apiKeyId

string

ID chiave API Confluent

options

OrganizationGetClusterAPIKeyOptionalParams

Parametri delle opzioni.

Restituisce

Promise<APIKeyRecord>

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

Ottenere il cluster in base all'ID

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

organizationName

string

Nome risorsa organizzazione

environmentId

string

ID ambiente Confluent

clusterId

string

ID cluster del Registro di sistema confluent kafka o schema

options

OrganizationGetClusterByIdOptionalParams

Parametri delle opzioni.

Restituisce

Promise<SCClusterRecord>

getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)

Ottenere i dettagli dell'ambiente in base all'ID ambiente

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

organizationName

string

Nome risorsa organizzazione

environmentId

string

ID ambiente Confluent

options

OrganizationGetEnvironmentByIdOptionalParams

Parametri delle opzioni.

Restituisce

Promise<SCEnvironmentRecord>

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

Ottenere il cluster del Registro di sistema dello schema in base all'ID

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

organizationName

string

Nome risorsa organizzazione

environmentId

string

ID ambiente Confluent

clusterId

string

ID cluster del Registro di sistema confluent kafka o schema

options

OrganizationGetSchemaRegistryClusterByIdOptionalParams

Parametri delle opzioni.

Restituisce

Promise<SchemaRegistryClusterRecord>

listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)

Elencare tutte le organizzazioni nel gruppo di risorse specificato.

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

Parametri

resourceGroupName

string

Nome gruppo di risorse

options

OrganizationListByResourceGroupOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

listBySubscription(OrganizationListBySubscriptionOptionalParams)

Elencare tutte le organizzazioni nella sottoscrizione specificata.

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

Parametri

options

OrganizationListBySubscriptionOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

listClusters(string, string, string, OrganizationListClustersOptionalParams)

Elenchi di tutti i cluster in un ambiente

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

organizationName

string

Nome risorsa organizzazione

environmentId

string

ID ambiente Confluent

options

OrganizationListClustersOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<SCClusterRecord, SCClusterRecord[], PageSettings>

listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)

Elenchi di tutti gli ambienti in un'organizzazione

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

organizationName

string

Nome risorsa organizzazione

options

OrganizationListEnvironmentsOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<SCEnvironmentRecord, SCEnvironmentRecord[], PageSettings>

listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)

aree del provider di servizi cloud disponibili per la creazione di cluster del Registro schemi.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

organizationName

string

Nome risorsa organizzazione

body

ListAccessRequestModel

Elencare il modello di richiesta di accesso

options

OrganizationListRegionsOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ListRegionsSuccessResponse>

listSchemaRegistryClusters(string, string, string, OrganizationListSchemaRegistryClustersOptionalParams)

Ottenere i cluster del Registro di sistema dello schema

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

organizationName

string

Nome risorsa organizzazione

environmentId

string

ID ambiente Confluent

options

OrganizationListSchemaRegistryClustersOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<SchemaRegistryClusterRecord, SchemaRegistryClusterRecord[], PageSettings>

update(string, string, OrganizationUpdateOptionalParams)

Aggiornare la risorsa organizzazione

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

Parametri

resourceGroupName

string

Nome gruppo di risorse

organizationName

string

Nome risorsa organizzazione

options

OrganizationUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<OrganizationResource>