Organization interface

Paquete:

@azure/arm-confluent

Interfaz que representa una organización.

Métodos

beginCreate(string, string, OrganizationCreateOptionalParams)	Creación de un recurso de organización
beginCreateAndWait(string, string, OrganizationCreateOptionalParams)	Creación de un recurso de organización
beginDelete(string, string, OrganizationDeleteOptionalParams)	Eliminar recurso de organización
beginDeleteAndWait(string, string, OrganizationDeleteOptionalParams)	Eliminar recurso de organización
createAPIKey(string, string, string, string, CreateAPIKeyModel, OrganizationCreateAPIKeyOptionalParams)	Crea una clave de API para un identificador de clúster del registro de esquema o un identificador de clúster de Kafka en un entorno.
deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)	Elimina la clave de API de un clúster de registro de esquema o kafka.
get(string, string, OrganizationGetOptionalParams)	Obtenga las propiedades de un recurso de organización específico.
getClusterAPIKey(string, string, string, OrganizationGetClusterAPIKeyOptionalParams)	Obtención de detalles clave de API de un clúster de registro de esquema o kafka
getClusterById(string, string, string, string, OrganizationGetClusterByIdOptionalParams)	Obtención del clúster por identificador
getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)	Obtención de detalles del entorno por identificador de entorno
getSchemaRegistryClusterById(string, string, string, string, OrganizationGetSchemaRegistryClusterByIdOptionalParams)	Obtención del clúster del registro de esquema por identificador
listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)	Enumere todas las organizaciones del grupo de recursos especificado.
listBySubscription(OrganizationListBySubscriptionOptionalParams)	Enumere todas las organizaciones en la suscripción especificada.
listClusters(string, string, string, OrganizationListClustersOptionalParams)	Listas de todos los clústeres de un entorno
listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)	Listas de todos los entornos de una organización
listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)	regiones del proveedor de nube disponibles para crear clústeres del Registro de esquemas.
listSchemaRegistryClusters(string, string, string, OrganizationListSchemaRegistryClustersOptionalParams)	Obtención de clústeres del registro de esquema
update(string, string, OrganizationUpdateOptionalParams)	Actualizar recurso de organización

Detalles del método

beginCreate(string, string, OrganizationCreateOptionalParams)

Creación de un recurso de organización

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

Parámetros

resourceGroupName

string

Definición de un nombre de grupo de recursos

organizationName

string

Nombre del recurso de la organización

options

OrganizationCreateOptionalParams

Parámetros de opciones.

Devoluciones

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

beginCreateAndWait(string, string, OrganizationCreateOptionalParams)

Creación de un recurso de organización

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

Parámetros

resourceGroupName

string

Definición de un nombre de grupo de recursos

organizationName

string

Nombre del recurso de la organización

options

OrganizationCreateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<OrganizationResource>

beginDelete(string, string, OrganizationDeleteOptionalParams)

Eliminar recurso de organización

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

Parámetros

resourceGroupName

string

Definición de un nombre de grupo de recursos

organizationName

string

Nombre del recurso de la organización

options

OrganizationDeleteOptionalParams

Parámetros de opciones.

Devoluciones

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

beginDeleteAndWait(string, string, OrganizationDeleteOptionalParams)

Eliminar recurso de organización

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

Parámetros

resourceGroupName

string

Definición de un nombre de grupo de recursos

organizationName

string

Nombre del recurso de la organización

options

OrganizationDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

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

Crea una clave de API para un identificador de clúster del registro de esquema o un identificador de clúster de Kafka en un entorno.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

organizationName

string

Nombre del recurso de la organización

environmentId

string

Identificador del entorno de Confluent

clusterId

string

Identificador de clúster del registro de esquema o kafka de Confluent

body

CreateAPIKeyModel

Solicitud de carga para crear una clave de API para el identificador de clúster del registro de esquema o el identificador de clúster de Kafka en un entorno

options

OrganizationCreateAPIKeyOptionalParams

Parámetros de opciones.

Devoluciones

Promise<APIKeyRecord>

deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)

