@azure/arm-iotoperations package

Classes

IoTOperationsClient

Interfaces

AdvancedSettings	Broker Advanced Settings
AkriConnectorAllocatedDevice	AkriConnector allocated device.
AkriConnectorCreateOrUpdateOptionalParams	Optional parameters.
AkriConnectorDeleteOptionalParams	Optional parameters.
AkriConnectorGetOptionalParams	Optional parameters.
AkriConnectorListByTemplateOptionalParams	Optional parameters.
AkriConnectorOperations	Interface representing a AkriConnector operations.
AkriConnectorProperties	AkriConnector properties.
AkriConnectorResource	AkriConnector resource.
AkriConnectorStatus	AkriConnector status.
AkriConnectorTemplateAioMetadata	AkriConnectorTemplateAioMetadata properties.
AkriConnectorTemplateAllocation	AkriConnectorTemplateAllocation properties.
AkriConnectorTemplateBucketizedAllocation	AkriConnectorTemplateBucketizedAllocation properties.
AkriConnectorTemplateCreateOrUpdateOptionalParams	Optional parameters.
AkriConnectorTemplateDeleteOptionalParams	Optional parameters.
AkriConnectorTemplateDeviceInboundEndpointType	AkriConnectorTemplateDeviceInboundEndpointType properties.
AkriConnectorTemplateDiagnostics	AkriConnectorTemplateDiagnostics properties.
AkriConnectorTemplateGetOptionalParams	Optional parameters.
AkriConnectorTemplateListByInstanceResourceOptionalParams	Optional parameters.
AkriConnectorTemplateManagedConfiguration	AkriConnectorTemplateManagedConfiguration properties.
AkriConnectorTemplateManagedConfigurationSettings	AkriConnectorTemplateManagedConfiguration properties.
AkriConnectorTemplateOperations	Interface representing a AkriConnectorTemplate operations.
AkriConnectorTemplatePersistentVolumeClaim	AkriConnectorTemplatePersistentVolumeClaim properties.
AkriConnectorTemplateProperties	AkriConnectorTemplate properties.
AkriConnectorTemplateResource	AkriConnectorTemplate resource.
AkriConnectorTemplateRuntimeConfiguration	AkriConnectorTemplateRuntimeConfiguration properties.
AkriConnectorTemplateRuntimeImageConfiguration	AkriConnectorTemplateRuntimeImageConfiguration properties.
AkriConnectorTemplateRuntimeImageConfigurationSettings	AkriConnectorTemplateRuntimeImageConfiguration properties.
AkriConnectorTemplateRuntimeStatefulSetConfiguration	AkriConnectorTemplateRuntimeStatefulSetConfiguration properties.
AkriConnectorTemplateTrustList	AkriConnectorTemplateTrustList properties.
AkriConnectorsContainerRegistry	AkriConnectorsContainerRegistry properties.
AkriConnectorsContainerRegistrySettings	AkriConnectorsContainerRegistry properties.
AkriConnectorsDiagnosticsLogs	AkriConnectorsDiagnostic Log properties.
AkriConnectorsDigest	AkriConnectorsDigest properties.
AkriConnectorsImagePullSecret	AkriConnectorsImagePullSecret properties.
AkriConnectorsMqttAuthentication	AkriConnectorsMqttAuthentication properties.
AkriConnectorsMqttConnectionConfiguration	AkriConnectorsMqttConnectionConfiguration properties.
AkriConnectorsRegistryEndpointRef	AkriConnectorsRegistryEndpointRef properties.
AkriConnectorsRegistrySettings	AkriConnectorsRegistrySettings properties.
AkriConnectorsSecret	AkriConnectorsSecret properties.
AkriConnectorsServiceAccountAuthentication	AkriConnectorsServiceAccountAuthentication properties.
AkriConnectorsServiceAccountTokenSettings	AkriConnectorsServiceAccountTokenSettings properties.
AkriConnectorsTag	AkriConnectorsTag properties.
AkriConnectorsTagDigestSettings	AkriConnectorsTagDigestSettings properties.
AkriServiceCreateOrUpdateOptionalParams	Optional parameters.
AkriServiceDeleteOptionalParams	Optional parameters.
AkriServiceGetOptionalParams	Optional parameters.
AkriServiceListByInstanceResourceOptionalParams	Optional parameters.
AkriServiceOperations	Interface representing a AkriService operations.
AkriServiceProperties	AkriService properties.
AkriServiceResource	AkriService resource.
AkriServiceStatus	AkriService status.
AuthorizationConfig	Broker AuthorizationConfig properties
AuthorizationRule	AuthorizationConfig Rule Properties
AzureDeviceRegistryNamespaceRef	Azure Device Registry Namespace reference.
BackendChain	Desired properties of the backend instances of the broker
BatchingConfiguration	Batching configuration
BrokerAuthenticationCreateOrUpdateOptionalParams	Optional parameters.
BrokerAuthenticationDeleteOptionalParams	Optional parameters.
BrokerAuthenticationGetOptionalParams	Optional parameters.
BrokerAuthenticationListByResourceGroupOptionalParams	Optional parameters.
BrokerAuthenticationOperations	Interface representing a BrokerAuthentication operations.
BrokerAuthenticationProperties	BrokerAuthentication Resource properties
BrokerAuthenticationResource	Instance broker authentication resource
BrokerAuthenticatorCustomAuth	Custom Authentication properties
BrokerAuthenticatorMethodCustom	Custom method for BrokerAuthentication
BrokerAuthenticatorMethodSat	Service Account Token for BrokerAuthentication
BrokerAuthenticatorMethodX509	X509 for BrokerAuthentication.
BrokerAuthenticatorMethodX509Attributes	BrokerAuthenticatorMethodX509Attributes properties.
BrokerAuthenticatorMethods	Set of broker authentication policies. Only one method is supported for each entry.
BrokerAuthorizationCreateOrUpdateOptionalParams	Optional parameters.
BrokerAuthorizationDeleteOptionalParams	Optional parameters.
BrokerAuthorizationGetOptionalParams	Optional parameters.
BrokerAuthorizationListByResourceGroupOptionalParams	Optional parameters.
BrokerAuthorizationOperations	Interface representing a BrokerAuthorization operations.
BrokerAuthorizationProperties	BrokerAuthorization Resource properties
BrokerAuthorizationResource	Instance broker authorizations resource
BrokerCreateOrUpdateOptionalParams	Optional parameters.
BrokerDeleteOptionalParams	Optional parameters.
BrokerDiagnostics	Broker Diagnostic Setting properties
BrokerGetOptionalParams	Optional parameters.
BrokerListByResourceGroupOptionalParams	Optional parameters.
BrokerListenerCreateOrUpdateOptionalParams	Optional parameters.
BrokerListenerDeleteOptionalParams	Optional parameters.
BrokerListenerGetOptionalParams	Optional parameters.
BrokerListenerListByResourceGroupOptionalParams	Optional parameters.
BrokerListenerOperations	Interface representing a BrokerListener operations.
BrokerListenerProperties	Defines a Broker listener. A listener is a collection of ports on which the broker accepts connections from clients.
BrokerListenerResource	Instance broker resource
BrokerOperations	Interface representing a Broker operations.
BrokerPersistence	Disk persistence configuration. When persistence is enabled, certain items (non-performance-critical data) selected for persistence will reside only on disk. Below are the affected items: Retained messages will be stored on disk only. WILL messages will be stored on disk only. DSS key/value pairs will be stored on disk only, except for performance-critical items like timed locks, which remain in both disk and memory for improved performance. Optional. Everything is in-memory if not set. Note: if configured, all MQTT session states are written to disk.
BrokerPersistenceEncryption	Broker Persistence Encryption properties.
BrokerProperties	Broker Resource properties
BrokerResource	Instance broker resource
BrokerResourceRule	Broker Resource Rule properties. This defines the objects that represent the actions or topics, such as - method.Connect, method.Publish, etc.
BrokerRetainMessagesCustomPolicy	Custom Broker Retain Message Policy.
BrokerRetainMessagesDynamic	Dynamic settings of BrokerRetainMessagesCustomPolicy.
BrokerRetainMessagesPolicy	Broker Retain policy properties.
BrokerRetainMessagesSettings	Broker Retain Messages properties.
BrokerStateStoreCustomPolicy	Broker State Store Custom Policy.
BrokerStateStoreDynamic	Dynamic settings of BrokerStateStoreCustomPolicy.
BrokerStateStorePolicy	Broker State Store Policy.
BrokerStateStorePolicyResources	Broker State Store Policy Resources properties.
BrokerStateStorePolicySettings	Broker State Store Custom Policy Settings.
BrokerStatus	BrokerStatus status.
BrokerSubscriberQueueCustomPolicy	Custom Subscriber Queue Policy Properties.
BrokerSubscriberQueueCustomPolicySettings	Broker Subscriber Queue Custom Policy properties.
BrokerSubscriberQueueDynamic	Dynamic settings of BrokerSubscriberQueueCustomPolicy.
BrokerSubscriberQueuePolicy	Broker Subscriber Queue Policy properties.
Cardinality	Cardinality properties
CertManagerCertOptions	Cert Manager Cert properties
CertManagerCertificateSpec	Automatic TLS server certificate management with cert-manager
CertManagerIssuerRef	Cert-Manager issuerRef properties
CertManagerPrivateKey	Cert Manager private key properties
ClientConfig	The settings of Client Config.
DataflowBuiltInTransformationDataset	Dataflow BuiltIn Transformation dataset properties
DataflowBuiltInTransformationFilter	Dataflow BuiltIn Transformation filter properties
DataflowBuiltInTransformationMap	Dataflow BuiltIn Transformation map properties
DataflowBuiltInTransformationSettings	Dataflow BuiltIn Transformation properties
DataflowCreateOrUpdateOptionalParams	Optional parameters.
DataflowDeleteOptionalParams	Optional parameters.
DataflowDestinationAddIfNotPresentHeaderAction	Dataflow Destination Add if not present HeaderAction properties
DataflowDestinationAddOrReplaceHeaderAction	Dataflow Destination Add or Replace HeaderAction properties
DataflowDestinationHeaderAction	Dataflow Destination Header Action properties
DataflowDestinationOperationSettings	Dataflow Destination Operation properties
DataflowDestinationRemoveHeaderAction	Dataflow Destination Remove HeaderAction properties
DataflowEndpointAuthenticationAccessToken	DataflowEndpoint Authentication Access Token properties
DataflowEndpointAuthenticationAnonymous	DataflowEndpoint Anonymous Authentication properties
DataflowEndpointAuthenticationSasl	DataflowEndpoint Authentication Sasl properties
DataflowEndpointAuthenticationServiceAccountToken	Service Account Token for BrokerAuthentication
DataflowEndpointAuthenticationSystemAssignedManagedIdentity	DataflowEndpoint Authentication SystemAssignedManagedIdentity properties
DataflowEndpointAuthenticationUserAssignedManagedIdentity	DataflowEndpoint Authentication UserAssignedManagedIdentity properties
DataflowEndpointAuthenticationX509	DataflowEndpoint Authentication X509 properties
DataflowEndpointCreateOrUpdateOptionalParams	Optional parameters.
DataflowEndpointDataExplorer	Azure Data Explorer endpoint properties
DataflowEndpointDataExplorerAuthentication	Azure Data Explorer Authentication properties. NOTE - only authentication property is allowed per entry.
DataflowEndpointDataLakeStorage	Azure Data Lake endpoint properties
DataflowEndpointDataLakeStorageAuthentication	Azure Data Lake endpoint Authentication properties. NOTE Enum - Only one method is supported for one entry
DataflowEndpointDeleteOptionalParams	Optional parameters.
DataflowEndpointFabricOneLake	Microsoft Fabric endpoint properties
DataflowEndpointFabricOneLakeAuthentication	Microsoft Fabric endpoint. Authentication properties. NOTE - Only one method is supported for one entry
DataflowEndpointFabricOneLakeNames	Microsoft Fabric endpoint Names properties
DataflowEndpointGetOptionalParams	Optional parameters.
DataflowEndpointKafka	Kafka endpoint properties
DataflowEndpointKafkaAuthentication	Kafka endpoint Authentication properties. NOTE - only authentication property is allowed per entry
DataflowEndpointKafkaBatching	Kafka endpoint Batching properties
DataflowEndpointListByResourceGroupOptionalParams	Optional parameters.
DataflowEndpointLocalStorage	Local persistent volume endpoint properties
DataflowEndpointMqtt	Broker endpoint properties
DataflowEndpointMqttAuthentication	Mqtt endpoint Authentication properties. NOTE - only authentication property is allowed per entry.
DataflowEndpointOpenTelemetry	OpenTelemetry endpoint properties.
DataflowEndpointOperations	Interface representing a DataflowEndpoint operations.
DataflowEndpointProperties	DataflowEndpoint Resource properties. NOTE - Only one type of endpoint is supported for one Resource
DataflowEndpointResource	Instance dataflowEndpoint resource
DataflowGetOptionalParams	Optional parameters.
DataflowGraphConnectionInput	DataflowGraph DataflowGraphNode Connection Input.
DataflowGraphConnectionOutput	DataflowGraph DataflowGraphNode Connection Output.
DataflowGraphConnectionSchemaSettings	DataflowGraph connection node output schema settings.
DataflowGraphCreateOrUpdateOptionalParams	Optional parameters.
DataflowGraphDeleteOptionalParams	Optional parameters.
DataflowGraphDestinationAddIfNotPresentHeaderAction	DataflowGraph Destination Add if not present HeaderAction properties.
DataflowGraphDestinationAddOrReplaceHeaderAction	DataflowGraph Destination Add or Replace HeaderAction properties.
DataflowGraphDestinationHeaderAction	DataflowGraph Destination Header Action.
DataflowGraphDestinationNode	DataflowGraph destination node properties.
DataflowGraphDestinationNodeSettings	DataflowGraph destination node settings.
DataflowGraphDestinationRemoveHeaderAction	DataflowGraph Destination Remove HeaderAction properties.
DataflowGraphGetOptionalParams	Optional parameters.
DataflowGraphGraphNode	DataflowGraph graph node properties.
DataflowGraphGraphNodeConfiguration	DataflowGraph graph node configuration.
DataflowGraphListByDataflowProfileOptionalParams	Optional parameters.
DataflowGraphNode	DataflowGraph node properties.
DataflowGraphNodeConnection	DataflowGraph DataflowGraphNode Connection.
DataflowGraphNodeGraphSettings	DataflowGraph graph node settings.
DataflowGraphOperations	Interface representing a DataflowGraph operations.
DataflowGraphProperties	DataflowGraph properties.
DataflowGraphResource	Instance dataflowEndpoint resource.
DataflowGraphSourceNode	DataflowGraph source node properties.
DataflowGraphSourceSettings	DataflowGraph source node settings.
DataflowGraphStatus	DataflowGraph status.
DataflowListByResourceGroupOptionalParams	Optional parameters.
DataflowOpenTelemetryAnonymousAuthentication	DataflowOpenTelemetryAnonymousAuthentication properties.
DataflowOpenTelemetryAuthentication	Dataflow OpenTelemetry authentication properties.
DataflowOpenTelemetryServiceAccountAuthentication	DataflowOpenTelemetryServiceAccountAuthentication properties.
DataflowOpenTelemetryX509CertificateAuthentication	DataflowOpenTelemetryX509CertificateAuthentication properties.
DataflowOperation	Dataflow Operation properties. NOTE - One only method is allowed to be used for one entry.
DataflowOperations	Interface representing a Dataflow operations.
DataflowProfileCreateOrUpdateOptionalParams	Optional parameters.
DataflowProfileDeleteOptionalParams	Optional parameters.
DataflowProfileGetOptionalParams	Optional parameters.
DataflowProfileListByResourceGroupOptionalParams	Optional parameters.
DataflowProfileOperations	Interface representing a DataflowProfile operations.
DataflowProfileProperties	DataflowProfile Resource properties
DataflowProfileResource	Instance dataflowProfile resource
DataflowProfileStatus	DataflowProfile status.
DataflowProperties	Dataflow Resource properties
DataflowResource	Instance dataflowProfile dataflow resource
DataflowSourceOperationSettings	Dataflow Source Operation properties
DataflowStatus	DataflowStatus status.
DiagnosticsLogs	Diagnostic Log properties
DiskBackedMessageBuffer	DiskBackedMessageBuffer properties
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
ExtendedLocation	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.
Frontend	The desired properties of the frontend instances of the Broker
GenerateResourceLimits	GenerateResourceLimits properties
InstanceCreateOrUpdateOptionalParams	Optional parameters.
InstanceDeleteOptionalParams	Optional parameters.
InstanceFeature	The features of the AIO Instance.
InstanceGetOptionalParams	Optional parameters.
InstanceListByResourceGroupOptionalParams	Optional parameters.
InstanceListBySubscriptionOptionalParams	Optional parameters.
InstanceOperations	Interface representing a Instance operations.
InstancePatchModel	The Instance update model.
InstanceProperties	The properties of the Instance resource.
InstanceResource	A Instance resource is a logical container for a set of child resources.
InstanceUpdateOptionalParams	Optional parameters.
IoTOperationsClientOptionalParams	Optional parameters for the client.
KubernetesReference	Kubernetes reference
ListenerPort	Defines a TCP port on which a BrokerListener listens.
LocalKubernetesReference	Kubernetes reference
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
Metrics	Diagnostic Metrics properties
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PrincipalDefinition	PrincipalDefinition properties of Rule
ProfileDiagnostics	DataflowProfile Diagnostics properties
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RegistryEndpointAnonymousAuthentication	Anonymous authentication
RegistryEndpointAnonymousSettings	RegistryEndpoint Anonymous authentication properties
RegistryEndpointArtifactPullSecretAuthentication	Artifact Pull Secret authentication
RegistryEndpointArtifactPullSecretSettings	RegistryEndpoint Artifact Pull Secret authentication properties
RegistryEndpointAuthentication	Model for RegistryEndpointAuthentication
RegistryEndpointCreateOrUpdateOptionalParams	Optional parameters.
RegistryEndpointDeleteOptionalParams	Optional parameters.
RegistryEndpointGetOptionalParams	Optional parameters.
RegistryEndpointListByInstanceResourceOptionalParams	Optional parameters.
RegistryEndpointOperations	Interface representing a RegistryEndpoint operations.
RegistryEndpointProperties	RegistryEndpoint properties
RegistryEndpointResource	RegistryEndpoint resource
RegistryEndpointSystemAssignedIdentityAuthentication	System assigned identity authentication
RegistryEndpointSystemAssignedManagedIdentitySettings	System assigned managed identity properties
RegistryEndpointTrustedSigningKey	RegistryEndpoint Trust properties
RegistryEndpointTrustedSigningKeyConfigMap	Settings for RegistryEndpoint trust provided through a configmap.
RegistryEndpointTrustedSigningKeySecret	Settings for RegistryEndpoint trust provided through a secret.
RegistryEndpointUserAssignedIdentityAuthentication	User assigned identity authentication
RegistryEndpointUserAssignedManagedIdentitySettings	User assigned managed identity properties
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceHealthStatus	Represents the health state of a resource.
RestorePollerOptions
SanForCert	Subject Alternative Names (SANs) for certificate.
SchemaRegistryRef	The reference to the Schema Registry for this AIO Instance.
SecretProviderClassRef	The reference to the AIO Secret provider class.
SelfCheck	Broker Diagnostic Self check properties
SelfTracing	Diagnostic Self tracing properties
StateStoreResourceRule	State Store Resource Rule properties.
SubscriberQueueLimit	The settings of Subscriber Queue Limit.
SystemData	Metadata pertaining to creation and last modification of the resource.
TlsCertMethod	Collection of different TLS types, NOTE- Enum at a time only one of them needs to be supported
TlsProperties	Tls properties
Traces	Broker Diagnostic Trace properties
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UserAssignedIdentity	User assigned identity properties
VolumeClaimResourceRequirements	VolumeClaimResourceRequirements properties
VolumeClaimResourceRequirementsClaims	VolumeClaimResourceRequirementsClaims properties.
VolumeClaimSpec	VolumeClaimSpec properties
VolumeClaimSpecSelector	VolumeClaimSpecSelector properties
VolumeClaimSpecSelectorMatchExpressions	VolumeClaimSpecSelectorMatchExpressions properties
X509ManualCertificate	X509 Certificate Authentication properties.

