@azure/arm-iotoperations package

Broker Advanced Settings

Broker AuthorizationConfig properties

AuthorizationConfig Rule Properties

Desired properties of the backend instances of the broker

Batching configuration

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a BrokerAuthentication operations.

BrokerAuthentication Resource properties

Instance broker authentication resource

Custom Authentication properties

Custom method for BrokerAuthentication

Service Account Token for BrokerAuthentication

X509 for BrokerAuthentication.

BrokerAuthenticatorMethodX509Attributes properties.

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

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a BrokerAuthorization operations.

BrokerAuthorization Resource properties

Instance broker authorizations resource

Optional parameters.

Optional parameters.

Broker Diagnostic Setting properties

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a BrokerListener operations.

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

Instance broker resource

Interface representing a Broker operations.

Broker Resource properties

Instance broker resource

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

Cardinality properties

Cert Manager Cert properties

Automatic TLS server certificate management with cert-manager

Cert-Manager issuerRef properties

Cert Manager private key properties

The settings of Client Config.

Dataflow BuiltIn Transformation dataset properties

Dataflow BuiltIn Transformation filter properties

Dataflow BuiltIn Transformation map properties

Dataflow BuiltIn Transformation properties

Optional parameters.

Optional parameters.

Dataflow Destination Operation properties

DataflowEndpoint Authentication Access Token properties

DataflowEndpoint Authentication Sasl properties

Service Account Token for BrokerAuthentication

DataflowEndpoint Authentication SystemAssignedManagedIdentity properties

DataflowEndpoint Authentication UserAssignedManagedIdentity properties

DataflowEndpoint Authentication X509 properties

Optional parameters.

Azure Data Explorer endpoint properties

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

Azure Data Lake endpoint properties

Azure Data Lake endpoint Authentication properties. NOTE Enum - Only one method is supported for one entry

Optional parameters.

Microsoft Fabric endpoint properties

Microsoft Fabric endpoint. Authentication properties. NOTE - Only one method is supported for one entry

Microsoft Fabric endpoint Names properties

Optional parameters.

Kafka endpoint properties

Kafka endpoint Authentication properties. NOTE - only authentication property is allowed per entry

Kafka endpoint Batching properties

Optional parameters.

Local persistent volume endpoint properties

Broker endpoint properties

Mqtt endpoint Authentication properties. NOTE - only authentication property is allowed per entry.

Interface representing a DataflowEndpoint operations.

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

Instance dataflowEndpoint resource

Optional parameters.

Optional parameters.

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

Interface representing a Dataflow operations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a DataflowProfile operations.

DataflowProfile Resource properties

Instance dataflowProfile resource

Dataflow Resource properties

Instance dataflowProfile dataflow resource

Dataflow Source Operation properties

Diagnostic Log properties

DiskBackedMessageBuffer properties

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.

The desired properties of the frontend instances of the Broker

GenerateResourceLimits properties

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Instance operations.

The Instance update model.

The properties of the Instance resource.

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

Optional parameters.

Optional parameters for the client.

Kubernetes reference

Defines a TCP port on which a BrokerListener listens.

Kubernetes reference

Managed service identity (system assigned and/or user assigned identities)

Diagnostic Metrics properties

Details of a REST API operation, returned from the Resource Provider Operations API

Localized display information for and operation.

Optional parameters.

Interface representing a Operations operations.

Options for the byPage method

An interface that allows async iterable iteration both to completion and by page.

PrincipalDefinition properties of Rule

DataflowProfile Diagnostics properties

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Common fields that are returned in the response for all Azure Resource Manager resources

Subject Alternative Names (SANs) for certificate.

The reference to the Schema Registry for this AIO Instance.

Broker Diagnostic Self check properties

Diagnostic Self tracing properties

State Store Resource Rule properties.

The settings of Subscriber Queue Limit.

Metadata pertaining to creation and last modification of the resource.

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

Tls properties

Broker Diagnostic Trace properties

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

User assigned identity properties

VolumeClaimResourceRequirements properties

VolumeClaimSpec properties

VolumeClaimSpecSelector properties

