@azure/arm-iotoperations package
Classes
| IoTOperationsClient |
Interfaces
| AdvancedSettings |
Broker Advanced Settings |
| AuthorizationConfig |
Broker AuthorizationConfig properties |
| AuthorizationRule |
AuthorizationConfig Rule Properties |
| 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. |
| 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. |
| 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. |
| DataflowDestinationOperationSettings |
Dataflow Destination Operation properties |
| DataflowEndpointAuthenticationAccessToken |
DataflowEndpoint Authentication Access Token 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. |
| 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. |
| DataflowListByResourceGroupOptionalParams |
Optional parameters. |
| 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 |
| DataflowProperties |
Dataflow Resource properties |
| DataflowResource |
Instance dataflowProfile dataflow resource |
| DataflowSourceOperationSettings |
Dataflow Source Operation properties |
| DiagnosticsLogs |
Diagnostic Log properties |
| DiskBackedMessageBuffer |
DiskBackedMessageBuffer properties |
| 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. |
| 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 |
| 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 and 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 |
| Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
| RestorePollerOptions | |
| SanForCert |
Subject Alternative Names (SANs) for certificate. |
| SchemaRegistryRef |
The reference to the Schema Registry for this AIO Instance. |
| 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 |
| VolumeClaimSpec |
VolumeClaimSpec properties |
| VolumeClaimSpecSelector |
VolumeClaimSpecSelector properties |
| VolumeClaimSpecSelectorMatchExpressions |
VolumeClaimSpecSelectorMatchExpressions properties |
| X509ManualCertificate |
X509 Certificate Authentication properties. |
Type Aliases
| AccessTokenMethod |
Access Token Method Known values supported by the serviceAccessToken: AccessToken Option |
| ActionType |
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. Known values supported by the serviceInternal: Actions are for internal-only APIs. |
| AnonymousMethod |
x509 Certificate Method Known values supported by the serviceAnonymous: Anonymous Option |
| BrokerAuthenticationMethod |
Broker Authentication Mode Known values supported by the serviceCustom: Custom authentication configuration. |
| BrokerMemoryProfile |
The memory profile settings of the Broker Known values supported by the serviceTiny: Tiny memory profile. |
| BrokerProtocolType |
Broker Protocol types Known values supported by the serviceMqtt: protocol broker |
| BrokerResourceDefinitionMethods |
BrokerResourceDefinitionMethods methods allowed Known values supported by the serviceConnect: Allowed Connecting to Broker |
| CertManagerIssuerKind |
CertManagerIssuerKind properties Known values supported by the serviceIssuer: Issuer kind. |
| CloudEventAttributeType |
How to map events to the cloud. Known values supported by the servicePropagate: Propagate type |
| ContinuablePage |
An interface that describes a page of results. |
| CreatedByType |
The kind of entity that created the resource. Known values supported by the serviceUser: The entity was created by a user. |
| DataExplorerAuthMethod |
Alias for DataExplorerAuthMethod |
| DataLakeStorageAuthMethod |
Alias for DataLakeStorageAuthMethod |
| DataflowEndpointAuthenticationSaslType |
DataflowEndpoint Authentication Sasl Type properties Known values supported by the servicePlain: PLAIN Type |
| DataflowEndpointFabricPathType |
DataflowEndpoint Fabric Path Type properties Known values supported by the serviceFiles: FILES Type |
| DataflowEndpointKafkaAcks |
DataflowEndpoint Kafka Acks properties Known values supported by the serviceZero: ZERO Option |
| DataflowEndpointKafkaCompression |
Kafka endpoint Compression properties Known values supported by the serviceNone: NONE Option |
| DataflowEndpointKafkaPartitionStrategy |
DataflowEndpoint Kafka Partition Strategy properties Known values supported by the serviceDefault: Default: Assigns messages to random partitions, using a round-robin algorithm. |
| DataflowMappingType |
Dataflow type mapping properties Known values supported by the serviceNewProperties: New Properties type |
| EndpointType |
DataflowEndpoint Type properties Known values supported by the serviceDataExplorer: Azure Data Explorer Type |
| ExtendedLocationType |
The enum defining type of ExtendedLocation accepted. Known values supported by the serviceCustomLocation: CustomLocation type |
| FabricOneLakeAuthMethod |
Alias for FabricOneLakeAuthMethod |
| FilterType |
Filter Type properties Known values supported by the serviceFilter: Filter type |
| KafkaAuthMethod |
Alias for KafkaAuthMethod |
| ManagedIdentityMethod |
Managed Identity Method Known values supported by the serviceSystemAssignedManagedIdentity: SystemAssignedManagedIdentity type |
| ManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Known values supported by the serviceNone: No managed identity. |
| MqttAuthMethod |
Alias for MqttAuthMethod |
| MqttRetainType |
Broker Retain types Known values supported by the serviceKeep: Retain the messages. |
| OperationType |
Dataflow Operation Type properties Known values supported by the serviceSource: Dataflow Source Operation |
| OperationalMode |
Mode properties Known values supported by the serviceEnabled: Enabled is equivalent to True |
| OperatorValues |
Valid operators are In, NotIn, Exists and DoesNotExist. Known values supported by the serviceIn: In operator. |
| Origin |
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" Known values supported by the serviceuser: Indicates the operation is initiated by a user. |
| PrivateKeyAlgorithm |
Private key algorithm types. Known values supported by the serviceEc256: Algorithm - ec256. |
| PrivateKeyRotationPolicy |
Private key rotation policy. Known values supported by the serviceAlways: Rotation Policy - Always. |
| ProvisioningState |
The provisioning state of a resource type. Known values supported by the serviceSucceeded: Resource has been created. |
| SaslMethod |
Sasl Method Known values supported by the serviceSasl: Sasl Option |
| ServiceAccountTokenMethod |
Service Account Token Method Known values supported by the serviceServiceAccountToken: ServiceAccountToken Option |
| ServiceType |
Kubernetes Service Types supported by Listener Known values supported by the serviceClusterIp: Cluster IP Service. |
| SourceSerializationFormat |
Serialization Format properties Known values supported by the serviceJson: JSON Format |
| StateStoreResourceDefinitionMethods |
StateStoreResourceDefinitionMethods methods allowed Known values supported by the serviceRead: Get/KeyNotify from Store |
| StateStoreResourceKeyTypes |
StateStoreResourceKeyTypes properties Known values supported by the servicePattern: Key type - pattern |
| SubscriberMessageDropStrategy |
The enum defining strategies for dropping messages from the subscriber queue. Known values supported by the serviceNone: Messages are never dropped. |
| TlsCertMethodMode |
Broker Authentication Mode Known values supported by the serviceAutomatic: Automatic TLS server certificate configuration. |
| TransformationSerializationFormat |
Transformation Format properties Known values supported by the serviceDelta: Delta Format |
| X509CertificateMethod |
x509 Certificate Method Known values supported by the serviceX509Certificate: x509Certificate Option |
Enums
| KnownAccessTokenMethod |
Access Token Method |
| KnownActionType |
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. |
| KnownAnonymousMethod |
x509 Certificate Method |
| KnownBrokerAuthenticationMethod |
Broker Authentication Mode |
| KnownBrokerMemoryProfile |
The memory profile settings of the Broker |
| KnownBrokerProtocolType |
Broker Protocol types |
| KnownBrokerResourceDefinitionMethods |
BrokerResourceDefinitionMethods methods allowed |
| KnownCertManagerIssuerKind |
CertManagerIssuerKind properties |
| KnownCloudEventAttributeType |
How to map events to the cloud. |
| KnownCreatedByType |
The kind of entity that created the resource. |
| KnownDataflowEndpointAuthenticationSaslType |
DataflowEndpoint Authentication Sasl Type properties |
| KnownDataflowEndpointFabricPathType |
DataflowEndpoint Fabric Path Type properties |
| KnownDataflowEndpointKafkaAcks |
DataflowEndpoint Kafka Acks properties |
| KnownDataflowEndpointKafkaCompression |
Kafka endpoint Compression properties |
| KnownDataflowEndpointKafkaPartitionStrategy |
DataflowEndpoint Kafka Partition Strategy properties |
| KnownDataflowMappingType |
Dataflow type mapping properties |
| KnownEndpointType |
DataflowEndpoint Type properties |
| KnownExtendedLocationType |
The enum defining type of ExtendedLocation accepted. |
| KnownFilterType |
Filter Type properties |
| KnownManagedIdentityMethod |
Managed Identity Method |
| KnownManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
| 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 provisioning state of a resource type. |
| KnownSaslMethod |
Sasl Method |
| KnownServiceAccountTokenMethod |
Service Account Token Method |
| 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 |
| KnownX509CertificateMethod |
x509 Certificate Method |
Functions
| restore |
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>