Elimina la clave de API de un clúster de registro de esquema o kafka.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

organizationName

string

Nombre del recurso de la organización

apiKeyId

string

Identificador de clave de API de Confluent

options

OrganizationDeleteClusterAPIKeyOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

get(string, string, OrganizationGetOptionalParams)

Obtenga las propiedades de un recurso de organización específico.

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

Parámetros

resourceGroupName

string

Definición de un nombre de grupo de recursos

organizationName

string

Nombre del recurso de la organización

options

OrganizationGetOptionalParams

Parámetros de opciones.

Devoluciones

Promise<OrganizationResource>

getClusterAPIKey(string, string, string, OrganizationGetClusterAPIKeyOptionalParams)

Obtención de detalles clave de API de un clúster de registro de esquema o kafka

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

organizationName

string

Nombre del recurso de la organización

apiKeyId

string

Identificador de clave de API de Confluent

options

OrganizationGetClusterAPIKeyOptionalParams

Parámetros de opciones.

Devoluciones

Promise<APIKeyRecord>

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

Obtención del clúster por identificador

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

organizationName

string

Nombre del recurso de la organización

environmentId

string

Identificador del entorno de Confluent

clusterId

string

Identificador de clúster del registro de esquema o kafka de Confluent

options

OrganizationGetClusterByIdOptionalParams

Parámetros de opciones.

Devoluciones

Promise<SCClusterRecord>

getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)

Obtención de detalles del entorno por identificador de entorno

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

organizationName

string

Nombre del recurso de la organización

environmentId

string

Identificador del entorno de Confluent

options

OrganizationGetEnvironmentByIdOptionalParams

Parámetros de opciones.

Devoluciones

Promise<SCEnvironmentRecord>

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

Obtención del clúster del registro de esquema por identificador

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

organizationName

string

Nombre del recurso de la organización

environmentId

string

Identificador del entorno de Confluent

clusterId

string

Identificador de clúster del registro de esquema o kafka de Confluent

options

OrganizationGetSchemaRegistryClusterByIdOptionalParams

Parámetros de opciones.

Devoluciones

Promise<SchemaRegistryClusterRecord>

listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)

Enumere todas las organizaciones del grupo de recursos especificado.

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

Parámetros

resourceGroupName

string

Definición de un nombre de grupo de recursos

options

OrganizationListByResourceGroupOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

listBySubscription(OrganizationListBySubscriptionOptionalParams)

Enumere todas las organizaciones en la suscripción especificada.

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

Parámetros

options

OrganizationListBySubscriptionOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

listClusters(string, string, string, OrganizationListClustersOptionalParams)

Listas de todos los clústeres de un entorno

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

organizationName

string

Nombre del recurso de la organización

environmentId

string

Identificador de entorno de Confluent

options

OrganizationListClustersOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<SCClusterRecord, SCClusterRecord[], PageSettings>

listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)

Listas de todos los entornos de una organización

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

organizationName

string

Nombre del recurso de la organización

options

OrganizationListEnvironmentsOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<SCEnvironmentRecord, SCEnvironmentRecord[], PageSettings>

listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)

regiones del proveedor de nube disponibles para crear clústeres del Registro de esquemas.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

organizationName

string

Nombre del recurso de la organización

body

ListAccessRequestModel

Modelo de solicitud de acceso de lista

options

OrganizationListRegionsOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ListRegionsSuccessResponse>

listSchemaRegistryClusters(string, string, string, OrganizationListSchemaRegistryClustersOptionalParams)

Obtención de clústeres del registro de esquema

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

organizationName

string

Nombre del recurso de la organización

environmentId

string

Identificador de entorno de Confluent

options

OrganizationListSchemaRegistryClustersOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<SchemaRegistryClusterRecord, SchemaRegistryClusterRecord[], PageSettings>

update(string, string, OrganizationUpdateOptionalParams)

Actualizar recurso de organización

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

Parámetros

resourceGroupName

string

Definición de un nombre de grupo de recursos

organizationName

string

Nombre del recurso de la organización

options

OrganizationUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<OrganizationResource>