VolumeClaimSpecSelectorMatchExpressions properties

X509 Certificate Authentication properties.

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: Actions are for internal-only APIs.

Broker Authentication Mode
KnownBrokerAuthenticationMethod can be used interchangeably with BrokerAuthenticationMethod, this enum contains the known values that the service supports.

Known values supported by the service

Custom: Custom authentication configuration.
ServiceAccountToken: ServiceAccountToken authentication configuration.
X509: X.509 authentication configuration.

The memory profile settings of the Broker
KnownBrokerMemoryProfile can be used interchangeably with BrokerMemoryProfile, this enum contains the known values that the service supports.

Known values supported by the service

Tiny: Tiny memory profile.
Low: Low memory profile.
Medium: Medium memory profile.
High: High memory profile.

Broker Protocol types
KnownBrokerProtocolType can be used interchangeably with BrokerProtocolType, this enum contains the known values that the service supports.

Known values supported by the service

Mqtt: protocol broker
WebSockets: protocol websocket

BrokerResourceDefinitionMethods methods allowed
KnownBrokerResourceDefinitionMethods can be used interchangeably with BrokerResourceDefinitionMethods, this enum contains the known values that the service supports.

Known values supported by the service

Connect: Allowed Connecting to Broker
Publish: Allowed Publishing to Broker
Subscribe: Allowed Subscribing to Broker

CertManagerIssuerKind properties
KnownCertManagerIssuerKind can be used interchangeably with CertManagerIssuerKind, this enum contains the known values that the service supports.

Known values supported by the service

Issuer: Issuer kind.
ClusterIssuer: ClusterIssuer kind.

How to map events to the cloud.
KnownCloudEventAttributeType can be used interchangeably with CloudEventAttributeType, this enum contains the known values that the service supports.

Known values supported by the service

Propagate: Propagate type
CreateOrRemap: CreateOrRemap type

An interface that describes a page of results.

The kind of entity that created the resource.
<xref:KnowncreatedByType> can be used interchangeably with createdByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

DataflowEndpoint Data Explorer Authentication Method properties
KnownDataExplorerAuthMethod can be used interchangeably with DataExplorerAuthMethod, this enum contains the known values that the service supports.

Known values supported by the service

SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type
UserAssignedManagedIdentity: UserAssignedManagedIdentity type

DataflowEndpoint Data Lake Storage Authentication Method properties
KnownDataLakeStorageAuthMethod can be used interchangeably with DataLakeStorageAuthMethod, this enum contains the known values that the service supports.

Known values supported by the service

SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type
UserAssignedManagedIdentity: UserAssignedManagedIdentity type
AccessToken: AccessToken Option

DataflowEndpoint Authentication Sasl Type properties
KnownDataflowEndpointAuthenticationSaslType can be used interchangeably with DataflowEndpointAuthenticationSaslType, this enum contains the known values that the service supports.

Known values supported by the service

Plain: PLAIN Type
ScramSha256: SCRAM_SHA_256 Type
ScramSha512: SCRAM_SHA_512 Type

DataflowEndpoint Fabric Path Type properties
KnownDataflowEndpointFabricPathType can be used interchangeably with DataflowEndpointFabricPathType, this enum contains the known values that the service supports.

Known values supported by the service

Files: FILES Type
Tables: TABLES Type

DataflowEndpoint Kafka Acks properties
KnownDataflowEndpointKafkaAcks can be used interchangeably with DataflowEndpointKafkaAcks, this enum contains the known values that the service supports.

Known values supported by the service

Zero: ZERO Option
One: ONE Option
All: ALL Option

Kafka endpoint Compression properties
KnownDataflowEndpointKafkaCompression can be used interchangeably with DataflowEndpointKafkaCompression, this enum contains the known values that the service supports.

Known values supported by the service

None: NONE Option
Gzip: Gzip Option
Snappy: SNAPPY Option
Lz4: LZ4 Option

DataflowEndpoint Kafka Partition Strategy properties
KnownDataflowEndpointKafkaPartitionStrategy can be used interchangeably with DataflowEndpointKafkaPartitionStrategy, this enum contains the known values that the service supports.

