Connector - List

Referencia

Servicio:: Confluent

Versión de la API:: 2024-07-01

Enumera todos los conectores de un clúster

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters/{clusterId}/connectors?api-version=2024-07-01

Con parámetros opcionales:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters/{clusterId}/connectors?api-version=2024-07-01&pageSize={pageSize}&pageToken={pageToken}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
clusterId	path	True	string	Identificador de clúster del registro de esquema o kafka de Confluent
environmentId	path	True	string	Identificador de entorno de Confluent
organizationName	path	True	string	Nombre del recurso de la organización
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string	Identificador de suscripción de Microsoft Azure
api-version	query	True	string	Versión de api de cliente.
pageSize	query		integer (int32)	Tamaño de paginación
pageToken	query		string	Un token de paginación opaco para capturar el siguiente conjunto de registros

Respuestas

Nombre	Tipo	Description
200 OK	ListConnectorsSuccessResponse	Éxito
Other Status Codes	ResourceProviderDefaultErrorResponse	Respuesta de error predeterminada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Connector_List

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization/environments/env-12132/clusters/dlz-f3a90de/connectors?api-version=2024-07-01&pageSize=10

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "name": "connector-1",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization/environments/env-12132/clusters/dlz-f3a90de/connectors/connector-1",
      "properties": {
        "connectorBasicInfo": {
          "connectorType": "SINK",
          "connectorClass": "AZUREBLOBSINK",
          "connectorState": "RUNNING",
          "connectorId": "lcc-l",
          "connectorName": "connector-1"
        },
        "connectorServiceTypeInfo": {
          "connectorServiceType": "AzureBlobStorageSinkConnector",
          "storageAccountName": "stcfaccount-1",
          "storageAccountKey": "*******",
          "storageContainerName": "continer-1"
        },
        "partnerConnectorInfo": {
          "partnerConnectorType": "KafkaAzureBlobStorageSink",
          "flushSize": "1000",
          "maxTasks": "2",
          "timeInterval": "DAILY",
          "apiKey": "xxxxxxx",
          "apiSecret": "*******",
          "authType": "KAFKA_API_KEY",
          "inputFormat": "JSON",
          "outputFormat": "JSON",
          "topics": [
            "topic-1"
          ],
          "topicsDir": "topicsDir"
        }
      }
    }
  ],
  "nextLink": "nextLink?pageToken=xoi3753asdfe&pageSize=10"
}

Definiciones

Nombre	Description
authType	authType
AzureBlobStorageSinkConnectorServiceInfo	La información de autenticación cuando auth_type es azureBlobStorageSinkConnector
AzureBlobStorageSourceConnectorServiceInfo	El tipo de servicio del conector es AzureBlobStorageSourceConnector
AzureCosmosDBSinkConnectorServiceInfo	La información de autenticación cuando auth_type es AzureCosmosDBSinkConnector
AzureCosmosDBSourceConnectorServiceInfo	La información de autenticación cuando auth_type es AzureCosmosDBSourceConnector
AzureSynapseAnalyticsSinkConnectorServiceInfo	La información de autenticación cuando auth_type es AzureSynapseAnalyticsSinkConnector
ConnectorClass	ConnectorClass
ConnectorInfoBase	Propiedades base de información del conector
ConnectorResource	Detalles del registro del conector
ConnectorServiceType	Tipo de servicio del conector.
ConnectorStatus	ConnectorStatus
ConnectorType	ConnectorType
createdByType	Tipo de identidad que creó el recurso.
DataFormatType	DataFormatType
ErrorResponseBody	ErrorResponseBody
KafkaAzureBlobStorageSinkConnectorInfo	El tipo de conector de asociado es KafkaAzureBlobStorageSink
KafkaAzureBlobStorageSourceConnectorInfo	El tipo de conector asociado es KafkaAzureBlobStorageSource
KafkaAzureCosmosDBSinkConnectorInfo	El tipo de conector asociado es KafkaAzureCosmosDBSink
KafkaAzureCosmosDBSourceConnectorInfo	El tipo de conector de asociado es KafkaAzureCosmosDBSource
KafkaAzureSynapseAnalyticsSinkConnectorInfo	El tipo de conector asociado es KafkaAzureSynapseAnalyticsSink
ListConnectorsSuccessResponse	Resultado de la solicitud GET para enumerar conectores en el clúster de una organización confluent
PartnerConnectorType	Tipo de conector de asociado.
ResourceProviderDefaultErrorResponse	ResourceProviderDefaultErrorResponse
systemData	Metadatos relativos a la creación y última modificación del recurso.

