Package-level declarations

Types

Link copied to clipboard

BasicRules of AuthorizationConfig Polar rules are not supported

Link copied to clipboard
data class AuthorizationConfigResponse(val enableCache: Boolean? = null, val rules: List<AuthorizationBasicRuleResponse>? = null)

Broker AuthorizationConfig properties

Link copied to clipboard
data class AutomaticCertMethodResponse(val duration: String? = null, val issuerRef: CertManagerIssuerRefResponse, val privateKey: CertManagerPrivateKeyResponse? = null, val renewBefore: String? = null, val san: SanForCertResponse? = null, val secretName: String? = null, val secretNamespace: String? = null)

Automatic TLS server certificate management with cert-manager

Link copied to clipboard
data class BackendChainResponse(val partitions: Int, val redundancyFactor: Int, val temporaryDiskTransferEnabled: Boolean? = null, val temporaryDiskTransferHighWatermarkPercent: Int? = null, val temporaryDiskTransferLowWatermarkPercent: Int? = null, val temporaryMaxBackendMemUsagePercent: Int? = null, val temporaryResourceLimits: TemporaryResourceLimitsConfigResponse? = null, val workers: Int? = null)

Desired properties of the Frontend Instances of the DMQTT Broker

Link copied to clipboard

Custom Authentication properties

data class BrokerAuthenticatorCustomAuthX509Response(val keyVault: KeyVaultCertificatePropertiesResponse? = null, val secretName: String? = null)

X509 Custom Authentication properties. NOTE - Enum only authenticator type supported at a time.

Link copied to clipboard
data class BrokerAuthenticatorMethodCustomResponse(val auth: BrokerAuthenticatorCustomAuthResponse? = null, val caCertConfigMap: String? = null, val endpoint: String, val headers: Map<String, String>? = null)

Custom method for BrokerAuthentication

Link copied to clipboard

Service Account Token for BrokerAuthentication

Link copied to clipboard

Collection of different CrdAuthenticator methods of Broker Resource. NOTE Enum - Only one method is supported for each entry.

Link copied to clipboard
data class BrokerAuthenticatorMethodSvidResponse(val agentSocketPath: String, val identityMaxRetry: Double? = null, val identityWaitRetryMs: Double? = null)

SVID for BrokerAuthentication

data class BrokerAuthenticatorMethodUsernamePasswordResponse(val keyVault: KeyVaultSecretPropertiesResponse? = null, val secretName: String? = null)

UsernamePassword for BrokerAuthentication

data class BrokerAuthenticatorMethodX509AttributesResponse(val keyVault: KeyVaultSecretPropertiesResponse? = null, val secretName: String? = null)

BrokerAuthenticatorMethodX509Attributes properties. NOTE - Enum only type supported at a time.

Link copied to clipboard
data class BrokerAuthenticatorMethodX509Response(val attributes: BrokerAuthenticatorMethodX509AttributesResponse? = null, val trustedClientCaCertConfigMap: String? = null)

X509 for BrokerAuthentication.

Link copied to clipboard
data class BrokerDiagnosticsResponse(val diagnosticServiceEndpoint: String? = null, val enableMetrics: Boolean? = null, val enableSelfCheck: Boolean? = null, val enableSelfTracing: Boolean? = null, val enableTracing: Boolean? = null, val logFormat: String? = null, val logLevel: String? = null, val maxCellMapLifetime: Double? = null, val metricUpdateFrequencySeconds: Double? = null, val probeImage: String? = null, val selfCheckFrequencySeconds: Double? = null, val selfCheckTimeoutSeconds: Double? = null, val selfTraceFrequencySeconds: Double? = null, val spanChannelCapacity: Double? = null)

Diagnostics setting specific to Broker

Link copied to clipboard
data class CardinalityResponse(val backendChain: BackendChainResponse, val frontend: FrontendResponse)

Cardinality properties

Link copied to clipboard
data class CertManagerCertOptionsResponse(val duration: String, val privateKey: CertManagerPrivateKeyResponse, val renewBefore: String)

Cert Manager CA Cert properties

Link copied to clipboard
data class CertManagerIssuerRefResponse(val group: String, val kind: String, val name: String)

Cert-Manager issuerRef properties

Link copied to clipboard
data class CertManagerPrivateKeyResponse(val algorithm: String, val rotationPolicy: String, val size: Int)

Cert Manager private key properties

Link copied to clipboard
data class ContainerImageResponse(val pullPolicy: String? = null, val pullSecrets: String? = null, val repository: String, val tag: String)

Defines the Docker image details

Link copied to clipboard
data class DataLakeConnectorMapResponse(val allowedLatencySecs: Int, val clientId: String, val maxMessagesPerBatch: Double, val messagePayloadType: String, val mqttSourceTopic: String, val qos: Int? = null, val table: DeltaTableResponse)

DataLake connector map route properties

DataLake Fabric Storage authentication details.

Link copied to clipboard
data class DataLakeFabricStorageResponse(val authentication: DataLakeFabricStorageAuthenticationResponse, val endpoint: String, val fabricPath: String, val guids: FabricGuidsResponse? = null, val names: FabricNamesResponse? = null)

DataLake Fabric Storage details.

Link copied to clipboard
data class DataLakeLocalStorageResponse(val volumeName: String)

DataLake Local Storage details.

data class DataLakeServiceStorageAuthenticationResponse(val accessTokenSecretName: String? = null, val systemAssignedManagedIdentity: ManagedIdentityAuthenticationResponse? = null)

DataLake Service Storage authentication details. NOTE - Enum only one method is supported.

Link copied to clipboard

DataLake Service Storage details.

Link copied to clipboard
data class DataLakeTargetStorageResponse(val datalakeStorage: DataLakeServiceStorageResponse? = null, val fabricOneLake: DataLakeFabricStorageResponse? = null, val localStorage: DataLakeLocalStorageResponse? = null)

Target storage for the DataLake. NOTE - Enum only storage is supported at a time.

Link copied to clipboard
data class DeltaTableResponse(val schema: List<DeltaTableSchemaResponse>, val tableName: String, val tablePath: String? = null)

Delta table properties

Link copied to clipboard
data class DeltaTableSchemaResponse(val format: String, val mapping: String, val name: String, val optional: Boolean)

Delta table schema properties

Link copied to clipboard
data class DiskBackedMessageBufferSettingsResponse(val ephemeralVolumeClaimSpec: VolumeClaimSpecResponse? = null, val maxSize: String, val persistentVolumeClaimSpec: VolumeClaimSpecResponse? = null)

DiskBackedMessageBufferSettings properties

Link copied to clipboard
data class ExtendedLocationPropertyResponse(val name: String, val type: String)

ExtendedLocation properties

Link copied to clipboard
data class FabricGuidsResponse(val lakehouseGuid: String, val workspaceGuid: String)

Fabric one lake guids.

Link copied to clipboard
data class FabricNamesResponse(val lakehouseName: String, val workspaceName: String)

Fabric one lake names.

Link copied to clipboard
data class FrontendResponse(val replicas: Int, val temporaryResourceLimits: TemporaryResourceLimitsConfigResponse? = null, val workers: Int? = null)

Desired properties of the Frontend Instances of the DMQTT Broker

Link copied to clipboard
data class GetBrokerAuthenticationResult(val authenticationMethods: List<BrokerAuthenticatorMethodsResponse>, val extendedLocation: ExtendedLocationPropertyResponse, val id: String, val listenerRef: List<String>, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

MQ broker/authentication resource

Link copied to clipboard
data class GetBrokerAuthorizationResult(val authorizationPolicies: AuthorizationConfigResponse, val extendedLocation: ExtendedLocationPropertyResponse, val id: String, val listenerRef: List<String>, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

MQ broker/authorization resource

Link copied to clipboard
data class GetBrokerListenerResult(val authenticationEnabled: Boolean? = null, val authorizationEnabled: Boolean? = null, val brokerRef: String, val extendedLocation: ExtendedLocationPropertyResponse, val id: String, val location: String, val name: String, val nodePort: Int? = null, val port: Int, val provisioningState: String, val serviceName: String? = null, val serviceType: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val tls: TlsCertMethodResponse? = null, val type: String)

MQ broker/listener resource

Link copied to clipboard
data class GetBrokerResult(val authImage: ContainerImageResponse, val brokerImage: ContainerImageResponse, val brokerNodeTolerations: NodeTolerationsResponse? = null, val cardinality: CardinalityResponse? = null, val diagnostics: BrokerDiagnosticsResponse? = null, val diskBackedMessageBufferSettings: DiskBackedMessageBufferSettingsResponse? = null, val encryptInternalTraffic: Boolean? = null, val extendedLocation: ExtendedLocationPropertyResponse, val healthManagerImage: ContainerImageResponse, val healthManagerNodeTolerations: NodeTolerationsResponse? = null, val id: String, val internalCerts: CertManagerCertOptionsResponse? = null, val location: String, val memoryProfile: String? = null, val mode: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

MQ broker resource

Link copied to clipboard
data class GetDataLakeConnectorResult(val databaseFormat: String, val extendedLocation: ExtendedLocationPropertyResponse, val id: String, val image: ContainerImageResponse, val instances: Int? = null, val localBrokerConnection: LocalBrokerConnectionSpecResponse? = null, val location: String, val logLevel: String? = null, val name: String, val nodeTolerations: NodeTolerationsResponse? = null, val protocol: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val target: DataLakeTargetStorageResponse, val type: String)

MQ dataLakeConnector resource

Link copied to clipboard
data class GetDataLakeConnectorTopicMapResult(val dataLakeConnectorRef: String, val extendedLocation: ExtendedLocationPropertyResponse, val id: String, val location: String, val mapping: DataLakeConnectorMapResponse, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

MQ dataLakeConnector/topicMap resource

Link copied to clipboard
data class GetDiagnosticServiceResult(val dataExportFrequencySeconds: Int? = null, val extendedLocation: ExtendedLocationPropertyResponse, val id: String, val image: ContainerImageResponse, val location: String, val logFormat: String? = null, val logLevel: String? = null, val maxDataStorageSize: Double? = null, val metricsPort: Int? = null, val name: String, val openTelemetryTracesCollectorAddr: String? = null, val provisioningState: String, val staleDataTimeoutSeconds: Int? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

MQ diagnostic services resource

Link copied to clipboard
data class GetKafkaConnectorResult(val clientIdPrefix: String? = null, val extendedLocation: ExtendedLocationPropertyResponse, val id: String, val image: ContainerImageResponse? = null, val instances: Int? = null, val kafkaConnection: KafkaRemoteBrokerConnectionSpecResponse, val localBrokerConnection: LocalBrokerConnectionSpecResponse? = null, val location: String, val logLevel: String? = null, val name: String, val nodeTolerations: NodeTolerationsResponse? = null, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

MQ kafkaConnector resource

Link copied to clipboard
data class GetKafkaConnectorTopicMapResult(val batching: KafkaTopicMapBatchingResponse? = null, val compression: String? = null, val copyMqttProperties: String? = null, val extendedLocation: ExtendedLocationPropertyResponse, val id: String, val kafkaConnectorRef: String, val location: String, val name: String, val partitionKeyProperty: String? = null, val partitionStrategy: String? = null, val provisioningState: String, val routes: List<KafkaRoutesResponse>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

MQ kafkaConnector/topicMap resource

Link copied to clipboard
data class GetMqResult(val extendedLocation: ExtendedLocationPropertyResponse, val id: String, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

MQ resource

Link copied to clipboard
data class GetMqttBridgeConnectorResult(val bridgeInstances: Int? = null, val clientIdPrefix: String? = null, val extendedLocation: ExtendedLocationPropertyResponse, val id: String, val image: ContainerImageResponse, val localBrokerConnection: LocalBrokerConnectionSpecResponse? = null, val location: String, val logLevel: String? = null, val name: String, val nodeTolerations: NodeTolerationsResponse? = null, val protocol: String, val provisioningState: String, val remoteBrokerConnection: MqttBridgeRemoteBrokerConnectionSpecResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

MQ mqttBridgeConnector resource

Link copied to clipboard
data class GetMqttBridgeTopicMapResult(val extendedLocation: ExtendedLocationPropertyResponse, val id: String, val location: String, val mqttBridgeConnectorRef: String, val name: String, val provisioningState: String, val routes: List<MqttBridgeRoutesResponse>? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

MQ mqttBridgeTopicMap resource

Kafka RemoteBrokerConnection Authentication methods

Kafka RemoteBrokerConnection Authentication types. NOTE - Enum only one method is allowed to be passed.

Link copied to clipboard

Kafka RemoteBrokerConnectionSpec details

Link copied to clipboard
data class KafkaRemoteBrokerConnectionTlsResponse(val tlsEnabled: Boolean, val trustedCaCertificateConfigMap: String? = null)

Kafka RemoteBrokerConnection TLS details

Link copied to clipboard
data class KafkaRoutesResponse(val kafkaToMqtt: KafkaToMqttRoutesResponse? = null, val mqttToKafka: MqttToKafkaRoutesResponse? = null)

Kafka Routes properties. NOTE - Enum only one method is allowed to be passed.

data class KafkaSharedSubscriptionPropertiesResponse(val groupMinimumShareNumber: Int, val groupName: String)

Kafka Shared Subscription properties

Link copied to clipboard

Kafka Token KeyVault properties.

Link copied to clipboard
data class KafkaToMqttRoutesResponse(val consumerGroupId: String? = null, val kafkaTopic: String, val mqttTopic: String, val name: String, val qos: Int? = null)

Kafka to Mqtt route properties

Link copied to clipboard
data class KafkaTopicMapBatchingResponse(val enabled: Boolean? = null, val latencyMs: Int? = null, val maxBytes: Double? = null, val maxMessages: Double? = null)

Kafka TopicMap Batching properties

Link copied to clipboard
data class KafkaX509AuthenticationResponse(val keyVault: KeyVaultCertificatePropertiesResponse? = null, val secretName: String? = null)

Kafka RemoteBrokerConnection X509 Authentication properties.

Link copied to clipboard

KeyVault certificate properties

Link copied to clipboard
data class KeyVaultConnectionPropertiesResponse(val credentials: KeyVaultCredentialsPropertiesResponse, val directoryId: String, val name: String)

KeyVault properties

Link copied to clipboard
data class KeyVaultCredentialsPropertiesResponse(val servicePrincipalLocalSecretName: String)

KeyVault credentials properties. NOTE - Future this will be ENUM.

Link copied to clipboard
data class KeyVaultSecretObjectResponse(val name: String, val version: String? = null)

KeyVault secret object properties

Link copied to clipboard

KeyVault secret properties

Link copied to clipboard

Mqtt Local Broker Authentication details. Only one method at a time is supported. Default - kubernetes authentication

Link copied to clipboard
data class LocalBrokerConnectionSpecResponse(val authentication: LocalBrokerAuthenticationMethodsResponse? = null, val endpoint: String? = null, val tls: LocalBrokerConnectionTlsResponse? = null)

Mqtt Local Broker ConnectionSpec details

Link copied to clipboard
data class LocalBrokerConnectionTlsResponse(val tlsEnabled: Boolean? = null, val trustedCaCertificateConfigMap: String? = null)

Mqtt Local Broker Connection TLS details

data class LocalBrokerKubernetesAuthenticationResponse(val secretPath: String? = null, val serviceAccountTokenName: String? = null)

Local Broker Kubernetes Authentication

Link copied to clipboard
data class ManagedIdentityAuthenticationResponse(val audience: String, val extensionName: String? = null)

Managed identity authentication details.

Link copied to clipboard
data class ManualCertMethodResponse(val secretName: String, val secretNamespace: String? = null)

Manual TLS server certificate management through a defined secret

MqttBridge RemoteBrokerConnection Authentication methods. NOTE - Enum only one is allowed to be passed.

MqttBridge RemoteBrokerConnectionSpec details

data class MqttBridgeRemoteBrokerConnectionTlsResponse(val tlsEnabled: Boolean, val trustedCaCertificateConfigMap: String? = null)

MqttBridge RemoteBrokerConnection TLS details

data class MqttBridgeRemoteBrokerX509AuthenticationResponse(val keyVault: KeyVaultCertificatePropertiesResponse? = null, val secretName: String? = null)

MqttBridge RemoteBroker X509 Authentication properties.

data class MqttBridgeRouteSharedSubscriptionResponse(val groupMinimumShareNumber: Int, val groupName: String)

MqttBridgeRoute Shared subscription properties

Link copied to clipboard
data class MqttBridgeRoutesResponse(val direction: String, val name: String, val qos: Int? = null, val sharedSubscription: MqttBridgeRouteSharedSubscriptionResponse? = null, val source: String, val target: String? = null)

MqttBridgeTopicMap route properties

Link copied to clipboard
data class MqttToKafkaRoutesResponse(val kafkaAcks: String, val kafkaTopic: String, val mqttTopic: String, val name: String, val qos: Int? = null, val sharedSubscription: KafkaSharedSubscriptionPropertiesResponse? = null)

Mqtt to Kafka route properties

Link copied to clipboard
data class NodeTolerationsResponse(val effect: String, val key: String, val operator: String, val value: String)

Defines the Node Tolerations details

Link copied to clipboard
data class PrincipalDefinitionResponse(val attributes: List<Map<String, String>>? = null, val clientids: List<String>? = null, val usernames: List<String>? = null)

PrincipalDefinition properties of Basic Rule

Link copied to clipboard
data class ResourceInfoDefinitionResponse(val method: String, val topics: List<String>? = null)

ResourceInfoDefinition properties of Basic Rule. This defines the objects that represent the actions or topics, such as - method.Connect, method.Publish, etc.

Link copied to clipboard
data class SanForCertResponse(val dns: List<String>, val ip: List<String>)

SANs for certificate.

Kafka RemoteBrokerConnection Sasl Authentication properties.

data class SaslRemoteBrokerBasicAuthenticationTokenResponse(val keyVault: KafkaTokenKeyVaultPropertiesResponse? = null, val secretName: String? = null)

Kafka RemoteBrokerConnection Sasl Authentication token properties. NOTE - Enum only one method is allowed to be passed.

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class TemporaryResourceLimitsConfigResponse(val maxInflightMessages: Int, val maxInflightPatches: Int, val maxInflightPatchesPerClient: Int, val maxMessageExpirySecs: Double? = null, val maxQueuedMessages: Double, val maxQueuedQos0Messages: Double, val maxSessionExpirySecs: Double)

Internal knobs of Resource Limits for FE and BE

Link copied to clipboard
data class TlsCertMethodResponse(val automatic: AutomaticCertMethodResponse? = null, val keyVault: KeyVaultCertificatePropertiesResponse? = null, val manual: ManualCertMethodResponse? = null)

Collection of different TLS types, NOTE- Enum at a time only one of them needs to be supported

Link copied to clipboard
data class VolumeClaimDataSourceRefResponse(val apiGroup: String? = null, val kind: String, val name: String)

VolumeClaimDataSourceRef properties

Link copied to clipboard
data class VolumeClaimDataSourceResponse(val apiGroup: String? = null, val kind: String, val name: String)

VolumeClaimDataSource properties

Link copied to clipboard
data class VolumeClaimResourceRequirementsResponse(val limits: Map<String, String>? = null, val requests: Map<String, String>? = null)

VolumeClaimResourceRequirements properties

Link copied to clipboard
data class VolumeClaimSpecResponse(val accessModes: List<String>? = null, val dataSource: VolumeClaimDataSourceResponse? = null, val dataSourceRef: VolumeClaimDataSourceRefResponse? = null, val resources: VolumeClaimResourceRequirementsResponse? = null, val selector: VolumeClaimSpecSelectorResponse? = null, val storageClassName: String? = null, val volumeMode: String? = null, val volumeName: String? = null)

VolumeClaimSpec properties

data class VolumeClaimSpecSelectorMatchExpressionsResponse(val key: String, val operator: String, val values: List<String>? = null)

VolumeClaimSpecSelectorMatchExpressions properties

Link copied to clipboard
data class VolumeClaimSpecSelectorResponse(val matchExpressions: List<VolumeClaimSpecSelectorMatchExpressionsResponse>? = null, val matchLabels: Map<String, String>? = null)

VolumeClaimSpecSelector properties