Package-level declarations

Types

Link copied to clipboard
data class AdvancedSettingsResponse(val clients: ClientConfigResponse? = null, val encryptInternalTraffic: String? = null, val internalCerts: CertManagerCertOptionsResponse? = null)

Broker Advanced Settings

Link copied to clipboard
data class AuthorizationConfigResponse(val cache: String? = null, val rules: List<AuthorizationRuleResponse>? = null)

Broker AuthorizationConfig properties

Link copied to clipboard
data class AuthorizationRuleResponse(val brokerResources: List<BrokerResourceRuleResponse>, val principals: PrincipalDefinitionResponse, val stateStoreResources: List<StateStoreResourceRuleResponse>? = null)

AuthorizationConfig Rule 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 secretRef: String? = null)

Automatic TLS server certificate management with cert-manager

Link copied to clipboard
data class BackendChainResponse(val partitions: Int, val redundancyFactor: Int, val workers: Int? = null)

Desired properties of the backend instances of the broker

Link copied to clipboard
data class BatchingConfigurationResponse(val latencySeconds: Int? = null, val maxMessages: Int? = null)

Batching configuration

Link copied to clipboard
data class BrokerAuthenticationPropertiesResponse(val authenticationMethods: List<BrokerAuthenticatorMethodsResponse>, val provisioningState: String)

BrokerAuthentication Resource properties

Link copied to clipboard

Custom Authentication properties

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
data class BrokerAuthenticatorMethodsResponse(val custom: BrokerAuthenticatorMethodCustomResponse? = null, val method: String, val serviceAccountToken: BrokerAuthenticatorMethodSatResponse? = null, val x509Credentials: BrokerAuthenticatorMethodX509Response? = null)

Set of broker authentication policies. Only one method is supported for each entry.

data class BrokerAuthenticatorMethodX509AttributesResponse(val attributes: Map<String, String>, val subject: String)

BrokerAuthenticatorMethodX509Attributes properties.

Link copied to clipboard
data class BrokerAuthenticatorMethodX509Response(val authorizationAttributes: Map<String, BrokerAuthenticatorMethodX509AttributesResponse>? = null, val trustedClientCaCert: String? = null)

X509 for BrokerAuthentication.

Link copied to clipboard
data class BrokerAuthorizationPropertiesResponse(val authorizationPolicies: AuthorizationConfigResponse, val provisioningState: String)

BrokerAuthorization Resource properties

Link copied to clipboard
data class BrokerDiagnosticsResponse(val logs: DiagnosticsLogsResponse? = null, val metrics: MetricsResponse? = null, val selfCheck: SelfCheckResponse? = null, val traces: TracesResponse? = null)

Broker Diagnostic Setting properties

Link copied to clipboard
data class BrokerListenerPropertiesResponse(val brokerRef: String, val ports: List<ListenerPortResponse>, val provisioningState: String, val serviceName: String? = null, val serviceType: String? = null)

Defines a Broker listener. A listener is a collection of ports on which the broker accepts connections from clients.

Link copied to clipboard
data class BrokerPropertiesResponse(val advanced: AdvancedSettingsResponse? = null, val cardinality: CardinalityResponse? = null, val diagnostics: BrokerDiagnosticsResponse? = null, val diskBackedMessageBuffer: DiskBackedMessageBufferResponse? = null, val generateResourceLimits: GenerateResourceLimitsResponse? = null, val memoryProfile: String? = null, val provisioningState: String)

Broker Resource properties

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

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

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 Cert properties

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

Cert-Manager issuerRef properties

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

Cert Manager private key properties

Link copied to clipboard
data class ClientConfigResponse(val maxKeepAliveSeconds: Int? = null, val maxMessageExpirySeconds: Int? = null, val maxPacketSizeBytes: Int? = null, val maxReceiveMaximum: Int? = null, val maxSessionExpirySeconds: Int? = null, val subscriberQueueLimit: SubscriberQueueLimitResponse? = null)

The settings of Client Config.