Known values supported by the service

Default: Default: Assigns messages to random partitions, using a round-robin algorithm.
Static: Static: Assigns messages to a fixed partition number that's derived from the instance ID of the dataflow.
Topic: TOPIC Option
Property: PROPERTY Option

Dataflow type mapping properties
KnownDataflowMappingType can be used interchangeably with DataflowMappingType, this enum contains the known values that the service supports.

Known values supported by the service

NewProperties: New Properties type
Rename: Rename type
Compute: Compute type
PassThrough: Pass-through type
BuiltInFunction: Built in function type

DataflowEndpoint Type properties
KnownEndpointType can be used interchangeably with EndpointType, this enum contains the known values that the service supports.

Known values supported by the service

DataExplorer: Azure Data Explorer Type
DataLakeStorage: Azure Data Lake Type
FabricOneLake: Microsoft Fabric Type
Kafka: Kafka Type
LocalStorage: Local Storage Type
Mqtt: Broker Type

The enum defining type of ExtendedLocation accepted.
KnownExtendedLocationType can be used interchangeably with ExtendedLocationType, this enum contains the known values that the service supports.

Known values supported by the service

CustomLocation: CustomLocation type

DataflowEndpoint Fabric One Lake Authentication Method properties
KnownFabricOneLakeAuthMethod can be used interchangeably with FabricOneLakeAuthMethod, this enum contains the known values that the service supports.

Known values supported by the service

SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type
UserAssignedManagedIdentity: UserAssignedManagedIdentity type

Filter Type properties
KnownFilterType can be used interchangeably with FilterType, this enum contains the known values that the service supports.

Known values supported by the service

Filter: Filter type

DataflowEndpoint Kafka Authentication Method properties
KnownKafkaAuthMethod can be used interchangeably with KafkaAuthMethod, this enum contains the known values that the service supports.

Known values supported by the service

SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type
UserAssignedManagedIdentity: UserAssignedManagedIdentity type
Sasl: Sasl Option
X509Certificate: x509Certificate Option
Anonymous: Anonymous Option

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None: No managed identity.
SystemAssigned: System assigned managed identity.
UserAssigned: User assigned managed identity.
SystemAssigned,UserAssigned: System and user assigned managed identity.

DataflowEndpoint Mqtt Authentication Method properties
KnownMqttAuthMethod can be used interchangeably with MqttAuthMethod, this enum contains the known values that the service supports.

Known values supported by the service

SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type
UserAssignedManagedIdentity: UserAssignedManagedIdentity type
ServiceAccountToken: ServiceAccountToken Option
X509Certificate: x509Certificate Option
Anonymous: Anonymous Option

Broker Retain types
KnownMqttRetainType can be used interchangeably with MqttRetainType, this enum contains the known values that the service supports.

Known values supported by the service

Keep: Retain the messages.
Never: Never retain messages.

Dataflow Operation Type properties
KnownOperationType can be used interchangeably with OperationType, this enum contains the known values that the service supports.

Known values supported by the service

Source: Dataflow Source Operation
Destination: Dataflow Destination Operation
BuiltInTransformation: Dataflow BuiltIn Transformation Operation

Mode properties
KnownOperationalMode can be used interchangeably with OperationalMode, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Enabled is equivalent to True
Disabled: Disabled is equivalent to False.

Valid operators are In, NotIn, Exists and DoesNotExist.
KnownOperatorValues can be used interchangeably with OperatorValues, this enum contains the known values that the service supports.

Known values supported by the service

In: In operator.
NotIn: NotIn operator.
Exists: Exists operator.
DoesNotExist: DoesNotExist operator.

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user: Indicates the operation is initiated by a user.
system: Indicates the operation is initiated by a system.
user,system: Indicates the operation is initiated by a user or system.

Private key algorithm types.
KnownPrivateKeyAlgorithm can be used interchangeably with PrivateKeyAlgorithm, this enum contains the known values that the service supports.

Known values supported by the service

