1. Packages
  2. Azure Native v2
  3. API Docs
  4. healthcareapis
  5. getAnalyticsConnector
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.healthcareapis.getAnalyticsConnector

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Gets the properties of the specified Analytics Connector. Azure REST API version: 2022-10-01-preview.

Using getAnalyticsConnector

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 getAnalyticsConnector(args: GetAnalyticsConnectorArgs, opts?: InvokeOptions): Promise<GetAnalyticsConnectorResult>
function getAnalyticsConnectorOutput(args: GetAnalyticsConnectorOutputArgs, opts?: InvokeOptions): Output<GetAnalyticsConnectorResult>
Copy
def get_analytics_connector(analytics_connector_name: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            workspace_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetAnalyticsConnectorResult
def get_analytics_connector_output(analytics_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[GetAnalyticsConnectorResult]
Copy
func LookupAnalyticsConnector(ctx *Context, args *LookupAnalyticsConnectorArgs, opts ...InvokeOption) (*LookupAnalyticsConnectorResult, error)
func LookupAnalyticsConnectorOutput(ctx *Context, args *LookupAnalyticsConnectorOutputArgs, opts ...InvokeOption) LookupAnalyticsConnectorResultOutput
Copy

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

public static class GetAnalyticsConnector 
{
    public static Task<GetAnalyticsConnectorResult> InvokeAsync(GetAnalyticsConnectorArgs args, InvokeOptions? opts = null)
    public static Output<GetAnalyticsConnectorResult> Invoke(GetAnalyticsConnectorInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAnalyticsConnectorResult> getAnalyticsConnector(GetAnalyticsConnectorArgs args, InvokeOptions options)
public static Output<GetAnalyticsConnectorResult> getAnalyticsConnector(GetAnalyticsConnectorArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:healthcareapis:getAnalyticsConnector
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AnalyticsConnectorName
This property is required.
Changes to this property will trigger replacement.
string
The name of Analytics 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.
AnalyticsConnectorName
This property is required.
Changes to this property will trigger replacement.
string
The name of Analytics 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.
analyticsConnectorName
This property is required.
Changes to this property will trigger replacement.
String
The name of Analytics 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.
analyticsConnectorName
This property is required.
Changes to this property will trigger replacement.
string
The name of Analytics 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.
analytics_connector_name
This property is required.
Changes to this property will trigger replacement.
str
The name of Analytics 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.
analyticsConnectorName
This property is required.
Changes to this property will trigger replacement.
String
The name of Analytics 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.

getAnalyticsConnector Result

The following output properties are available:

DataDestinationConfiguration Pulumi.AzureNative.HealthcareApis.Outputs.AnalyticsConnectorDataLakeDataDestinationResponse
Data destination configuration for Analytics Connector.
DataMappingConfiguration Pulumi.AzureNative.HealthcareApis.Outputs.AnalyticsConnectorFhirToParquetMappingResponse
Data mapping configuration for Analytics Connector.
DataSourceConfiguration Pulumi.AzureNative.HealthcareApis.Outputs.AnalyticsConnectorFhirServiceDataSourceResponse
Data source for Analytics Connector.
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.
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.
Location string
The resource location.
Tags Dictionary<string, string>
Resource tags.
DataDestinationConfiguration AnalyticsConnectorDataLakeDataDestinationResponse
Data destination configuration for Analytics Connector.
DataMappingConfiguration AnalyticsConnectorFhirToParquetMappingResponse
Data mapping configuration for Analytics Connector.
DataSourceConfiguration AnalyticsConnectorFhirServiceDataSourceResponse
Data source for Analytics Connector.
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.
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.
Location string
The resource location.
Tags map[string]string
Resource tags.
dataDestinationConfiguration AnalyticsConnectorDataLakeDataDestinationResponse
Data destination configuration for Analytics Connector.
dataMappingConfiguration AnalyticsConnectorFhirToParquetMappingResponse
Data mapping configuration for Analytics Connector.
dataSourceConfiguration AnalyticsConnectorFhirServiceDataSourceResponse
Data source for Analytics Connector.
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.
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.
location String
The resource location.
tags Map<String,String>
Resource tags.
dataDestinationConfiguration AnalyticsConnectorDataLakeDataDestinationResponse
Data destination configuration for Analytics Connector.
dataMappingConfiguration AnalyticsConnectorFhirToParquetMappingResponse
Data mapping configuration for Analytics Connector.
dataSourceConfiguration AnalyticsConnectorFhirServiceDataSourceResponse
Data source for Analytics Connector.
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.
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.
location string
The resource location.
tags {[key: string]: string}
Resource tags.
data_destination_configuration AnalyticsConnectorDataLakeDataDestinationResponse
Data destination configuration for Analytics Connector.
data_mapping_configuration AnalyticsConnectorFhirToParquetMappingResponse
Data mapping configuration for Analytics Connector.
data_source_configuration AnalyticsConnectorFhirServiceDataSourceResponse
Data source for Analytics Connector.
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.
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.
location str
The resource location.
tags Mapping[str, str]
Resource tags.
dataDestinationConfiguration Property Map
Data destination configuration for Analytics Connector.
dataMappingConfiguration Property Map
Data mapping configuration for Analytics Connector.
dataSourceConfiguration Property Map
Data source for Analytics Connector.
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.
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.
location String
The resource location.
tags Map<String>
Resource tags.

Supporting Types

AnalyticsConnectorDataLakeDataDestinationResponse

DataLakeName This property is required. string
The name for the Data Lake.
Name string
Name of data destination.
DataLakeName This property is required. string
The name for the Data Lake.
Name string
Name of data destination.
dataLakeName This property is required. String
The name for the Data Lake.
name String
Name of data destination.
dataLakeName This property is required. string
The name for the Data Lake.
name string
Name of data destination.
data_lake_name This property is required. str
The name for the Data Lake.
name str
Name of data destination.
dataLakeName This property is required. String
The name for the Data Lake.
name String
Name of data destination.

AnalyticsConnectorFhirServiceDataSourceResponse

Kind This property is required. string
The kind of FHIR Service.
Url This property is required. string
The URL of FHIR service.
Kind This property is required. string
The kind of FHIR Service.
Url This property is required. string
The URL of FHIR service.
kind This property is required. String
The kind of FHIR Service.
url This property is required. String
The URL of FHIR service.
kind This property is required. string
The kind of FHIR Service.
url This property is required. string
The URL of FHIR service.
kind This property is required. str
The kind of FHIR Service.
url This property is required. str
The URL of FHIR service.
kind This property is required. String
The kind of FHIR Service.
url This property is required. String
The URL of FHIR service.

AnalyticsConnectorFhirToParquetMappingResponse

ExtensionSchemaReference string
Artifact reference for extension schema.
FilterConfigurationReference string
Artifact reference for filter configurations.
ExtensionSchemaReference string
Artifact reference for extension schema.
FilterConfigurationReference string
Artifact reference for filter configurations.
extensionSchemaReference String
Artifact reference for extension schema.
filterConfigurationReference String
Artifact reference for filter configurations.
extensionSchemaReference string
Artifact reference for extension schema.
filterConfigurationReference string
Artifact reference for filter configurations.
extension_schema_reference str
Artifact reference for extension schema.
filter_configuration_reference str
Artifact reference for filter configurations.
extensionSchemaReference String
Artifact reference for extension schema.
filterConfigurationReference String
Artifact reference for filter configurations.

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-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi