iot_connector_fhir_destination

Creates, updates, deletes, gets or lists an iot_connector_fhir_destination resource.

Overview

Name	iot_connector_fhir_destination
Type	Resource
Id	azure_extras.health_data_services.iot_connector_fhir_destination

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
etag	string	An etag associated with the resource, used for optimistic concurrency when editing it.
fhirMapping	object	FHIR Mappings. Required.
fhirServiceResourceId	string	Fully qualified resource id of the FHIR service to connect to. Required.
location	string	The resource location.
provisioningState	string	The provisioning state. Known values are: "Deleting", "Succeeded", "Creating", "Accepted", "Verifying", "Updating", "Failed", "Canceled", "Deprovisioned", "Moving", "Suspended", "Warned", and "SystemMaintenance". (Deleting, Succeeded, Creating, Accepted, Verifying, Updating, Failed, Canceled, Deprovisioned, Moving, Suspended, Warned, SystemMaintenance)
resourceIdentityResolutionType	string	Determines how resource identity is resolved on the destination. Required. Known values are: "Create" and "Lookup". (Create, Lookup)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, iot_connector_name, fhir_destination_name, subscription_id		Gets the properties of the specified Iot Connector FHIR destination.
create_or_update	insert	resource_group_name, workspace_name, iot_connector_name, fhir_destination_name, subscription_id, properties		Creates or updates an IoT Connector FHIR destination resource with the specified parameters.
create_or_update	replace	resource_group_name, workspace_name, iot_connector_name, fhir_destination_name, subscription_id, properties		Creates or updates an IoT Connector FHIR destination resource with the specified parameters.
delete	delete	resource_group_name, workspace_name, iot_connector_name, fhir_destination_name, subscription_id		Deletes an IoT Connector FHIR destination.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
fhir_destination_name	string	The name of IoT Connector FHIR destination resource. Required.
iot_connector_name	string	The name of IoT Connector resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of workspace resource. Required.

SELECT examples

get

Gets the properties of the specified Iot Connector FHIR destination.

SELECT
id,
name,
etag,
fhirMapping,
fhirServiceResourceId,
location,
provisioningState,
resourceIdentityResolutionType,
systemData,
type
FROM azure_extras.health_data_services.iot_connector_fhir_destination
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND iot_connector_name = '{{ iot_connector_name }}' -- required
AND fhir_destination_name = '{{ fhir_destination_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates an IoT Connector FHIR destination resource with the specified parameters.

INSERT INTO azure_extras.health_data_services.iot_connector_fhir_destination (
properties,
etag,
location,
resource_group_name,
workspace_name,
iot_connector_name,
fhir_destination_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ etag }}',
'{{ location }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ iot_connector_name }}',
'{{ fhir_destination_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: iot_connector_fhir_destination
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the iot_connector_fhir_destination resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the iot_connector_fhir_destination resource.
  - name: iot_connector_name
    value: "{{ iot_connector_name }}"
    description: Required parameter for the iot_connector_fhir_destination resource.
  - name: fhir_destination_name
    value: "{{ fhir_destination_name }}"
    description: Required parameter for the iot_connector_fhir_destination resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the iot_connector_fhir_destination resource.
  - name: properties
    description: |
      IoT FHIR Destination settings. Required.
    value:
      provisioningState: "{{ provisioningState }}"
      resourceIdentityResolutionType: "{{ resourceIdentityResolutionType }}"
      fhirServiceResourceId: "{{ fhirServiceResourceId }}"
      fhirMapping:
        content: "{{ content }}"
  - name: etag
    value: "{{ etag }}"
    description: |
      An etag associated with the resource, used for optimistic concurrency when editing it.
  - name: location
    value: "{{ location }}"
    description: |
      The resource location.

REPLACE examples

create_or_update

Creates or updates an IoT Connector FHIR destination resource with the specified parameters.

REPLACE azure_extras.health_data_services.iot_connector_fhir_destination
SET 
properties = '{{ properties }}',
etag = '{{ etag }}',
location = '{{ location }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND iot_connector_name = '{{ iot_connector_name }}' --required
AND fhir_destination_name = '{{ fhir_destination_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
type;

DELETE examples

delete

Deletes an IoT Connector FHIR destination.

DELETE FROM azure_extras.health_data_services.iot_connector_fhir_destination
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND iot_connector_name = '{{ iot_connector_name }}' --required
AND fhir_destination_name = '{{ fhir_destination_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;