Type Aliases

ActionType	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.
AkriConnectorTemplateAllocationPolicy	AkriConnectorTemplateAllocationPolicy properties. KnownAkriConnectorTemplateAllocationPolicy can be used interchangeably with AkriConnectorTemplateAllocationPolicy, this enum contains the known values that the service supports. Known values supported by the service Bucketized: Bucketized allocation policy.
AkriConnectorTemplateAllocationUnion	Alias for AkriConnectorTemplateAllocationUnion
AkriConnectorTemplateManagedConfigurationSettingsUnion	Alias for AkriConnectorTemplateManagedConfigurationSettingsUnion
AkriConnectorTemplateManagedConfigurationType	Managed configuration types. KnownAkriConnectorTemplateManagedConfigurationType can be used interchangeably with AkriConnectorTemplateManagedConfigurationType, this enum contains the known values that the service supports. Known values supported by the service ImageConfiguration: Image Configuration Type. StatefulSetConfiguration: StatefulSet Configuration Type.
AkriConnectorTemplateRuntimeConfigurationType	Runtime configuration types. KnownAkriConnectorTemplateRuntimeConfigurationType can be used interchangeably with AkriConnectorTemplateRuntimeConfigurationType, this enum contains the known values that the service supports. Known values supported by the service ManagedConfiguration: Managed Configuration Type.
AkriConnectorTemplateRuntimeConfigurationUnion	Alias for AkriConnectorTemplateRuntimeConfigurationUnion
AkriConnectorsImagePullPolicy	Image pull policy. KnownAkriConnectorsImagePullPolicy can be used interchangeably with AkriConnectorsImagePullPolicy, this enum contains the known values that the service supports. Known values supported by the service Always: Always pull the image. IfNotPresent: IfNotPresent pull the image. Never: Never pull the image.
AkriConnectorsMqttAuthenticationMethod	AkriConnectorsMqttAuthenticationMethod properties. KnownAkriConnectorsMqttAuthenticationMethod can be used interchangeably with AkriConnectorsMqttAuthenticationMethod, this enum contains the known values that the service supports. Known values supported by the service ServiceAccountToken: Service Account Token authentication.
AkriConnectorsMqttAuthenticationUnion	Alias for AkriConnectorsMqttAuthenticationUnion
AkriConnectorsMqttProtocolType	Mqtt protocol types. KnownAkriConnectorsMqttProtocolType can be used interchangeably with AkriConnectorsMqttProtocolType, this enum contains the known values that the service supports. Known values supported by the service Mqtt: Mqtt protocol.
AkriConnectorsRegistrySettingsType	AkriConnectorsRegistrySettings properties. KnownAkriConnectorsRegistrySettingsType can be used interchangeably with AkriConnectorsRegistrySettingsType, this enum contains the known values that the service supports. Known values supported by the service RegistryEndpointRef: A Registry Endpoint reference. ContainerRegistry: A Container Registry reference.
AkriConnectorsRegistrySettingsUnion	Alias for AkriConnectorsRegistrySettingsUnion
AkriConnectorsTagDigestSettingsUnion	Alias for AkriConnectorsTagDigestSettingsUnion
AkriConnectorsTagDigestType	AkriConnectorsTagDigestType values. KnownAkriConnectorsTagDigestType can be used interchangeably with AkriConnectorsTagDigestType, this enum contains the known values that the service supports. Known values supported by the service Tag: Indicates that a tag should be specified. Digest: Indicates that a digest should be specified.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
BrokerAuthenticationMethod	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.
BrokerAuthenticatorValidationMethods	X509 authentication validation methods. KnownBrokerAuthenticatorValidationMethods can be used interchangeably with BrokerAuthenticatorValidationMethods, this enum contains the known values that the service supports. Known values supported by the service None: No additional validation is performed AzureDeviceRegistry: Additional validation is performed using the Azure Device Registry.
BrokerMemoryProfile	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.
BrokerPersistencePolicyMode	Broker Persistence Policy Mode values. KnownBrokerPersistencePolicyMode can be used interchangeably with BrokerPersistencePolicyMode, this enum contains the known values that the service supports. Known values supported by the service All: Policy mode for All. None: Policy mode for None. Custom: Indicates that the policy is a custom policy.
BrokerProtocolType	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	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
BrokerRetainMessagesPolicyUnion	Alias for BrokerRetainMessagesPolicyUnion
BrokerStateStoreKeyType	Broker State Store Key Type properties. KnownBrokerStateStoreKeyType can be used interchangeably with BrokerStateStoreKeyType, this enum contains the known values that the service supports. Known values supported by the service Pattern: Used for glob-style pattern matching. String: Used to do exact match, for example, when a key contains characters that might be otherwise matched as a pattern (*, ?, [0-9]). Binary: Used to match a binary key.
BrokerStateStorePolicyUnion	Alias for BrokerStateStorePolicyUnion
BrokerSubscriberQueuePolicyUnion	Alias for BrokerSubscriberQueuePolicyUnion
CertManagerIssuerKind	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.
CloudEventAttributeType	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
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. 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.
DataExplorerAuthMethod	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
DataLakeStorageAuthMethod	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
DataflowDestinationHeaderActionUnion	Alias for DataflowDestinationHeaderActionUnion
DataflowEndpointAuthenticationSaslType	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
DataflowEndpointFabricPathType	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
DataflowEndpointHostType	DataflowEndpoint Host Type properties KnownDataflowEndpointHostType can be used interchangeably with DataflowEndpointHostType, this enum contains the known values that the service supports. Known values supported by the service FabricRT: Fabric Real-Time Type EventGrid: EventGrid Type LocalBroker: Local MQTT Type Eventhub: EventHub Type CustomMqtt: Custom MQTT Type CustomKafka: Custom Kafka Type
DataflowEndpointKafkaAcks	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
DataflowEndpointKafkaCompression	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
DataflowEndpointKafkaPartitionStrategy	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
DataflowGraphConnectionSchemaSerializationFormat	Serialization format for dataflow graph connection. KnownDataflowGraphConnectionSchemaSerializationFormat can be used interchangeably with DataflowGraphConnectionSchemaSerializationFormat, 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 Avro: Avro serialization format.
DataflowGraphDestinationHeaderActionType	DataflowGraph Destination Header Action Types. KnownDataflowGraphDestinationHeaderActionType can be used interchangeably with DataflowGraphDestinationHeaderActionType, this enum contains the known values that the service supports. Known values supported by the service AddIfNotPresent: Add if not present type. Remove: Remove type. AddOrReplace: Add or Replace type.
DataflowGraphDestinationHeaderActionUnion	Alias for DataflowGraphDestinationHeaderActionUnion
DataflowGraphNodeType	DataflowGraph node types. KnownDataflowGraphNodeType can be used interchangeably with DataflowGraphNodeType, this enum contains the known values that the service supports. Known values supported by the service Source: Dataflow source node. Graph: Dataflow graph node. Destination: Dataflow destination node.
DataflowGraphNodeUnion	Alias for DataflowGraphNodeUnion
DataflowHeaderActionType	Dataflow Destination Header Action Types KnownDataflowHeaderActionType can be used interchangeably with DataflowHeaderActionType, this enum contains the known values that the service supports. Known values supported by the service AddIfNotPresent: Add if not present type Remove: Remove type AddOrReplace: Add or Replace type
DataflowMappingType	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
DataflowOpenTelemetryAuthenticationMethod	Dataflow OpenTelemetry authentication method values. KnownDataflowOpenTelemetryAuthenticationMethod can be used interchangeably with DataflowOpenTelemetryAuthenticationMethod, this enum contains the known values that the service supports. Known values supported by the service ServiceAccountToken: Uses serviceaccount token. X509Certificate: Uses x509 certificate. Anonymous: Connects anonymously.
DataflowOpenTelemetryAuthenticationUnion	Alias for DataflowOpenTelemetryAuthenticationUnion
EndpointType	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 OpenTelemetry: OpenTelemetry Type
ExtendedLocationType	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
FabricOneLakeAuthMethod	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
FilterType	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
InstanceFeatureMode	The enum defining mode of a feature. KnownInstanceFeatureMode can be used interchangeably with InstanceFeatureMode, this enum contains the known values that the service supports. Known values supported by the service Stable: Opt in to enable a stable feature Preview: Opt in to enable a preview feature Disabled: Opt out of a feature
KafkaAuthMethod	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
ManagedServiceIdentityType	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.
MqttAuthMethod	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
MqttRetainType	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.
OperationType	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
OperationalMode	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.
OperatorValues	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.
Origin	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.
PrivateKeyAlgorithm	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.
PrivateKeyRotationPolicy	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.
ProvisioningState	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.
RegistryEndpointAuthenticationMethod	The authentication method. KnownRegistryEndpointAuthenticationMethod can be used interchangeably with RegistryEndpointAuthenticationMethod, this enum contains the known values that the service supports. Known values supported by the service SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type UserAssignedManagedIdentity: UserAssignedManagedIdentity type Anonymous: Anonymous Option ArtifactPullSecret: Artifact Pull Secret authentication
RegistryEndpointAuthenticationUnion	Alias for RegistryEndpointAuthenticationUnion
RegistryEndpointTrustedSigningKeyType	RegistryEndpointTrustedSigningKeyType values KnownRegistryEndpointTrustedSigningKeyType can be used interchangeably with RegistryEndpointTrustedSigningKeyType, this enum contains the known values that the service supports. Known values supported by the service Secret: Trust settings stored in a Kubernetes Secret. ConfigMap: Trust settings stored in a Kubernetes ConfigMap.
RegistryEndpointTrustedSigningKeyUnion	Alias for RegistryEndpointTrustedSigningKeyUnion
ResourceHealthState	The health state of the resource. KnownResourceHealthState can be used interchangeably with ResourceHealthState, this enum contains the known values that the service supports. Known values supported by the service Available: Resource is Available and functioning as expected. Degraded: Resource health is degraded. Unavailable: Resource is not functioning as expected. Unknown: Resource state is unknown.
ServiceType	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.
SourceSerializationFormat	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	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	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
SubscriberMessageDropStrategy	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.
TlsCertMethodMode	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.
TransformationSerializationFormat	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

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownAkriConnectorTemplateAllocationPolicy	AkriConnectorTemplateAllocationPolicy properties.
KnownAkriConnectorTemplateManagedConfigurationType	Managed configuration types.
KnownAkriConnectorTemplateRuntimeConfigurationType	Runtime configuration types.
KnownAkriConnectorsImagePullPolicy	Image pull policy.
KnownAkriConnectorsMqttAuthenticationMethod	AkriConnectorsMqttAuthenticationMethod properties.
KnownAkriConnectorsMqttProtocolType	Mqtt protocol types.
KnownAkriConnectorsRegistrySettingsType	AkriConnectorsRegistrySettings properties.
KnownAkriConnectorsTagDigestType	AkriConnectorsTagDigestType values.
KnownBrokerAuthenticationMethod	Broker Authentication Mode
KnownBrokerAuthenticatorValidationMethods	X509 authentication validation methods.
KnownBrokerMemoryProfile	The memory profile settings of the Broker
KnownBrokerPersistencePolicyMode	Broker Persistence Policy Mode values.
KnownBrokerProtocolType	Broker Protocol types
KnownBrokerResourceDefinitionMethods	BrokerResourceDefinitionMethods methods allowed
KnownBrokerStateStoreKeyType	Broker State Store Key Type properties.
KnownCertManagerIssuerKind	CertManagerIssuerKind properties
KnownCloudEventAttributeType	How to map events to the cloud.
KnownCreatedByType	The kind of entity that created the resource.
KnownDataExplorerAuthMethod	DataflowEndpoint Data Explorer Authentication Method properties
KnownDataLakeStorageAuthMethod	DataflowEndpoint Data Lake Storage Authentication Method properties
KnownDataflowEndpointAuthenticationSaslType	DataflowEndpoint Authentication Sasl Type properties
KnownDataflowEndpointFabricPathType	DataflowEndpoint Fabric Path Type properties
KnownDataflowEndpointHostType	DataflowEndpoint Host Type properties
KnownDataflowEndpointKafkaAcks	DataflowEndpoint Kafka Acks properties
KnownDataflowEndpointKafkaCompression	Kafka endpoint Compression properties
KnownDataflowEndpointKafkaPartitionStrategy	DataflowEndpoint Kafka Partition Strategy properties
KnownDataflowGraphConnectionSchemaSerializationFormat	Serialization format for dataflow graph connection.
KnownDataflowGraphDestinationHeaderActionType	DataflowGraph Destination Header Action Types.
KnownDataflowGraphNodeType	DataflowGraph node types.
KnownDataflowHeaderActionType	Dataflow Destination Header Action Types
KnownDataflowMappingType	Dataflow type mapping properties
KnownDataflowOpenTelemetryAuthenticationMethod	Dataflow OpenTelemetry authentication method values.
KnownEndpointType	DataflowEndpoint Type properties
KnownExtendedLocationType	The enum defining type of ExtendedLocation accepted.
KnownFabricOneLakeAuthMethod	DataflowEndpoint Fabric One Lake Authentication Method properties
KnownFilterType	Filter Type properties
KnownInstanceFeatureMode	The enum defining mode of a feature.
KnownKafkaAuthMethod	DataflowEndpoint Kafka Authentication Method properties
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownMqttAuthMethod	DataflowEndpoint Mqtt Authentication Method properties
KnownMqttRetainType	Broker Retain types
KnownOperationType	Dataflow Operation Type properties
KnownOperationalMode	Mode properties
KnownOperatorValues	Valid operators are In, NotIn, Exists and DoesNotExist.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownPrivateKeyAlgorithm	Private key algorithm types.
KnownPrivateKeyRotationPolicy	Private key rotation policy.
KnownProvisioningState	The enum defining status of resource.
KnownRegistryEndpointAuthenticationMethod	The authentication method.
KnownRegistryEndpointTrustedSigningKeyType	RegistryEndpointTrustedSigningKeyType values
KnownResourceHealthState	The health state of the resource.
KnownServiceType	Kubernetes Service Types supported by Listener
KnownSourceSerializationFormat	Serialization Format properties
KnownStateStoreResourceDefinitionMethods	StateStoreResourceDefinitionMethods methods allowed
KnownStateStoreResourceKeyTypes	StateStoreResourceKeyTypes properties
KnownSubscriberMessageDropStrategy	The enum defining strategies for dropping messages from the subscriber queue.
KnownTlsCertMethodMode	Broker Authentication Mode
KnownTransformationSerializationFormat	Transformation Format properties
KnownVersions	Api versions

Functions

restorePoller<TResponse, TResult>(IoTOperationsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

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.

Function Details

restorePoller<TResponse, TResult>(IoTOperationsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

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.

function restorePoller<TResponse, TResult>(client: IoTOperationsClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

IoTOperationsClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>