Package-level declarations

Types

Link copied to clipboard
data class ArmIdentityArgs(val type: Output<ResourceIdentityType>? = null, val userAssignedIdentities: Output<List<String>>? = null) : ConvertibleToJava<ArmIdentityArgs>
Link copied to clipboard
Link copied to clipboard
data class CertificatePropertiesArgs(val certificate: Output<String>? = null, val isVerified: Output<Boolean>? = null) : ConvertibleToJava<CertificatePropertiesArgs>

The description of an X509 CA Certificate.

Link copied to clipboard
data class CloudToDevicePropertiesArgs(val defaultTtlAsIso8601: Output<String>? = null, val feedback: Output<FeedbackPropertiesArgs>? = null, val maxDeliveryCount: Output<Int>? = null) : ConvertibleToJava<CloudToDevicePropertiesArgs>

The IoT hub cloud-to-device messaging properties.

Link copied to clipboard
data class EncryptionPropertiesDescriptionArgs(val keySource: Output<String>? = null, val keyVaultProperties: Output<List<KeyVaultKeyPropertiesArgs>>? = null) : ConvertibleToJava<EncryptionPropertiesDescriptionArgs>

The encryption properties for the IoT hub.

Link copied to clipboard
data class EnrichmentPropertiesArgs(val endpointNames: Output<List<String>>, val key: Output<String>, val value: Output<String>) : ConvertibleToJava<EnrichmentPropertiesArgs>

The properties of an enrichment that your IoT hub applies to messages delivered to endpoints.

Link copied to clipboard
data class EventHubConsumerGroupNameArgs(val name: Output<String>) : ConvertibleToJava<EventHubConsumerGroupNameArgs>

The EventHub consumer group name.

Link copied to clipboard
data class EventHubPropertiesArgs(val partitionCount: Output<Int>? = null, val retentionTimeInDays: Output<Double>? = null) : ConvertibleToJava<EventHubPropertiesArgs>

The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.

Link copied to clipboard
data class FallbackRoutePropertiesArgs(val condition: Output<String>? = null, val endpointNames: Output<List<String>>, val isEnabled: Output<Boolean>, val name: Output<String>? = null, val source: Output<Either<String, RoutingSource>>) : ConvertibleToJava<FallbackRoutePropertiesArgs>

The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.

Link copied to clipboard
data class FeedbackPropertiesArgs(val lockDurationAsIso8601: Output<String>? = null, val maxDeliveryCount: Output<Int>? = null, val ttlAsIso8601: Output<String>? = null) : ConvertibleToJava<FeedbackPropertiesArgs>

The properties of the feedback queue for cloud-to-device messages.

Link copied to clipboard
data class GetCertificatePlainArgs(val certificateName: String, val resourceGroupName: String, val resourceName: String) : ConvertibleToJava<GetCertificatePlainArgs>
Link copied to clipboard
data class GetDpsCertificatePlainArgs(val certificateName: String, val provisioningServiceName: String, val resourceGroupName: String) : ConvertibleToJava<GetDpsCertificatePlainArgs>
Link copied to clipboard
data class GetIotDpsResourcePlainArgs(val provisioningServiceName: String, val resourceGroupName: String) : ConvertibleToJava<GetIotDpsResourcePlainArgs>
data class GetIotDpsResourcePrivateEndpointConnectionPlainArgs(val privateEndpointConnectionName: String, val resourceGroupName: String, val resourceName: String) : ConvertibleToJava<GetIotDpsResourcePrivateEndpointConnectionPlainArgs>
data class GetIotHubResourceEventHubConsumerGroupPlainArgs(val eventHubEndpointName: String, val name: String, val resourceGroupName: String, val resourceName: String) : ConvertibleToJava<GetIotHubResourceEventHubConsumerGroupPlainArgs>
Link copied to clipboard
data class GetIotHubResourcePlainArgs(val resourceGroupName: String, val resourceName: String) : ConvertibleToJava<GetIotHubResourcePlainArgs>
Link copied to clipboard
data class GetPrivateEndpointConnectionPlainArgs(val privateEndpointConnectionName: String, val resourceGroupName: String, val resourceName: String) : ConvertibleToJava<GetPrivateEndpointConnectionPlainArgs>
Link copied to clipboard
data class IotDpsPropertiesDescriptionArgs(val allocationPolicy: Output<Either<String, AllocationPolicy>>? = null, val authorizationPolicies: Output<List<SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionArgs>>? = null, val enableDataResidency: Output<Boolean>? = null, val iotHubs: Output<List<IotHubDefinitionDescriptionArgs>>? = null, val ipFilterRules: Output<List<TargetIpFilterRuleArgs>>? = null, val portalOperationsHostName: Output<String>? = null, val privateEndpointConnections: Output<List<PrivateEndpointConnectionArgs>>? = null, val provisioningState: Output<String>? = null, val publicNetworkAccess: Output<Either<String, PublicNetworkAccess>>? = null, val state: Output<Either<String, State>>? = null) : ConvertibleToJava<IotDpsPropertiesDescriptionArgs>