data class DataFlowBuiltInTransformationDatasetResponse(val description: String? = null, val expression: String? = null, val inputs: List<String>, val key: String, val schemaRef: String? = null)

DataFlow BuiltIn Transformation dataset properties

data class DataFlowBuiltInTransformationFilterResponse(val description: String? = null, val expression: String, val inputs: List<String>, val type: String? = null)

DataFlow BuiltIn Transformation filter properties

Link copied to clipboard
data class DataFlowBuiltInTransformationMapResponse(val description: String? = null, val expression: String? = null, val inputs: List<String>, val output: String, val type: String? = null)

DataFlow BuiltIn Transformation map properties

Link copied to clipboard
data class DataFlowBuiltInTransformationResponse(val datasets: List<DataFlowBuiltInTransformationDatasetResponse>? = null, val filter: List<DataFlowBuiltInTransformationFilterResponse>? = null, val map: List<DataFlowBuiltInTransformationMapResponse>? = null, val schemaRef: String? = null, val serializationFormat: String? = null)

DataFlow BuiltIn Transformation properties

Link copied to clipboard
data class DataFlowDestinationOperationResponse(val dataDestination: String, val endpointRef: String)

DataFlow Destination Operation properties

Link copied to clipboard
data class DataFlowEndpointAuthenticationResponse(val accessTokenSecretRef: String? = null, val method: String, val saslSettings: DataFlowEndpointAuthenticationSaslResponse? = null, val serviceAccountTokenSettings: DataFlowEndpointAuthenticationServiceAccountTokenResponse? = null, val systemAssignedManagedIdentitySettings: DataFlowEndpointAuthenticationSystemAssignedManagedIdentityResponse? = null, val userAssignedManagedIdentitySettings: DataFlowEndpointAuthenticationUserAssignedManagedIdentityResponse? = null, val x509CredentialsSettings: DataFlowEndpointAuthenticationX509Response? = null)

Azure Data Explorer Authentication properties. NOTE - only authentication property is allowed per entry.

data class DataFlowEndpointAuthenticationSaslResponse(val saslType: String, val tokenSecretRef: String)

DataFlowEndpoint Authentication Sasl properties

Service Account Token for BrokerAuthentication

DataFlowEndpoint Authentication SystemAssignedManagedIdentity properties

data class DataFlowEndpointAuthenticationUserAssignedManagedIdentityResponse(val audience: String, val clientId: String, val tenantId: String)

DataFlowEndpoint Authentication UserAssignedManagedIdentity properties

DataFlowEndpoint Authentication X509 properties

Link copied to clipboard
data class DataFlowEndpointDataExplorerResponse(val batching: BatchingConfigurationResponse? = null, val database: String, val host: String)

Azure Data Explorer endpoint properties

Link copied to clipboard

Azure Data Lake endpoint properties

data class DataFlowEndpointFabricOneLakeNamesResponse(val lakehouseName: String, val workspaceName: String)

Microsoft Fabric endpoint Names properties

Link copied to clipboard
data class DataFlowEndpointFabricOneLakeResponse(val batching: BatchingConfigurationResponse? = null, val host: String, val names: DataFlowEndpointFabricOneLakeNamesResponse, val oneLakePathType: String)

Microsoft Fabric endpoint properties

Link copied to clipboard
data class DataFlowEndpointKafkaBatchingResponse(val latencyMs: Int? = null, val maxBytes: Int? = null, val maxMessages: Int? = null, val mode: String? = null)

Kafka endpoint Batching properties

Link copied to clipboard
data class DataFlowEndpointKafkaResponse(val batching: DataFlowEndpointKafkaBatchingResponse? = null, val compression: String? = null, val consumerGroupId: String? = null, val copyMqttProperties: String? = null, val host: String? = null, val kafkaAcks: String? = null, val partitionStrategy: String? = null, val tls: TlsPropertiesResponse)

Kafka endpoint properties

Link copied to clipboard
data class DataFlowEndpointLocalStorageResponse(val persistentVolumeClaimRef: String)

Local persistent volume endpoint properties

Link copied to clipboard
data class DataFlowEndpointMqttResponse(val clientIdPrefix: String? = null, val host: String? = null, val keepAliveSeconds: Int? = null, val maxInflightMessages: Int? = null, val protocol: String? = null, val qos: Int? = null, val retain: String? = null, val sessionExpirySeconds: Int? = null, val tls: TlsPropertiesResponse? = null)

Broker endpoint properties

Link copied to clipboard
data class DataFlowEndpointPropertiesResponse(val authentication: DataFlowEndpointAuthenticationResponse, val dataExplorerSettings: DataFlowEndpointDataExplorerResponse? = null, val dataLakeStorageSettings: DataFlowEndpointDataLakeStorageResponse? = null, val endpointType: String, val fabricOneLakeSettings: DataFlowEndpointFabricOneLakeResponse? = null, val kafkaSettings: DataFlowEndpointKafkaResponse? = null, val localStorageSettings: DataFlowEndpointLocalStorageResponse? = null, val mqttSettings: DataFlowEndpointMqttResponse? = null, val provisioningState: String)

DataFlowEndpoint Resource properties. NOTE - Only one type of endpoint is supported for one Resource

Link copied to clipboard
data class DataFlowOperationResponse(val builtInTransformationSettings: DataFlowBuiltInTransformationResponse? = null, val destinationSettings: DataFlowDestinationOperationResponse, val name: String? = null, val operationType: String, val sourceSettings: DataFlowSourceOperationResponse)

DataFlow Operation properties. NOTE - One only method is allowed to be used for one entry.

Link copied to clipboard
data class DataFlowProfilePropertiesResponse(val diagnostics: ProfileDiagnosticsResponse? = null, val instanceCount: Int? = null, val provisioningState: String)

DataFlowProfile Resource properties

Link copied to clipboard
data class DataFlowPropertiesResponse(val mode: String? = null, val operations: List<DataFlowOperationResponse>, val profileRef: String, val provisioningState: String)

DataFlow Resource properties

Link copied to clipboard
data class DataFlowSourceOperationResponse(val assetRef: String? = null, val dataSources: List<String>, val endpointRef: String, val schemaRef: String? = null, val serializationFormat: String? = null)

DataFlow Source Operation properties

Link copied to clipboard
data class DiagnosticsLogsResponse(val level: String? = null, val opentelemetryExportConfig: OpenTelemetryLogExportConfigResponse? = null)

Diagnostic Log properties

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

DiskBackedMessageBuffer properties

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

Extended location is an extension of Azure locations. They provide a way to use their Azure ARC enabled Kubernetes clusters as target locations for deploying Azure services instances.

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

The desired properties of the frontend instances of the Broker

Link copied to clipboard
data class GenerateResourceLimitsResponse(val cpu: String? = null)

GenerateResourceLimits properties

Link copied to clipboard
data class GetBrokerAuthenticationResult(val extendedLocation: ExtendedLocationResponse, val id: String, val name: String, val properties: BrokerAuthenticationPropertiesResponse, val systemData: SystemDataResponse, val type: String)

Instance broker authentication resource

Link copied to clipboard
data class GetBrokerAuthorizationResult(val extendedLocation: ExtendedLocationResponse, val id: String, val name: String, val properties: BrokerAuthorizationPropertiesResponse, val systemData: SystemDataResponse, val type: String)

Instance broker authorizations resource

Link copied to clipboard
data class GetBrokerListenerResult(val extendedLocation: ExtendedLocationResponse, val id: String, val name: String, val properties: BrokerListenerPropertiesResponse, val systemData: SystemDataResponse, val type: String)

Instance broker resource

Link copied to clipboard
data class GetBrokerResult(val extendedLocation: ExtendedLocationResponse, val id: String, val name: String, val properties: BrokerPropertiesResponse, val systemData: SystemDataResponse, val type: String)

Instance broker resource