authType

Enumeración

authType

Valor	Description
KAFKA_API_KEY
SERVICE_ACCOUNT

AzureBlobStorageSinkConnectorServiceInfo

Object

La información de autenticación cuando auth_type es azureBlobStorageSinkConnector

Nombre	Tipo	Description
connectorServiceType	string: AzureBlobStorageSinkConnector	Tipo de servicio del conector.
storageAccountKey	string	Clave de cuenta de Azure Blob Storage
storageAccountName	string	Nombre de la cuenta de Azure Blob Storage
storageContainerName	string	Nombre del contenedor de la cuenta de Azure Blob Storage

AzureBlobStorageSourceConnectorServiceInfo

Object

El tipo de servicio del conector es AzureBlobStorageSourceConnector

Nombre	Tipo	Description
connectorServiceType	string: AzureBlobStorageSourceConnector	Tipo de servicio del conector.
storageAccountKey	string	Clave de cuenta de Azure Blob Storage
storageAccountName	string	Nombre de la cuenta de Azure Blob Storage
storageContainerName	string	Nombre del contenedor de la cuenta de Azure Blob Storage

AzureCosmosDBSinkConnectorServiceInfo

Object

La información de autenticación cuando auth_type es AzureCosmosDBSinkConnector

Nombre	Tipo	Description
connectorServiceType	string: AzureCosmosDBSinkConnector	Tipo de servicio del conector.
cosmosConnectionEndpoint	string	Punto de conexión de Azure Cosmos Database
cosmosContainersTopicMapping	string	Asignación de temas de contenedores de Azure Cosmos Database
cosmosDatabaseName	string	Nombre de la base de datos de Azure Cosmos
cosmosIdStrategy	string	Estrategia de identificador de base de datos de Azure Cosmos
cosmosMasterKey	string	Clave maestra de Azure Cosmos Database

AzureCosmosDBSourceConnectorServiceInfo

Object

La información de autenticación cuando auth_type es AzureCosmosDBSourceConnector

Nombre	Tipo	Description
connectorServiceType	string: AzureCosmosDBSourceConnector	Tipo de servicio del conector.
cosmosConnectionEndpoint	string	Punto de conexión de Azure Cosmos Database
cosmosContainersTopicMapping	string	Asignación de temas de contenedores de Azure Cosmos Database
cosmosDatabaseName	string	Nombre de la base de datos de Azure Cosmos
cosmosMasterKey	string	Clave maestra de Azure Cosmos Database
cosmosMessageKeyEnabled	boolean	Clave de mensaje de Azure Cosmos Database habilitada
cosmosMessageKeyField	string	Campo clave de mensaje de Azure Cosmos Database

AzureSynapseAnalyticsSinkConnectorServiceInfo

Object

La información de autenticación cuando auth_type es AzureSynapseAnalyticsSinkConnector

Nombre	Tipo	Description
connectorServiceType	string: AzureSynapseAnalyticsSinkConnector	Tipo de servicio del conector.
synapseSqlDatabaseName	string	Nombre de la base de datos del grupo de SQL dedicado de Azure Synapse
synapseSqlPassword	string	Detalles de inicio de sesión de SQL de Azure Synapse
synapseSqlServerName	string	Nombre de SQL Server de Azure Synapse Analytics
synapseSqlUser	string	Detalles de inicio de sesión de SQL de Azure Synapse

ConnectorClass

Enumeración

ConnectorClass

Valor	Description
AZUREBLOBSINK
AZUREBLOBSOURCE

ConnectorInfoBase

Object

Propiedades base de información del conector

Nombre	Tipo	Description
connectorClass	ConnectorClass	ConnectorClass Clase Connector
connectorId	string	Identificador del conector
connectorName	string	Nombre del conector
connectorState	ConnectorStatus	ConnectorStatus Estado del conector
connectorType	ConnectorType	ConnectorType Tipo de conector

