azure-native.healthcareapis.getIotConnector
Explore with Pulumi AI
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>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]func LookupIotConnector(ctx *Context, args *LookupIotConnectorArgs, opts ...InvokeOption) (*LookupIotConnectorResult, error)
func LookupIotConnectorOutput(ctx *Context, args *LookupIotConnectorOutputArgs, opts ...InvokeOption) LookupIotConnectorResultOutput> 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)
}public static CompletableFuture<GetIotConnectorResult> getIotConnector(GetIotConnectorArgs args, InvokeOptions options)
public static Output<GetIotConnectorResult> getIotConnector(GetIotConnectorArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:healthcareapis:getIotConnector
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Iot
Connector stringName  - The name of IoT Connector resource.
 - Resource
Group stringName  - The name of the resource group that contains the service instance.
 - Workspace
Name string - The name of workspace resource.
 
- Iot
Connector stringName  - The name of IoT Connector resource.
 - Resource
Group stringName  - The name of the resource group that contains the service instance.
 - Workspace
Name string - The name of workspace resource.
 
- iot
Connector StringName  - The name of IoT Connector resource.
 - resource
Group StringName  - The name of the resource group that contains the service instance.
 - workspace
Name String - The name of workspace resource.
 
- iot
Connector stringName  - The name of IoT Connector resource.
 - resource
Group stringName  - The name of the resource group that contains the service instance.
 - workspace
Name string - The name of workspace resource.
 
- iot_
connector_ strname  - The name of IoT Connector resource.
 - resource_
group_ strname  - The name of the resource group that contains the service instance.
 - workspace_
name str - The name of workspace resource.
 
- iot
Connector StringName  - The name of IoT Connector resource.
 - resource
Group StringName  - The name of the resource group that contains the service instance.
 - workspace
Name String - The name of workspace resource.
 
getIotConnector Result
The following output properties are available:
- Azure
Api stringVersion  - The Azure API version of the resource.
 - Id string
 - The resource identifier.
 - Name string
 - The resource name.
 - Provisioning
State string - The provisioning state.
 - System
Data Pulumi.Azure Native. Healthcare Apis. Outputs. System Data Response  - Metadata pertaining to creation and last modification of the resource.
 - Type string
 - The resource type.
 - Device
Mapping Pulumi.Azure Native. Healthcare Apis. Outputs. Iot Mapping Properties Response  - Device Mappings.
 - Etag string
 - An etag associated with the resource, used for optimistic concurrency when editing it.
 - Identity
Pulumi.
Azure Native. Healthcare Apis. Outputs. Service Managed Identity Response Identity  - Setting indicating whether the service has a managed identity associated with it.
 - Ingestion
Endpoint Pulumi.Configuration Azure Native. Healthcare Apis. Outputs. Iot Event Hub Ingestion Endpoint Configuration Response  - Source configuration.
 - Location string
 - The resource location.
 - Dictionary<string, string>
 - Resource tags.
 
- Azure
Api stringVersion  - The Azure API version of the resource.
 - Id string
 - The resource identifier.
 - Name string
 - The resource name.
 - Provisioning
State string - The provisioning state.
 - System
Data SystemData Response  - Metadata pertaining to creation and last modification of the resource.
 - Type string
 - The resource type.
 - Device
Mapping IotMapping Properties Response  - Device Mappings.
 - Etag string
 - An etag associated with the resource, used for optimistic concurrency when editing it.
 - Identity
Service
Managed Identity Response Identity  - Setting indicating whether the service has a managed identity associated with it.
 - Ingestion
Endpoint IotConfiguration Event Hub Ingestion Endpoint Configuration Response  - Source configuration.
 - Location string
 - The resource location.
 - map[string]string
 - Resource tags.
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - id String
 - The resource identifier.
 - name String
 - The resource name.
 - provisioning
State String - The provisioning state.
 - system
Data SystemData Response  - Metadata pertaining to creation and last modification of the resource.
 - type String
 - The resource type.
 - device
Mapping IotMapping Properties Response  - Device Mappings.
 - etag String
 - An etag associated with the resource, used for optimistic concurrency when editing it.
 - identity
Service
Managed Identity Response Identity  - Setting indicating whether the service has a managed identity associated with it.
 - ingestion
Endpoint IotConfiguration Event Hub Ingestion Endpoint Configuration Response  - Source configuration.
 - location String
 - The resource location.
 - Map<String,String>
 - Resource tags.
 
- azure
Api stringVersion  - The Azure API version of the resource.
 - id string
 - The resource identifier.
 - name string
 - The resource name.
 - provisioning
State string - The provisioning state.
 - system
Data SystemData Response  - Metadata pertaining to creation and last modification of the resource.
 - type string
 - The resource type.
 - device
Mapping IotMapping Properties Response  - Device Mappings.
 - etag string
 - An etag associated with the resource, used for optimistic concurrency when editing it.
 - identity
Service
Managed Identity Response Identity  - Setting indicating whether the service has a managed identity associated with it.
 - ingestion
Endpoint IotConfiguration Event Hub Ingestion Endpoint Configuration Response  - Source configuration.
 - location string
 - The resource location.
 - {[key: string]: string}
 - Resource tags.
 
- azure_
api_ strversion  - 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 SystemData Response  - Metadata pertaining to creation and last modification of the resource.
 - type str
 - The resource type.
 - device_
mapping IotMapping Properties Response  - Device Mappings.
 - etag str
 - An etag associated with the resource, used for optimistic concurrency when editing it.
 - identity
Service
Managed Identity Response Identity  - Setting indicating whether the service has a managed identity associated with it.
 - ingestion_
endpoint_ Iotconfiguration Event Hub Ingestion Endpoint Configuration Response  - Source configuration.
 - location str
 - The resource location.
 - Mapping[str, str]
 - Resource tags.
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - id String
 - The resource identifier.
 - name String
 - The resource name.
 - provisioning
State String - The provisioning state.
 - system
Data Property Map - Metadata pertaining to creation and last modification of the resource.
 - type String
 - The resource type.
 - device
Mapping 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.
 - ingestion
Endpoint Property MapConfiguration  - Source configuration.
 - location String
 - The resource location.
 - Map<String>
 - Resource tags.
 
Supporting Types
IotEventHubIngestionEndpointConfigurationResponse      
- Consumer
Group string - Consumer group of the event hub to connected to.
 - Event
Hub stringName  - Event Hub name to connect to.
 - Fully
Qualified stringEvent Hub Namespace  - Fully qualified namespace of the Event Hub to connect to.
 
- Consumer
Group string - Consumer group of the event hub to connected to.
 - Event
Hub stringName  - Event Hub name to connect to.
 - Fully
Qualified stringEvent Hub Namespace  - Fully qualified namespace of the Event Hub to connect to.
 
- consumer
Group String - Consumer group of the event hub to connected to.
 - event
Hub StringName  - Event Hub name to connect to.
 - fully
Qualified StringEvent Hub Namespace  - Fully qualified namespace of the Event Hub to connect to.
 
- consumer
Group string - Consumer group of the event hub to connected to.
 - event
Hub stringName  - Event Hub name to connect to.
 - fully
Qualified stringEvent Hub Namespace  - Fully qualified namespace of the Event Hub to connect to.
 
- consumer_
group str - Consumer group of the event hub to connected to.
 - event_
hub_ strname  - Event Hub name to connect to.
 - fully_
qualified_ strevent_ hub_ namespace  - Fully qualified namespace of the Event Hub to connect to.
 
- consumer
Group String - Consumer group of the event hub to connected to.
 - event
Hub StringName  - Event Hub name to connect to.
 - fully
Qualified StringEvent Hub Namespace  - 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    
- Principal
Id string - The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
 - Tenant
Id string - The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
 - Type string
 - Type of identity being specified, currently SystemAssigned and None are allowed.
 - User
Assigned Dictionary<string, Pulumi.Identities Azure Native. Healthcare Apis. Inputs. User Assigned Identity Response>  - 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 string - The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
 - Tenant
Id string - The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
 - Type string
 - Type of identity being specified, currently SystemAssigned and None are allowed.
 - User
Assigned map[string]UserIdentities Assigned Identity Response  - 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 String - The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
 - tenant
Id String - The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
 - type String
 - Type of identity being specified, currently SystemAssigned and None are allowed.
 - user
Assigned Map<String,UserIdentities Assigned Identity Response>  - 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 string - The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
 - tenant
Id string - The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
 - type string
 - Type of identity being specified, currently SystemAssigned and None are allowed.
 - user
Assigned {[key: string]: UserIdentities Assigned Identity Response}  - 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 str - The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
 - tenant_
id str - The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
 - type str
 - Type of identity being specified, currently SystemAssigned and None are allowed.
 - user_
assigned_ Mapping[str, Useridentities Assigned Identity Response]  - 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 String - The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
 - tenant
Id String - The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
 - type String
 - Type of identity being specified, currently SystemAssigned and None are allowed.
 - user
Assigned Map<Property Map>Identities  - 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  
- Created
At string - The timestamp of resource creation (UTC).
 - Created
By string - The identity that created the resource.
 - Created
By stringType  - The type of identity that created the resource.
 - Last
Modified stringAt  - The timestamp of resource last modification (UTC)
 - Last
Modified stringBy  - The identity that last modified the resource.
 - Last
Modified stringBy Type  - The type of identity that last modified the resource.
 
- Created
At string - The timestamp of resource creation (UTC).
 - Created
By string - The identity that created the resource.
 - Created
By stringType  - The type of identity that created the resource.
 - Last
Modified stringAt  - The timestamp of resource last modification (UTC)
 - Last
Modified stringBy  - The identity that last modified the resource.
 - Last
Modified stringBy Type  - The type of identity that last modified the resource.
 
- created
At String - The timestamp of resource creation (UTC).
 - created
By String - The identity that created the resource.
 - created
By StringType  - The type of identity that created the resource.
 - last
Modified StringAt  - The timestamp of resource last modification (UTC)
 - last
Modified StringBy  - The identity that last modified the resource.
 - last
Modified StringBy Type  - The type of identity that last modified the resource.
 
- created
At string - The timestamp of resource creation (UTC).
 - created
By string - The identity that created the resource.
 - created
By stringType  - The type of identity that created the resource.
 - last
Modified stringAt  - The timestamp of resource last modification (UTC)
 - last
Modified stringBy  - The identity that last modified the resource.
 - last
Modified stringBy Type  - 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_ strtype  - The type of identity that created the resource.
 - last_
modified_ strat  - The timestamp of resource last modification (UTC)
 - last_
modified_ strby  - The identity that last modified the resource.
 - last_
modified_ strby_ type  - The type of identity that last modified the resource.
 
- created
At String - The timestamp of resource creation (UTC).
 - created
By String - The identity that created the resource.
 - created
By StringType  - The type of identity that created the resource.
 - last
Modified StringAt  - The timestamp of resource last modification (UTC)
 - last
Modified StringBy  - The identity that last modified the resource.
 - last
Modified StringBy Type  - The type of identity that last modified the resource.
 
UserAssignedIdentityResponse   
- Client
Id string - The client ID of the assigned identity.
 - Principal
Id string - The principal ID of the assigned identity.
 
- Client
Id string - The client ID of the assigned identity.
 - Principal
Id string - The principal ID of the assigned identity.
 
- client
Id String - The client ID of the assigned identity.
 - principal
Id String - The principal ID of the assigned identity.
 
- client
Id string - The client ID of the assigned identity.
 - principal
Id string - The principal ID of the assigned identity.
 
- client_
id str - The client ID of the assigned identity.
 - principal_
id str - The principal ID of the assigned identity.
 
- client
Id String - The client ID of the assigned identity.
 - principal
Id String - The principal ID of the assigned identity.
 
Package Details
- Repository
 - Azure Native pulumi/pulumi-azure-native
 - License
 - Apache-2.0