pulumi-azure-native-kotlin/com.pulumi.azurenative.devices.kotlin.outputs

Package-level declarations

Types

data class ArmIdentityResponse(val principalId: String, val tenantId: String, val type: String? = null, val userAssignedIdentities: Map<String, ArmUserIdentityResponse>? = null)

ArmUserIdentityResponse

data class ArmUserIdentityResponse(val clientId: String, val principalId: String)

CertificatePropertiesResponse

data class CertificatePropertiesResponse(val certificate: String? = null, val created: String, val expiry: String, val isVerified: Boolean? = null, val subject: String, val thumbprint: String, val updated: String)

The description of an X509 CA Certificate.

CloudToDevicePropertiesResponse

data class CloudToDevicePropertiesResponse(val defaultTtlAsIso8601: String? = null, val feedback: FeedbackPropertiesResponse? = null, val maxDeliveryCount: Int? = null)

The IoT hub cloud-to-device messaging properties.

EncryptionPropertiesDescriptionResponse

data class EncryptionPropertiesDescriptionResponse(val keySource: String? = null, val keyVaultProperties: List<KeyVaultKeyPropertiesResponse>? = null)

The encryption properties for the IoT hub.

EnrichmentPropertiesResponse

data class EnrichmentPropertiesResponse(val endpointNames: List<String>, val key: String, val value: String)

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

EventHubPropertiesResponse

data class EventHubPropertiesResponse(val endpoint: String, val partitionCount: Int? = null, val partitionIds: List<String>, val path: String, val retentionTimeInDays: Double? = null)

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

FallbackRoutePropertiesResponse

data class FallbackRoutePropertiesResponse(val condition: String? = null, val endpointNames: List<String>, val isEnabled: Boolean, val name: String? = null, val source: String)

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

FeedbackPropertiesResponse

data class FeedbackPropertiesResponse(val lockDurationAsIso8601: String? = null, val maxDeliveryCount: Int? = null, val ttlAsIso8601: String? = null)

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

GetCertificateResult

data class GetCertificateResult(val etag: String, val id: String, val name: String, val properties: CertificatePropertiesResponse, val type: String)

The X509 Certificate.

GetDpsCertificateResult

data class GetDpsCertificateResult(val etag: String, val id: String, val name: String, val properties: CertificatePropertiesResponse, val systemData: SystemDataResponse, val type: String)

The X509 Certificate.

GetIotDpsResourcePrivateEndpointConnectionResult

data class GetIotDpsResourcePrivateEndpointConnectionResult(val id: String, val name: String, val properties: PrivateEndpointConnectionPropertiesResponse, val systemData: SystemDataResponse, val type: String)

The private endpoint connection of a provisioning service

GetIotDpsResourceResult

