Organization interface

Paket:

@azure/arm-confluent

Schnittstelle, die eine Organisation darstellt.

Methoden

beginCreate(string, string, OrganizationCreateOptionalParams)	Erstellen einer Organisationsressource
beginCreateAndWait(string, string, OrganizationCreateOptionalParams)	Erstellen einer Organisationsressource
beginDelete(string, string, OrganizationDeleteOptionalParams)	Löschen der Organisationsressource
beginDeleteAndWait(string, string, OrganizationDeleteOptionalParams)	Löschen der Organisationsressource
createAPIKey(string, string, string, string, CreateAPIKeyModel, OrganizationCreateAPIKeyOptionalParams)	Erstellt einen API-Schlüssel für eine Cluster-ID der Schemaregistrierung oder eine Kafka-Cluster-ID unter einer Umgebung.
deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)	Löscht den API-Schlüssel eines Kafka- oder Schemaregistrierungsclusters.
get(string, string, OrganizationGetOptionalParams)	Rufen Sie die Eigenschaften einer bestimmten Organisationsressource ab.
getClusterAPIKey(string, string, string, OrganizationGetClusterAPIKeyOptionalParams)	Abrufen von API-Schlüsseldetails eines Kafka- oder Schemaregistrierungsclusters
getClusterById(string, string, string, string, OrganizationGetClusterByIdOptionalParams)	Cluster nach ID abrufen
getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)	Abrufen von Umgebungsdetails nach Umgebungs-ID
getSchemaRegistryClusterById(string, string, string, string, OrganizationGetSchemaRegistryClusterByIdOptionalParams)	Abrufen des Schemaregistrierungsclusters nach ID
listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)	Listet alle Organisationen unter der angegebenen Ressourcengruppe auf.
listBySubscription(OrganizationListBySubscriptionOptionalParams)	Listet alle Organisationen unter dem angegebenen Abonnement auf.
listClusters(string, string, string, OrganizationListClustersOptionalParams)	Listen aller Cluster in einer Umgebung
listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)	Listen aller Umgebungen in einem organization
listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)	Verfügbare Cloudanbieterregionen zum Erstellen von Schemaregistrierungsclustern.
listSchemaRegistryClusters(string, string, string, OrganizationListSchemaRegistryClustersOptionalParams)	Abrufen von Schemaregistrierungsclustern
update(string, string, OrganizationUpdateOptionalParams)	Aktualisieren der Organisationsressource

Details zur Methode

beginCreate(string, string, OrganizationCreateOptionalParams)

Erstellen einer Organisationsressource

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

Parameter

resourceGroupName

string

Ressourcengruppenname

organizationName

string

Organisationsressourcenname

options

OrganizationCreateOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginCreateAndWait(string, string, OrganizationCreateOptionalParams)

Erstellen einer Organisationsressource

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

Parameter

resourceGroupName

string

Ressourcengruppenname

organizationName

string

Organisationsressourcenname

options

OrganizationCreateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<OrganizationResource>

beginDelete(string, string, OrganizationDeleteOptionalParams)

Löschen der Organisationsressource

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

Parameter

resourceGroupName

string

Ressourcengruppenname

organizationName

string

Organisationsressourcenname

options

OrganizationDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginDeleteAndWait(string, string, OrganizationDeleteOptionalParams)

Löschen der Organisationsressource

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

Parameter

resourceGroupName

string

Ressourcengruppenname

organizationName

string

Organisationsressourcenname

options

OrganizationDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

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

Erstellt einen API-Schlüssel für eine Cluster-ID der Schemaregistrierung oder eine Kafka-Cluster-ID unter einer Umgebung.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

organizationName

string

Organisationsressourcenname

environmentId

string

Confluent-Umgebungs-ID

clusterId

string

Confluent kafka- oder Schemaregistrierungscluster-ID

body

CreateAPIKeyModel

Anforderungsnutzlast zum Erstellen eines API-Schlüssels für die Schemaregistrierungscluster-ID oder Kafka-Cluster-ID unter einer Umgebung