Link copied to clipboard
data class GetDataFlowEndpointResult(val extendedLocation: ExtendedLocationResponse, val id: String, val name: String, val properties: DataFlowEndpointPropertiesResponse, val systemData: SystemDataResponse, val type: String)

Instance dataflowEndpoint resource

Link copied to clipboard
data class GetDataFlowProfileResult(val extendedLocation: ExtendedLocationResponse, val id: String, val name: String, val properties: DataFlowProfilePropertiesResponse, val systemData: SystemDataResponse, val type: String)

Instance dataflowProfile resource

Link copied to clipboard
data class GetDataFlowResult(val extendedLocation: ExtendedLocationResponse, val id: String, val name: String, val properties: DataFlowPropertiesResponse, val systemData: SystemDataResponse, val type: String)

Instance dataflowProfile dataflow resource

Link copied to clipboard
data class GetInstanceResult(val extendedLocation: ExtendedLocationResponse, val id: String, val location: String, val name: String, val properties: InstancePropertiesResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

A Instance resource is a logical container for a set of child resources.

Link copied to clipboard
data class InstancePropertiesResponse(val description: String? = null, val provisioningState: String, val version: String)

The properties of a Instance resource.

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

Kubernetes reference

Link copied to clipboard
data class ListenerPortResponse(val authenticationRef: String? = null, val authorizationRef: String? = null, val nodePort: Int? = null, val port: Int, val protocol: String? = null, val tls: TlsCertMethodResponse? = null)

Defines a TCP port on which a BrokerListener listens.

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

Kubernetes reference

Link copied to clipboard
data class MetricsResponse(val opentelemetryExportConfig: OpenTelemetryExportConfigResponse? = null, val prometheusPort: Int? = null)

Diagnostic Metrics properties

Link copied to clipboard
data class OpenTelemetryExportConfigResponse(val intervalSeconds: Int? = null, val otlpGrpcEndpoint: String)

OpenTelemetry Export Configuration properties

Link copied to clipboard
data class OpenTelemetryLogExportConfigResponse(val intervalSeconds: Int? = null, val level: String? = null, val otlpGrpcEndpoint: String)

OpenTelemetry Log Export Configuration properties

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 Rule

Link copied to clipboard
data class ProfileDiagnosticsResponse(val logs: DiagnosticsLogsResponse? = null, val metrics: MetricsResponse? = null)

DataFlowProfile Diagnostics properties

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

Subject Alternative Names (SANs) for certificate.

Link copied to clipboard
data class SelfCheckResponse(val intervalSeconds: Int? = null, val mode: String? = null, val timeoutSeconds: Int? = null)

Broker Diagnostic Self check properties

Link copied to clipboard
data class SelfTracingResponse(val intervalSeconds: Int? = null, val mode: String? = null)

Diagnostic Self tracing properties

Link copied to clipboard
data class StateStoreResourceRuleResponse(val keyType: String, val keys: List<String>, val method: String)

State Store Resource Rule properties.

Link copied to clipboard
data class SubscriberQueueLimitResponse(val length: Double? = null, val strategy: String? = null)

The settings of Subscriber Queue Limit.

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 TlsCertMethodResponse(val automatic: AutomaticCertMethodResponse? = null, val manual: X509ManualCertificateResponse? = null, val mode: String)

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

Link copied to clipboard
data class TlsPropertiesResponse(val mode: String? = null, val trustedCaCertificateConfigMapRef: String? = null)

Tls properties

Link copied to clipboard
data class TracesResponse(val cacheSizeMegabytes: Int? = null, val mode: String? = null, val opentelemetryExportConfig: OpenTelemetryExportConfigResponse? = null, val selfTracing: SelfTracingResponse? = null, val spanChannelCapacity: Int? = null)

Broker Diagnostic Trace 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: LocalKubernetesReferenceResponse? = null, val dataSourceRef: KubernetesReferenceResponse? = 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

Link copied to clipboard
data class X509ManualCertificateResponse(val secretRef: String)

X509 Certificate Authentication properties.