Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. healthcareapis
  5. getIotConnector
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.healthcareapis.getIotConnector

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the properties of the specified IoT Connector.

Uses Azure REST API version 2024-03-31.

Other available API versions: 2022-10-01-preview, 2022-12-01, 2023-02-28, 2023-09-06, 2023-11-01, 2023-12-01, 2024-03-01, 2025-03-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native healthcareapis [ApiVersion]. See the version guide for details.

Using getIotConnector

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getIotConnector(args: GetIotConnectorArgs, opts?: InvokeOptions): Promise<GetIotConnectorResult>
function getIotConnectorOutput(args: GetIotConnectorOutputArgs, opts?: InvokeOptions): Output<GetIotConnectorResult>
Copy
def get_iot_connector(iot_connector_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      workspace_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetIotConnectorResult
def get_iot_connector_output(iot_connector_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      workspace_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetIotConnectorResult]
Copy
func LookupIotConnector(ctx *Context, args *LookupIotConnectorArgs, opts ...InvokeOption) (*LookupIotConnectorResult, error)
func LookupIotConnectorOutput(ctx *Context, args *LookupIotConnectorOutputArgs, opts ...InvokeOption) LookupIotConnectorResultOutput
Copy

> Note: This function is named LookupIotConnector in the Go SDK.

public static class GetIotConnector 
{
    public static Task<GetIotConnectorResult> InvokeAsync(GetIotConnectorArgs args, InvokeOptions? opts = null)
    public static Output<GetIotConnectorResult> Invoke(GetIotConnectorInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIotConnectorResult> getIotConnector(GetIotConnectorArgs args, InvokeOptions options)
public static Output<GetIotConnectorResult> getIotConnector(GetIotConnectorArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:healthcareapis:getIotConnector
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

IotConnectorName
This property is required.
Changes to this property will trigger replacement.
string
The name of IoT Connector resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the service instance.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of workspace resource.
IotConnectorName
This property is required.
Changes to this property will trigger replacement.
string
The name of IoT Connector resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the service instance.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of workspace resource.
iotConnectorName
This property is required.
Changes to this property will trigger replacement.
String
The name of IoT Connector resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the service instance.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of workspace resource.
iotConnectorName
This property is required.
Changes to this property will trigger replacement.
string
The name of IoT Connector resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the service instance.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of workspace resource.
iot_connector_name
This property is required.
Changes to this property will trigger replacement.
str
The name of IoT Connector resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the service instance.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of workspace resource.
iotConnectorName
This property is required.
Changes to this property will trigger replacement.
String
The name of IoT Connector resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the service instance.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of workspace resource.

getIotConnector Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
The resource identifier.
Name string
The resource name.
ProvisioningState string
The provisioning state.
SystemData Pulumi.AzureNative.HealthcareApis.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The resource type.
DeviceMapping Pulumi.AzureNative.HealthcareApis.Outputs.IotMappingPropertiesResponse
Device Mappings.
Etag string
An etag associated with the resource, used for optimistic concurrency when editing it.
Identity Pulumi.AzureNative.HealthcareApis.Outputs.ServiceManagedIdentityResponseIdentity
Setting indicating whether the service has a managed identity associated with it.
IngestionEndpointConfiguration Pulumi.AzureNative.HealthcareApis.Outputs.IotEventHubIngestionEndpointConfigurationResponse
Source configuration.
Location string
The resource location.
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
Id string
The resource identifier.
Name string
The resource name.
ProvisioningState string
The provisioning state.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The resource type.
DeviceMapping IotMappingPropertiesResponse
Device Mappings.
Etag string
An etag associated with the resource, used for optimistic concurrency when editing it.
Identity ServiceManagedIdentityResponseIdentity
Setting indicating whether the service has a managed identity associated with it.
IngestionEndpointConfiguration IotEventHubIngestionEndpointConfigurationResponse
Source configuration.
Location string
The resource location.
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
The resource identifier.
name String
The resource name.
provisioningState String
The provisioning state.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The resource type.
deviceMapping IotMappingPropertiesResponse
Device Mappings.
etag String
An etag associated with the resource, used for optimistic concurrency when editing it.
identity ServiceManagedIdentityResponseIdentity
Setting indicating whether the service has a managed identity associated with it.
ingestionEndpointConfiguration IotEventHubIngestionEndpointConfigurationResponse
Source configuration.
location String
The resource location.
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
id string
The resource identifier.
name string
The resource name.
provisioningState string
The provisioning state.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The resource type.
deviceMapping IotMappingPropertiesResponse
Device Mappings.
etag string
An etag associated with the resource, used for optimistic concurrency when editing it.
identity ServiceManagedIdentityResponseIdentity
Setting indicating whether the service has a managed identity associated with it.
ingestionEndpointConfiguration IotEventHubIngestionEndpointConfigurationResponse
Source configuration.
location string
The resource location.
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
id str
The resource identifier.
name str
The resource name.
provisioning_state str
The provisioning state.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The resource type.
device_mapping IotMappingPropertiesResponse
Device Mappings.
etag str
An etag associated with the resource, used for optimistic concurrency when editing it.
identity ServiceManagedIdentityResponseIdentity
Setting indicating whether the service has a managed identity associated with it.
ingestion_endpoint_configuration IotEventHubIngestionEndpointConfigurationResponse
Source configuration.
location str
The resource location.
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
The resource identifier.
name String
The resource name.
provisioningState String
The provisioning state.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The resource type.
deviceMapping Property Map
Device Mappings.
etag String
An etag associated with the resource, used for optimistic concurrency when editing it.
identity Property Map
Setting indicating whether the service has a managed identity associated with it.
ingestionEndpointConfiguration Property Map
Source configuration.
location String
The resource location.
tags Map<String>
Resource tags.

Supporting Types

IotEventHubIngestionEndpointConfigurationResponse

ConsumerGroup string
Consumer group of the event hub to connected to.
EventHubName string
Event Hub name to connect to.
FullyQualifiedEventHubNamespace string
Fully qualified namespace of the Event Hub to connect to.
ConsumerGroup string
Consumer group of the event hub to connected to.
EventHubName string
Event Hub name to connect to.
FullyQualifiedEventHubNamespace string
Fully qualified namespace of the Event Hub to connect to.
consumerGroup String
Consumer group of the event hub to connected to.
eventHubName String
Event Hub name to connect to.
fullyQualifiedEventHubNamespace String
Fully qualified namespace of the Event Hub to connect to.
consumerGroup string
Consumer group of the event hub to connected to.
eventHubName string
Event Hub name to connect to.
fullyQualifiedEventHubNamespace string
Fully qualified namespace of the Event Hub to connect to.
consumer_group str
Consumer group of the event hub to connected to.
event_hub_name str
Event Hub name to connect to.
fully_qualified_event_hub_namespace str
Fully qualified namespace of the Event Hub to connect to.
consumerGroup String
Consumer group of the event hub to connected to.
eventHubName String
Event Hub name to connect to.
fullyQualifiedEventHubNamespace String
Fully qualified namespace of the Event Hub to connect to.

IotMappingPropertiesResponse

Content object
The mapping.
Content interface{}
The mapping.
content Object
The mapping.
content any
The mapping.
content Any
The mapping.
content Any
The mapping.

ServiceManagedIdentityResponseIdentity

PrincipalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type This property is required. string
Type of identity being specified, currently SystemAssigned and None are allowed.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.HealthcareApis.Inputs.UserAssignedIdentityResponse>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
PrincipalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type This property is required. string
Type of identity being specified, currently SystemAssigned and None are allowed.
UserAssignedIdentities map[string]UserAssignedIdentityResponse
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. String
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. String
Type of identity being specified, currently SystemAssigned and None are allowed.
userAssignedIdentities Map<String,UserAssignedIdentityResponse>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. string
Type of identity being specified, currently SystemAssigned and None are allowed.
userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principal_id This property is required. str
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id This property is required. str
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. str
Type of identity being specified, currently SystemAssigned and None are allowed.
user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. String
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. String
Type of identity being specified, currently SystemAssigned and None are allowed.
userAssignedIdentities Map<Property Map>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

UserAssignedIdentityResponse

ClientId This property is required. string
The client ID of the assigned identity.
PrincipalId This property is required. string
The principal ID of the assigned identity.
ClientId This property is required. string
The client ID of the assigned identity.
PrincipalId This property is required. string
The principal ID of the assigned identity.
clientId This property is required. String
The client ID of the assigned identity.
principalId This property is required. String
The principal ID of the assigned identity.
clientId This property is required. string
The client ID of the assigned identity.
principalId This property is required. string
The principal ID of the assigned identity.
client_id This property is required. str
The client ID of the assigned identity.
principal_id This property is required. str
The principal ID of the assigned identity.
clientId This property is required. String
The client ID of the assigned identity.
principalId This property is required. String
The principal ID of the assigned identity.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native