Organization interface

Paquet:

@azure/arm-confluent

Interface représentant une organisation.

Méthodes

beginCreate(string, string, OrganizationCreateOptionalParams)	Créer une ressource d’organisation
beginCreateAndWait(string, string, OrganizationCreateOptionalParams)	Créer une ressource d’organisation
beginDelete(string, string, OrganizationDeleteOptionalParams)	Supprimer la ressource d’organisation
beginDeleteAndWait(string, string, OrganizationDeleteOptionalParams)	Supprimer la ressource d’organisation
createAPIKey(string, string, string, string, CreateAPIKeyModel, OrganizationCreateAPIKeyOptionalParams)	Crée une clé API pour un ID de cluster de registre de schémas ou un ID de cluster Kafka dans un environnement
deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)	Supprime la clé API d’un cluster kafka ou de registre de schémas
get(string, string, OrganizationGetOptionalParams)	Obtenez les propriétés d’une ressource Organisation spécifique.
getClusterAPIKey(string, string, string, OrganizationGetClusterAPIKeyOptionalParams)	Obtenir les détails de la clé API d’un cluster kafka ou de registre de schémas
getClusterById(string, string, string, string, OrganizationGetClusterByIdOptionalParams)	Obtenir un cluster par ID
getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)	Obtenir les détails de l’environnement par ID d’environnement
getSchemaRegistryClusterById(string, string, string, string, OrganizationGetSchemaRegistryClusterByIdOptionalParams)	Obtenir un cluster de registre de schémas par ID
listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)	Répertorier toutes les organisations sous le groupe de ressources spécifié.
listBySubscription(OrganizationListBySubscriptionOptionalParams)	Répertorier toutes les organisations sous l’abonnement spécifié.
listClusters(string, string, string, OrganizationListClustersOptionalParams)	Listes de tous les clusters dans un environnement
listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)	Listes de tous les environnements d’une organisation
listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)	régions de fournisseur cloud disponibles pour la création de clusters de Registre de schémas.
listSchemaRegistryClusters(string, string, string, OrganizationListSchemaRegistryClustersOptionalParams)	Obtenir des clusters de registre de schémas
update(string, string, OrganizationUpdateOptionalParams)	Mettre à jour la ressource Organisation

Détails de la méthode

beginCreate(string, string, OrganizationCreateOptionalParams)

Créer une ressource d’organisation

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources

organizationName

string

Nom de la ressource de l’organisation

options

OrganizationCreateOptionalParams

Paramètres d’options.

Retours

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

beginCreateAndWait(string, string, OrganizationCreateOptionalParams)

Créer une ressource d’organisation

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources

organizationName

string

Nom de la ressource de l’organisation

options

OrganizationCreateOptionalParams

Paramètres d’options.

Retours

Promise<OrganizationResource>

beginDelete(string, string, OrganizationDeleteOptionalParams)

Supprimer la ressource d’organisation

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources

organizationName

string

Nom de la ressource de l’organisation

options

OrganizationDeleteOptionalParams

Paramètres d’options.

Retours

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

beginDeleteAndWait(string, string, OrganizationDeleteOptionalParams)

Supprimer la ressource d’organisation

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources

organizationName

string

Nom de la ressource de l’organisation

options

OrganizationDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

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

Crée une clé API pour un ID de cluster de registre de schémas ou un ID de cluster Kafka dans un environnement

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

organizationName

string

Nom de la ressource de l’organisation

environmentId

string

ID d’environnement Confluent

clusterId

string

ID de cluster de Registre de schémas ou Kafka Confluent

body

CreateAPIKeyModel

Demande de charge utile pour obtenir la création de clé API pour l’ID de cluster du registre de schémas ou l’ID de cluster Kafka dans un environnement

options

OrganizationCreateAPIKeyOptionalParams

Paramètres d’options.

Retours

Promise<APIKeyRecord>

deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)

Supprime la clé API d’un cluster kafka ou de registre de schémas

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