ConnectorResource

Object

Detalles del registro del conector

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nombre para mostrar del conector
properties.connectorBasicInfo	ConnectorInfoBase	Base de información del conector
properties.connectorServiceTypeInfo	ConnectorServiceTypeInfoBase: AzureBlobStorageSinkConnectorServiceInfo AzureBlobStorageSourceConnectorServiceInfo AzureCosmosDBSinkConnectorServiceInfo AzureCosmosDBSourceConnectorServiceInfo AzureSynapseAnalyticsSinkConnectorServiceInfo	Propiedades base del tipo de servicio del conector.
properties.partnerConnectorInfo	PartnerInfoBase: KafkaAzureBlobStorageSinkConnectorInfo KafkaAzureBlobStorageSourceConnectorInfo KafkaAzureCosmosDBSinkConnectorInfo KafkaAzureCosmosDBSourceConnectorInfo KafkaAzureSynapseAnalyticsSinkConnectorInfo	La información de conexión consumida por las aplicaciones.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ConnectorServiceType

Enumeración

Tipo de servicio del conector.

Valor	Description
AzureBlobStorageSinkConnector
AzureBlobStorageSourceConnector
AzureCosmosDBSinkConnector
AzureCosmosDBSourceConnector
AzureSynapseAnalyticsSinkConnector

ConnectorStatus

Enumeración

ConnectorStatus

Valor	Description
FAILED
PAUSED
PROVISIONING
RUNNING

ConnectorType

Enumeración

ConnectorType

Valor	Description
SINK
SOURCE

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

DataFormatType

Enumeración

DataFormatType

Valor	Description
AVRO
BYTES
JSON
PROTOBUF
STRING

ErrorResponseBody

Object

ErrorResponseBody

Nombre	Tipo	Description
code	string	Código de error
details	ErrorResponseBody[]	Detalles del error
message	string	Mensaje de error
target	string	Destino de error

KafkaAzureBlobStorageSinkConnectorInfo

Object

El tipo de conector de asociado es KafkaAzureBlobStorageSink

Nombre	Tipo	Description
apiKey	string	Clave de API de Kafka
apiSecret	string	Secreto de clave de API de Kafka
authType	authType	authType Tipo de autenticación de Kafka
flushSize	string	Tamaño de vaciado
inputFormat	DataFormatType	DataFormatType Tipo de formato de datos de entrada de Kafka
maxTasks	string	Tareas máximas
outputFormat	DataFormatType	DataFormatType Tipo de formato de datos de salida de Kafka
partnerConnectorType	string: KafkaAzureBlobStorageSink	Tipo de conector de asociado.
serviceAccountId	string	Identificador de cuenta de servicio de Kafka
timeInterval	string	Intervalo de tiempo
topics	string[]	Lista de temas de Kafka
topicsDir	string	Directorio de temas de Kafka

KafkaAzureBlobStorageSourceConnectorInfo

Object

El tipo de conector asociado es KafkaAzureBlobStorageSource

Nombre	Tipo	Description
apiKey	string	Clave de API de Kafka
apiSecret	string	Secreto de la API de Kafka
authType	authType	authType Tipo de autenticación de Kafka
inputFormat	DataFormatType	DataFormatType Tipo de formato de datos de entrada de Kafka
maxTasks	string	Tareas máximas
outputFormat	DataFormatType	DataFormatType Tipo de formato de datos de salida de Kafka
partnerConnectorType	string: KafkaAzureBlobStorageSource	Tipo de conector de asociado.
serviceAccountId	string	Identificador de cuenta de servicio de Kafka
topicRegex	string	Patrón regex de temas de Kafka
topicsDir	string	Directorio de temas de Kafka

KafkaAzureCosmosDBSinkConnectorInfo

Object

El tipo de conector asociado es KafkaAzureCosmosDBSink

Nombre	Tipo	Description
apiKey	string	Clave de API de Kafka
apiSecret	string	Secreto de clave de API de Kafka
authType	authType	authType Tipo de autenticación de Kafka
flushSize	string	Tamaño de vaciado
inputFormat	DataFormatType	DataFormatType Tipo de formato de datos de entrada de Kafka
maxTasks	string	Tareas máximas
outputFormat	DataFormatType	DataFormatType Tipo de formato de datos de salida de Kafka
partnerConnectorType	string: KafkaAzureCosmosDBSink	Tipo de conector de asociado.
serviceAccountId	string	Identificador de cuenta de servicio de Kafka
timeInterval	string	Intervalo de tiempo
topics	string[]	Lista de temas de Kafka
topicsDir	string	Directorio de temas de Kafka

KafkaAzureCosmosDBSourceConnectorInfo

Object

El tipo de conector de asociado es KafkaAzureCosmosDBSource

Nombre	Tipo	Description
apiKey	string	Clave de API de Kafka
apiSecret	string	Secreto de la API de Kafka
authType	authType	authType Tipo de autenticación de Kafka
inputFormat	DataFormatType	DataFormatType Tipo de formato de datos de entrada de Kafka
maxTasks	string	Tareas máximas
outputFormat	DataFormatType	DataFormatType Tipo de formato de datos de salida de Kafka
partnerConnectorType	string: KafkaAzureCosmosDBSource	Tipo de conector de asociado.
serviceAccountId	string	Identificador de cuenta de servicio de Kafka
topicRegex	string	Patrón regex de temas de Kafka
topicsDir	string	Directorio de temas de Kafka

KafkaAzureSynapseAnalyticsSinkConnectorInfo

Object

El tipo de conector asociado es KafkaAzureSynapseAnalyticsSink

Nombre	Tipo	Description
apiKey	string	Clave de API de Kafka
apiSecret	string	Secreto de clave de API de Kafka
authType	authType	authType Tipo de autenticación de Kafka
flushSize	string	Tamaño de vaciado
inputFormat	DataFormatType	DataFormatType Tipo de formato de datos de entrada de Kafka
maxTasks	string	Tareas máximas
outputFormat	DataFormatType	DataFormatType Tipo de formato de datos de salida de Kafka
partnerConnectorType	string: KafkaAzureSynapseAnalyticsSink	Tipo de conector de asociado.
serviceAccountId	string	Identificador de cuenta de servicio de Kafka
timeInterval	string	Intervalo de tiempo
topics	string[]	Lista de temas de Kafka
topicsDir	string	Directorio de temas de Kafka

ListConnectorsSuccessResponse

Object

Resultado de la solicitud GET para enumerar conectores en el clúster de una organización confluent

Nombre	Tipo	Description
nextLink	string	Dirección URL para obtener el siguiente conjunto de registros de conectores si hay alguno.
value	ConnectorResource[]	Lista de conectores de un clúster de una organización confluente

PartnerConnectorType

Enumeración

Tipo de conector de asociado.

Valor	Description
KafkaAzureBlobStorageSink
KafkaAzureBlobStorageSource
KafkaAzureCosmosDBSink
KafkaAzureCosmosDBSource
KafkaAzureSynapseAnalyticsSink

ResourceProviderDefaultErrorResponse

Object

ResourceProviderDefaultErrorResponse

Nombre	Tipo	Description
error	ErrorResponseBody	ErrorResponseBody Cuerpo de respuesta del error

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Compartir a través de

Connector - List

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Connector_List

Solicitud de ejemplo

Respuesta de muestra

Definiciones

authType

AzureBlobStorageSinkConnectorServiceInfo

AzureBlobStorageSourceConnectorServiceInfo

AzureCosmosDBSinkConnectorServiceInfo

AzureCosmosDBSourceConnectorServiceInfo

AzureSynapseAnalyticsSinkConnectorServiceInfo

ConnectorClass

ConnectorInfoBase

ConnectorResource

ConnectorServiceType

ConnectorStatus

ConnectorType

createdByType

DataFormatType

ErrorResponseBody

KafkaAzureBlobStorageSinkConnectorInfo

KafkaAzureBlobStorageSourceConnectorInfo

KafkaAzureCosmosDBSinkConnectorInfo

KafkaAzureCosmosDBSourceConnectorInfo

KafkaAzureSynapseAnalyticsSinkConnectorInfo

ListConnectorsSuccessResponse

PartnerConnectorType

ResourceProviderDefaultErrorResponse

systemData