Ec256: Algorithm - ec256.
Ec384: Algorithm - ec384.
Ec521: Algorithm - ec521.
Ed25519: Algorithm - ed25519.
Rsa2048: Algorithm - rsa2048.
Rsa4096: Algorithm - rsa4096.
Rsa8192: Algorithm - rsa8192.

Private key rotation policy.
KnownPrivateKeyRotationPolicy can be used interchangeably with PrivateKeyRotationPolicy, this enum contains the known values that the service supports.

Known values supported by the service

Always: Rotation Policy - Always.
Never: Rotation Policy - Never.

The enum defining status of resource.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Resource has been created.
Failed: Resource creation failed.
Canceled: Resource creation was canceled.
Provisioning: Resource is getting provisioned.
Updating: Resource is Updating.
Deleting: Resource is Deleting.
Accepted: Resource has been Accepted.

Kubernetes Service Types supported by Listener
KnownServiceType can be used interchangeably with ServiceType, this enum contains the known values that the service supports.

Known values supported by the service

ClusterIp: Cluster IP Service.
LoadBalancer: Load Balancer Service.
NodePort: Node Port Service.

Serialization Format properties
KnownSourceSerializationFormat can be used interchangeably with SourceSerializationFormat, this enum contains the known values that the service supports.

Known values supported by the service

Json: JSON Format

StateStoreResourceDefinitionMethods methods allowed
KnownStateStoreResourceDefinitionMethods can be used interchangeably with StateStoreResourceDefinitionMethods, this enum contains the known values that the service supports.

Known values supported by the service

Read: Get/KeyNotify from Store
Write: Set/Delete in Store
ReadWrite: Allowed all operations on Store - Get/KeyNotify/Set/Delete

StateStoreResourceKeyTypes properties
KnownStateStoreResourceKeyTypes can be used interchangeably with StateStoreResourceKeyTypes, this enum contains the known values that the service supports.

Known values supported by the service

Pattern: Key type - pattern
String: Key type - string
Binary: Key type - binary

The enum defining strategies for dropping messages from the subscriber queue.
KnownSubscriberMessageDropStrategy can be used interchangeably with SubscriberMessageDropStrategy, this enum contains the known values that the service supports.

Known values supported by the service

None: Messages are never dropped.
DropOldest: The oldest message is dropped.

Broker Authentication Mode
KnownTlsCertMethodMode can be used interchangeably with TlsCertMethodMode, this enum contains the known values that the service supports.

Known values supported by the service

Automatic: Automatic TLS server certificate configuration.
Manual: Manual TLS server certificate configuration.

Transformation Format properties
KnownTransformationSerializationFormat can be used interchangeably with TransformationSerializationFormat, this enum contains the known values that the service supports.

Known values supported by the service

Delta: Delta Format
Json: JSON Format
Parquet: Parquet Format

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

Broker Authentication Mode

The memory profile settings of the Broker

Broker Protocol types

BrokerResourceDefinitionMethods methods allowed

CertManagerIssuerKind properties

How to map events to the cloud.

The kind of entity that created the resource.

DataflowEndpoint Data Explorer Authentication Method properties

DataflowEndpoint Data Lake Storage Authentication Method properties

DataflowEndpoint Authentication Sasl Type properties

DataflowEndpoint Fabric Path Type properties

DataflowEndpoint Kafka Acks properties

Kafka endpoint Compression properties

DataflowEndpoint Kafka Partition Strategy properties

Dataflow type mapping properties

DataflowEndpoint Type properties

The enum defining type of ExtendedLocation accepted.

DataflowEndpoint Fabric One Lake Authentication Method properties

Filter Type properties

DataflowEndpoint Kafka Authentication Method properties

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

DataflowEndpoint Mqtt Authentication Method properties

Broker Retain types

Dataflow Operation Type properties

Mode properties

Valid operators are In, NotIn, Exists and DoesNotExist.

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

Private key algorithm types.

Private key rotation policy.

The enum defining status of resource.

Kubernetes Service Types supported by Listener

Serialization Format properties

StateStoreResourceDefinitionMethods methods allowed

StateStoreResourceKeyTypes properties

The enum defining strategies for dropping messages from the subscriber queue.

Broker Authentication Mode

Transformation Format properties

Api versions

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.