options

OrganizationCreateAPIKeyOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<APIKeyRecord>

deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)

Löscht den API-Schlüssel eines Kafka- oder Schemaregistrierungsclusters.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

organizationName

string

Organisationsressourcenname

apiKeyId

string

Confluent-API-Schlüssel-ID

options

OrganizationDeleteClusterAPIKeyOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, string, OrganizationGetOptionalParams)

Rufen Sie die Eigenschaften einer bestimmten Organisationsressource ab.

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

Parameter

resourceGroupName

string

Ressourcengruppenname

organizationName

string

Organisationsressourcenname

options

OrganizationGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<OrganizationResource>

getClusterAPIKey(string, string, string, OrganizationGetClusterAPIKeyOptionalParams)

Abrufen von API-Schlüsseldetails eines Kafka- oder Schemaregistrierungsclusters

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

organizationName

string

Organisationsressourcenname

apiKeyId

string

Confluent-API-Schlüssel-ID

options

OrganizationGetClusterAPIKeyOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<APIKeyRecord>

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

Cluster nach ID abrufen

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

organizationName

string

Organisationsressourcenname

environmentId

string

Confluent-Umgebungs-ID

clusterId

string

Confluent kafka- oder Schemaregistrierungscluster-ID

options

OrganizationGetClusterByIdOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<SCClusterRecord>

getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)

Abrufen von Umgebungsdetails nach Umgebungs-ID

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

organizationName

string

Organisationsressourcenname

environmentId

string

Confluent-Umgebungs-ID

options

OrganizationGetEnvironmentByIdOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<SCEnvironmentRecord>

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

Abrufen des Schemaregistrierungsclusters nach ID

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

organizationName

string

Organisationsressourcenname

environmentId

string

Confluent-Umgebungs-ID

clusterId

string

Confluent kafka- oder Schemaregistrierungscluster-ID

options

OrganizationGetSchemaRegistryClusterByIdOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<SchemaRegistryClusterRecord>

listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)

Listet alle Organisationen unter der angegebenen Ressourcengruppe auf.

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

Parameter

resourceGroupName

string

Ressourcengruppenname

options

OrganizationListByResourceGroupOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

listBySubscription(OrganizationListBySubscriptionOptionalParams)

Listet alle Organisationen unter dem angegebenen Abonnement auf.

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

Parameter

options

OrganizationListBySubscriptionOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

listClusters(string, string, string, OrganizationListClustersOptionalParams)

Listen aller Cluster in einer Umgebung

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

organizationName

string

Name der Organisationsressource

environmentId

string

Confluent-Umgebungs-ID

options

OrganizationListClustersOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<SCClusterRecord, SCClusterRecord[], PageSettings>

listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)

Listen aller Umgebungen in einem organization

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

organizationName

string

Name der Organisationsressource

options

OrganizationListEnvironmentsOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<SCEnvironmentRecord, SCEnvironmentRecord[], PageSettings>

listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)

Verfügbare Cloudanbieterregionen zum Erstellen von Schemaregistrierungsclustern.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

organizationName

string

Name der Organisationsressource

body

ListAccessRequestModel

Listenzugriffsanforderungsmodell

options

OrganizationListRegionsOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ListRegionsSuccessResponse>

listSchemaRegistryClusters(string, string, string, OrganizationListSchemaRegistryClustersOptionalParams)

Abrufen von Schemaregistrierungsclustern

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

organizationName

string

Name der Organisationsressource

environmentId

string

Confluent-Umgebungs-ID

options

OrganizationListSchemaRegistryClustersOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<SchemaRegistryClusterRecord, SchemaRegistryClusterRecord[], PageSettings>

update(string, string, OrganizationUpdateOptionalParams)

Aktualisieren der Organisationsressource

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

Parameter

resourceGroupName

string

Ressourcengruppenname

organizationName

string

Name der Organisationsressource

options

OrganizationUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<OrganizationResource>