data class GetIotDpsResourceResult(val etag: String? = null, val id: String, val location: String, val name: String, val properties: IotDpsPropertiesDescriptionResponse, val resourcegroup: String? = null, val sku: IotDpsSkuInfoResponse, val subscriptionid: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The description of the provisioning service.

GetIotHubResourceEventHubConsumerGroupResult

data class GetIotHubResourceEventHubConsumerGroupResult(val etag: String, val id: String, val name: String, val properties: Any, val type: String)

The properties of the EventHubConsumerGroupInfo object.

GetIotHubResourceResult

data class GetIotHubResourceResult(val etag: String? = null, val id: String, val identity: ArmIdentityResponse? = null, val location: String, val name: String, val properties: IotHubPropertiesResponse, val sku: IotHubSkuInfoResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The description of the IoT hub.

GetPrivateEndpointConnectionResult

data class GetPrivateEndpointConnectionResult(val id: String, val name: String, val properties: PrivateEndpointConnectionPropertiesResponse, val type: String)

The private endpoint connection of an IotHub

IotDpsPropertiesDescriptionResponse

data class IotDpsPropertiesDescriptionResponse(val allocationPolicy: String? = null, val authorizationPolicies: List<SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionResponse>? = null, val deviceProvisioningHostName: String, val enableDataResidency: Boolean? = null, val idScope: String, val iotHubs: List<IotHubDefinitionDescriptionResponse>? = null, val ipFilterRules: List<TargetIpFilterRuleResponse>? = null, val portalOperationsHostName: String? = null, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>? = null, val provisioningState: String? = null, val publicNetworkAccess: String? = null, val serviceOperationsHostName: String, val state: String? = null)

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

IotDpsSkuInfoResponse

data class IotDpsSkuInfoResponse(val capacity: Double? = null, val name: String? = null, val tier: String)

List of possible provisioning service SKUs.

IotHubDefinitionDescriptionResponse

data class IotHubDefinitionDescriptionResponse(val allocationWeight: Int? = null, val applyAllocationPolicy: Boolean? = null, val connectionString: String, val location: String, val name: String)

Description of the IoT hub.

IotHubLocationDescriptionResponse

data class IotHubLocationDescriptionResponse(val location: String? = null, val role: String? = null)

Public representation of one of the locations where a resource is provisioned.

IotHubPropertiesResponse

data class IotHubPropertiesResponse(val allowedFqdnList: List<String>? = null, val authorizationPolicies: List<SharedAccessSignatureAuthorizationRuleResponse>? = null, val cloudToDevice: CloudToDevicePropertiesResponse? = null, val comments: String? = null, val deviceStreams: IotHubPropertiesResponseDeviceStreams? = null, val disableDeviceSAS: Boolean? = null, val disableLocalAuth: Boolean? = null, val disableModuleSAS: Boolean? = null, val enableDataResidency: Boolean? = null, val enableFileUploadNotifications: Boolean? = null, val encryption: EncryptionPropertiesDescriptionResponse? = null, val eventHubEndpoints: Map<String, EventHubPropertiesResponse>? = null, val features: String? = null, val hostName: String, val ipFilterRules: List<IpFilterRuleResponse>? = null, val locations: List<IotHubLocationDescriptionResponse>, val messagingEndpoints: Map<String, MessagingEndpointPropertiesResponse>? = null, val minTlsVersion: String? = null, val networkRuleSets: NetworkRuleSetPropertiesResponse? = null, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>? = null, val provisioningState: String, val publicNetworkAccess: String? = null, val restrictOutboundNetworkAccess: Boolean? = null, val rootCertificate: RootCertificatePropertiesResponse? = null, val routing: RoutingPropertiesResponse? = null, val state: String, val storageEndpoints: Map<String, StorageEndpointPropertiesResponse>? = null)

The properties of an IoT hub.

IotHubPropertiesResponseDeviceStreams

data class IotHubPropertiesResponseDeviceStreams(val streamingEndpoints: List<String>? = null)

The device streams properties of iothub.

IotHubSkuInfoResponse

data class IotHubSkuInfoResponse(val capacity: Double? = null, val name: String, val tier: String)

Information about the SKU of the IoT hub.

IpFilterRuleResponse

data class IpFilterRuleResponse(val action: String, val filterName: String, val ipMask: String)

The IP filter rules for the IoT hub.

KeyVaultKeyPropertiesResponse

data class KeyVaultKeyPropertiesResponse(val identity: ManagedIdentityResponse? = null, val keyIdentifier: String? = null)

The properties of the KeyVault key.

ListIotDpsResourceKeysForKeyNameResult

data class ListIotDpsResourceKeysForKeyNameResult(val keyName: String, val primaryKey: String? = null, val rights: String, val secondaryKey: String? = null)

Description of the shared access key.

ListIotDpsResourceKeysResult

data class ListIotDpsResourceKeysResult(val nextLink: String, val value: List<SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionResponse>? = null)

List of shared access keys.

ListIotHubResourceKeysForKeyNameResult

data class ListIotHubResourceKeysForKeyNameResult(val keyName: String, val primaryKey: String? = null, val rights: String, val secondaryKey: String? = null)

The properties of an IoT hub shared access policy.

ListIotHubResourceKeysResult

data class ListIotHubResourceKeysResult(val nextLink: String, val value: List<SharedAccessSignatureAuthorizationRuleResponse>? = null)

The list of shared access policies with a next link.

ManagedIdentityResponse

data class ManagedIdentityResponse(val userAssignedIdentity: String? = null)

The properties of the Managed identity.

MessagingEndpointPropertiesResponse

data class MessagingEndpointPropertiesResponse(val lockDurationAsIso8601: String? = null, val maxDeliveryCount: Int? = null, val ttlAsIso8601: String? = null)

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

NetworkRuleSetIpRuleResponse

data class NetworkRuleSetIpRuleResponse(val action: String? = null, val filterName: String, val ipMask: String)

IP Rule to be applied as part of Network Rule Set

NetworkRuleSetPropertiesResponse

data class NetworkRuleSetPropertiesResponse(val applyToBuiltInEventHubEndpoint: Boolean, val defaultAction: String? = null, val ipRules: List<NetworkRuleSetIpRuleResponse>)

Network Rule Set Properties of IotHub

PrivateEndpointConnectionPropertiesResponse

data class PrivateEndpointConnectionPropertiesResponse(val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse)

The properties of a private endpoint connection

PrivateEndpointConnectionResponse

data class PrivateEndpointConnectionResponse(val id: String, val name: String, val properties: PrivateEndpointConnectionPropertiesResponse, val systemData: SystemDataResponse? = null, val type: String)

The private endpoint connection of an IotHub

PrivateEndpointResponse

data class PrivateEndpointResponse(val id: String)

The private endpoint property of a private endpoint connection

PrivateLinkServiceConnectionStateResponse

data class PrivateLinkServiceConnectionStateResponse(val actionsRequired: String? = null, val description: String, val status: String)

The current state of a private endpoint connection

RootCertificatePropertiesResponse

data class RootCertificatePropertiesResponse(val enableRootCertificateV2: Boolean? = null, val lastUpdatedTimeUtc: String)

This property store root certificate related information

RoutePropertiesResponse

data class RoutePropertiesResponse(val condition: String? = null, val endpointNames: List<String>, val isEnabled: Boolean, val name: String, val source: String)

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

RoutingCosmosDBSqlApiPropertiesResponse

data class RoutingCosmosDBSqlApiPropertiesResponse(val authenticationType: String? = null, val collectionName: String, val databaseName: String, val endpointUri: String, val id: String? = null, val identity: ManagedIdentityResponse? = null, val name: String, val partitionKeyName: String? = null, val partitionKeyTemplate: String? = null, val primaryKey: String? = null, val resourceGroup: String? = null, val secondaryKey: String? = null, val subscriptionId: String? = null)

The properties related to a cosmos DB sql collection endpoint.

RoutingEndpointsResponse

data class RoutingEndpointsResponse(val cosmosDBSqlCollections: List<RoutingCosmosDBSqlApiPropertiesResponse>? = null, val eventHubs: List<RoutingEventHubPropertiesResponse>? = null, val serviceBusQueues: List<RoutingServiceBusQueueEndpointPropertiesResponse>? = null, val serviceBusTopics: List<RoutingServiceBusTopicEndpointPropertiesResponse>? = null, val storageContainers: List<RoutingStorageContainerPropertiesResponse>? = null)

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.

RoutingEventHubPropertiesResponse

data class RoutingEventHubPropertiesResponse(val authenticationType: String? = null, val connectionString: String? = null, val endpointUri: String? = null, val entityPath: String? = null, val id: String? = null, val identity: ManagedIdentityResponse? = null, val name: String, val resourceGroup: String? = null, val subscriptionId: String? = null)

The properties related to an event hub endpoint.

RoutingPropertiesResponse

data class RoutingPropertiesResponse(val endpoints: RoutingEndpointsResponse? = null, val enrichments: List<EnrichmentPropertiesResponse>? = null, val fallbackRoute: FallbackRoutePropertiesResponse? = null, val routes: List<RoutePropertiesResponse>? = null)

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

RoutingServiceBusQueueEndpointPropertiesResponse

data class RoutingServiceBusQueueEndpointPropertiesResponse(val authenticationType: String? = null, val connectionString: String? = null, val endpointUri: String? = null, val entityPath: String? = null, val id: String? = null, val identity: ManagedIdentityResponse? = null, val name: String, val resourceGroup: String? = null, val subscriptionId: String? = null)

The properties related to service bus queue endpoint types.

RoutingServiceBusTopicEndpointPropertiesResponse

data class RoutingServiceBusTopicEndpointPropertiesResponse(val authenticationType: String? = null, val connectionString: String? = null, val endpointUri: String? = null, val entityPath: String? = null, val id: String? = null, val identity: ManagedIdentityResponse? = null, val name: String, val resourceGroup: String? = null, val subscriptionId: String? = null)

The properties related to service bus topic endpoint types.

RoutingStorageContainerPropertiesResponse

data class RoutingStorageContainerPropertiesResponse(val authenticationType: String? = null, val batchFrequencyInSeconds: Int? = null, val connectionString: String? = null, val containerName: String, val encoding: String? = null, val endpointUri: String? = null, val fileNameFormat: String? = null, val id: String? = null, val identity: ManagedIdentityResponse? = null, val maxChunkSizeInBytes: Int? = null, val name: String, val resourceGroup: String? = null, val subscriptionId: String? = null)

The properties related to a storage container endpoint.

SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionResponse

data class SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionResponse(val keyName: String, val primaryKey: String? = null, val rights: String, val secondaryKey: String? = null)

Description of the shared access key.

SharedAccessSignatureAuthorizationRuleResponse

data class SharedAccessSignatureAuthorizationRuleResponse(val keyName: String, val primaryKey: String? = null, val rights: String, val secondaryKey: String? = null)

The properties of an IoT hub shared access policy.

StorageEndpointPropertiesResponse

data class StorageEndpointPropertiesResponse(val authenticationType: String? = null, val connectionString: String, val containerName: String, val identity: ManagedIdentityResponse? = null, val sasTtlAsIso8601: String? = null)

The properties of the Azure Storage endpoint for file upload.

SystemDataResponse

data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

TargetIpFilterRuleResponse

data class TargetIpFilterRuleResponse(val action: String, val filterName: String, val ipMask: String, val target: String? = null)

The IP filter rules for a provisioning Service.