organizationName

string

Nom de la ressource de l’organisation

apiKeyId

string

ID de clé API Confluent

options

OrganizationDeleteClusterAPIKeyOptionalParams

Paramètres d’options.

Retours

Promise<void>

get(string, string, OrganizationGetOptionalParams)

Obtenez les propriétés d’une ressource Organisation spécifique.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources

organizationName

string

Nom de la ressource de l’organisation

options

OrganizationGetOptionalParams

Paramètres d’options.

Retours

Promise<OrganizationResource>

getClusterAPIKey(string, string, string, OrganizationGetClusterAPIKeyOptionalParams)

Obtenir les détails de la clé API d’un cluster kafka ou de registre de schémas

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

organizationName

string

Nom de la ressource de l’organisation

apiKeyId

string

ID de clé API Confluent

options

OrganizationGetClusterAPIKeyOptionalParams

Paramètres d’options.

Retours

Promise<APIKeyRecord>

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

Obtenir un cluster par ID

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

organizationName

string

Nom de la ressource de l’organisation

environmentId

string

ID d’environnement Confluent

clusterId

string

ID de cluster de Registre de schémas ou Kafka Confluent

options

OrganizationGetClusterByIdOptionalParams

Paramètres d’options.

Retours

Promise<SCClusterRecord>

getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)

Obtenir les détails de l’environnement par ID d’environnement

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

organizationName

string

Nom de la ressource de l’organisation

environmentId

string

ID d’environnement Confluent

options

OrganizationGetEnvironmentByIdOptionalParams

Paramètres d’options.

Retours

Promise<SCEnvironmentRecord>

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

Obtenir un cluster de registre de schémas par ID

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

organizationName

string

Nom de la ressource de l’organisation

environmentId

string

ID d’environnement Confluent

clusterId

string

ID de cluster de Registre de schémas ou Kafka Confluent

options

OrganizationGetSchemaRegistryClusterByIdOptionalParams

Paramètres d’options.

Retours

Promise<SchemaRegistryClusterRecord>

listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)

Répertorier toutes les organisations sous le groupe de ressources spécifié.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources

options

OrganizationListByResourceGroupOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

listBySubscription(OrganizationListBySubscriptionOptionalParams)

Répertorier toutes les organisations sous l’abonnement spécifié.

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

Paramètres

options

OrganizationListBySubscriptionOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

listClusters(string, string, string, OrganizationListClustersOptionalParams)

Listes de tous les clusters dans un environnement

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

organizationName

string

Nom de la ressource de l’organisation

environmentId

string

ID d’environnement Confluent

options

OrganizationListClustersOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<SCClusterRecord, SCClusterRecord[], PageSettings>

listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)

Listes de tous les environnements d’une organisation

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

organizationName

string

Nom de la ressource de l’organisation

options

OrganizationListEnvironmentsOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<SCEnvironmentRecord, SCEnvironmentRecord[], PageSettings>

listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)

régions de fournisseur cloud disponibles pour la création de clusters de Registre de schémas.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

organizationName

string

Nom de la ressource de l’organisation

body

ListAccessRequestModel

Modèle de demande d’accès de liste

options

OrganizationListRegionsOptionalParams

Paramètres d’options.

Retours

Promise<ListRegionsSuccessResponse>

listSchemaRegistryClusters(string, string, string, OrganizationListSchemaRegistryClustersOptionalParams)

Obtenir des clusters de registre de schémas

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

organizationName

string

Nom de la ressource de l’organisation

environmentId

string

ID d’environnement Confluent

options

OrganizationListSchemaRegistryClustersOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<SchemaRegistryClusterRecord, SchemaRegistryClusterRecord[], PageSettings>

update(string, string, OrganizationUpdateOptionalParams)

Mettre à jour la ressource Organisation

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources

organizationName

string

Nom de la ressource de l’organisation

options

OrganizationUpdateOptionalParams

Paramètres d’options.

Retours

Promise<OrganizationResource>