the service specific properties of a provisioning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope

Link copied to clipboard
data class IotDpsSkuInfoArgs(val capacity: Output<Double>? = null, val name: Output<Either<String, IotDpsSku>>? = null) : ConvertibleToJava<IotDpsSkuInfoArgs>

List of possible provisioning service SKUs.

Link copied to clipboard
Link copied to clipboard
data class IotHubDefinitionDescriptionArgs(val allocationWeight: Output<Int>? = null, val applyAllocationPolicy: Output<Boolean>? = null, val connectionString: Output<String>, val location: Output<String>) : ConvertibleToJava<IotHubDefinitionDescriptionArgs>

Description of the IoT hub.

Link copied to clipboard
data class IotHubPropertiesArgs(val allowedFqdnList: Output<List<String>>? = null, val authorizationPolicies: Output<List<SharedAccessSignatureAuthorizationRuleArgs>>? = null, val cloudToDevice: Output<CloudToDevicePropertiesArgs>? = null, val comments: Output<String>? = null, val deviceStreams: Output<IotHubPropertiesDeviceStreamsArgs>? = null, val disableDeviceSAS: Output<Boolean>? = null, val disableLocalAuth: Output<Boolean>? = null, val disableModuleSAS: Output<Boolean>? = null, val enableDataResidency: Output<Boolean>? = null, val enableFileUploadNotifications: Output<Boolean>? = null, val encryption: Output<EncryptionPropertiesDescriptionArgs>? = null, val eventHubEndpoints: Output<Map<String, EventHubPropertiesArgs>>? = null, val features: Output<Either<String, Capabilities>>? = null, val ipFilterRules: Output<List<IpFilterRuleArgs>>? = null, val messagingEndpoints: Output<Map<String, MessagingEndpointPropertiesArgs>>? = null, val minTlsVersion: Output<String>? = null, val networkRuleSets: Output<NetworkRuleSetPropertiesArgs>? = null, val privateEndpointConnections: Output<List<PrivateEndpointConnectionArgs>>? = null, val publicNetworkAccess: Output<Either<String, PublicNetworkAccess>>? = null, val restrictOutboundNetworkAccess: Output<Boolean>? = null, val rootCertificate: Output<RootCertificatePropertiesArgs>? = null, val routing: Output<RoutingPropertiesArgs>? = null, val storageEndpoints: Output<Map<String, StorageEndpointPropertiesArgs>>? = null) : ConvertibleToJava<IotHubPropertiesArgs>

The properties of an IoT hub.

Link copied to clipboard
data class IotHubPropertiesDeviceStreamsArgs(val streamingEndpoints: Output<List<String>>? = null) : ConvertibleToJava<IotHubPropertiesDeviceStreamsArgs>

The device streams properties of iothub.

Link copied to clipboard
data class IotHubSkuInfoArgs(val capacity: Output<Double>? = null, val name: Output<Either<String, IotHubSku>>) : ConvertibleToJava<IotHubSkuInfoArgs>

Information about the SKU of the IoT hub.

Link copied to clipboard
Link copied to clipboard
data class IpFilterRuleArgs(val action: Output<IpFilterActionType>, val filterName: Output<String>, val ipMask: Output<String>) : ConvertibleToJava<IpFilterRuleArgs>

The IP filter rules for the IoT hub.

Link copied to clipboard
Link copied to clipboard
data class KeyVaultKeyPropertiesArgs(val identity: Output<ManagedIdentityArgs>? = null, val keyIdentifier: Output<String>? = null) : ConvertibleToJava<KeyVaultKeyPropertiesArgs>

The properties of the KeyVault key.

data class ListIotDpsResourceKeysForKeyNamePlainArgs(val keyName: String, val provisioningServiceName: String, val resourceGroupName: String) : ConvertibleToJava<ListIotDpsResourceKeysForKeyNamePlainArgs>
Link copied to clipboard
data class ListIotDpsResourceKeysPlainArgs(val provisioningServiceName: String, val resourceGroupName: String) : ConvertibleToJava<ListIotDpsResourceKeysPlainArgs>
data class ListIotHubResourceKeysForKeyNamePlainArgs(val keyName: String, val resourceGroupName: String, val resourceName: String) : ConvertibleToJava<ListIotHubResourceKeysForKeyNamePlainArgs>
Link copied to clipboard
data class ListIotHubResourceKeysPlainArgs(val resourceGroupName: String, val resourceName: String) : ConvertibleToJava<ListIotHubResourceKeysPlainArgs>
Link copied to clipboard
data class ManagedIdentityArgs(val userAssignedIdentity: Output<String>? = null) : ConvertibleToJava<ManagedIdentityArgs>

The properties of the Managed identity.

Link copied to clipboard
data class MessagingEndpointPropertiesArgs(val lockDurationAsIso8601: Output<String>? = null, val maxDeliveryCount: Output<Int>? = null, val ttlAsIso8601: Output<String>? = null) : ConvertibleToJava<MessagingEndpointPropertiesArgs>

The properties of the messaging endpoints used by this IoT hub.

Link copied to clipboard
data class NetworkRuleSetIpRuleArgs(val action: Output<Either<String, NetworkRuleIPAction>>? = null, val filterName: Output<String>, val ipMask: Output<String>) : ConvertibleToJava<NetworkRuleSetIpRuleArgs>

IP Rule to be applied as part of Network Rule Set

Link copied to clipboard
data class NetworkRuleSetPropertiesArgs(val applyToBuiltInEventHubEndpoint: Output<Boolean>, val defaultAction: Output<Either<String, DefaultAction>>? = null, val ipRules: Output<List<NetworkRuleSetIpRuleArgs>>) : ConvertibleToJava<NetworkRuleSetPropertiesArgs>

Network Rule Set Properties of IotHub

Link copied to clipboard
data class PrivateEndpointConnectionArgs(val properties: Output<PrivateEndpointConnectionPropertiesArgs>) : ConvertibleToJava<PrivateEndpointConnectionArgs>

The private endpoint connection of an IotHub

Link copied to clipboard
data class PrivateEndpointConnectionPropertiesArgs(val privateLinkServiceConnectionState: Output<PrivateLinkServiceConnectionStateArgs>) : ConvertibleToJava<PrivateEndpointConnectionPropertiesArgs>

The properties of a private endpoint connection

Link copied to clipboard
data class PrivateLinkServiceConnectionStateArgs(val actionsRequired: Output<String>? = null, val description: Output<String>, val status: Output<Either<String, PrivateLinkServiceConnectionStatus>>) : ConvertibleToJava<PrivateLinkServiceConnectionStateArgs>

The current state of a private endpoint connection

Link copied to clipboard
data class RootCertificatePropertiesArgs(val enableRootCertificateV2: Output<Boolean>? = null) : ConvertibleToJava<RootCertificatePropertiesArgs>

This property store root certificate related information

Link copied to clipboard
data class RoutePropertiesArgs(val condition: Output<String>? = null, val endpointNames: Output<List<String>>, val isEnabled: Output<Boolean>, val name: Output<String>, val source: Output<Either<String, RoutingSource>>) : ConvertibleToJava<RoutePropertiesArgs>

The properties of a routing rule that your IoT hub uses to route messages to endpoints.

Link copied to clipboard
data class RoutingCosmosDBSqlApiPropertiesArgs(val authenticationType: Output<Either<String, AuthenticationType>>? = null, val collectionName: Output<String>, val databaseName: Output<String>, val endpointUri: Output<String>, val id: Output<String>? = null, val identity: Output<ManagedIdentityArgs>? = null, val name: Output<String>, val partitionKeyName: Output<String>? = null, val partitionKeyTemplate: Output<String>? = null, val primaryKey: Output<String>? = null, val resourceGroup: Output<String>? = null, val secondaryKey: Output<String>? = null, val subscriptionId: Output<String>? = null) : ConvertibleToJava<RoutingCosmosDBSqlApiPropertiesArgs>

The properties related to a cosmos DB sql collection endpoint.

Link copied to clipboard
data class RoutingEndpointsArgs(val cosmosDBSqlCollections: Output<List<RoutingCosmosDBSqlApiPropertiesArgs>>? = null, val eventHubs: Output<List<RoutingEventHubPropertiesArgs>>? = null, val serviceBusQueues: Output<List<RoutingServiceBusQueueEndpointPropertiesArgs>>? = null, val serviceBusTopics: Output<List<RoutingServiceBusTopicEndpointPropertiesArgs>>? = null, val storageContainers: Output<List<RoutingStorageContainerPropertiesArgs>>? = null) : ConvertibleToJava<RoutingEndpointsArgs>

The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.

Link copied to clipboard
data class RoutingEventHubPropertiesArgs(val authenticationType: Output<Either<String, AuthenticationType>>? = null, val connectionString: Output<String>? = null, val endpointUri: Output<String>? = null, val entityPath: Output<String>? = null, val id: Output<String>? = null, val identity: Output<ManagedIdentityArgs>? = null, val name: Output<String>, val resourceGroup: Output<String>? = null, val subscriptionId: Output<String>? = null) : ConvertibleToJava<RoutingEventHubPropertiesArgs>

The properties related to an event hub endpoint.

Link copied to clipboard
data class RoutingPropertiesArgs(val endpoints: Output<RoutingEndpointsArgs>? = null, val enrichments: Output<List<EnrichmentPropertiesArgs>>? = null, val fallbackRoute: Output<FallbackRoutePropertiesArgs>? = null, val routes: Output<List<RoutePropertiesArgs>>? = null) : ConvertibleToJava<RoutingPropertiesArgs>

The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

data class RoutingServiceBusQueueEndpointPropertiesArgs(val authenticationType: Output<Either<String, AuthenticationType>>? = null, val connectionString: Output<String>? = null, val endpointUri: Output<String>? = null, val entityPath: Output<String>? = null, val id: Output<String>? = null, val identity: Output<ManagedIdentityArgs>? = null, val name: Output<String>, val resourceGroup: Output<String>? = null, val subscriptionId: Output<String>? = null) : ConvertibleToJava<RoutingServiceBusQueueEndpointPropertiesArgs>

The properties related to service bus queue endpoint types.

data class RoutingServiceBusTopicEndpointPropertiesArgs(val authenticationType: Output<Either<String, AuthenticationType>>? = null, val connectionString: Output<String>? = null, val endpointUri: Output<String>? = null, val entityPath: Output<String>? = null, val id: Output<String>? = null, val identity: Output<ManagedIdentityArgs>? = null, val name: Output<String>, val resourceGroup: Output<String>? = null, val subscriptionId: Output<String>? = null) : ConvertibleToJava<RoutingServiceBusTopicEndpointPropertiesArgs>

The properties related to service bus topic endpoint types.

Link copied to clipboard
data class RoutingStorageContainerPropertiesArgs(val authenticationType: Output<Either<String, AuthenticationType>>? = null, val batchFrequencyInSeconds: Output<Int>? = null, val connectionString: Output<String>? = null, val containerName: Output<String>, val encoding: Output<String>? = null, val endpointUri: Output<String>? = null, val fileNameFormat: Output<String>? = null, val id: Output<String>? = null, val identity: Output<ManagedIdentityArgs>? = null, val maxChunkSizeInBytes: Output<Int>? = null, val name: Output<String>, val resourceGroup: Output<String>? = null, val subscriptionId: Output<String>? = null) : ConvertibleToJava<RoutingStorageContainerPropertiesArgs>

The properties related to a storage container endpoint.

data class SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionArgs(val keyName: Output<String>, val primaryKey: Output<String>? = null, val rights: Output<Either<String, AccessRightsDescription>>, val secondaryKey: Output<String>? = null) : ConvertibleToJava<SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionArgs>

Description of the shared access key.

data class SharedAccessSignatureAuthorizationRuleArgs(val keyName: Output<String>, val primaryKey: Output<String>? = null, val rights: Output<AccessRights>, val secondaryKey: Output<String>? = null) : ConvertibleToJava<SharedAccessSignatureAuthorizationRuleArgs>

The properties of an IoT hub shared access policy.

Link copied to clipboard
data class StorageEndpointPropertiesArgs(val authenticationType: Output<Either<String, AuthenticationType>>? = null, val connectionString: Output<String>, val containerName: Output<String>, val identity: Output<ManagedIdentityArgs>? = null, val sasTtlAsIso8601: Output<String>? = null) : ConvertibleToJava<StorageEndpointPropertiesArgs>

The properties of the Azure Storage endpoint for file upload.

Link copied to clipboard
data class TargetIpFilterRuleArgs(val action: Output<IpFilterActionType>, val filterName: Output<String>, val ipMask: Output<String>, val target: Output<IpFilterTargetType>? = null) : ConvertibleToJava<TargetIpFilterRuleArgs>

The IP filter rules for a provisioning Service.