az healthcareapis workspace iot-connector fhir-destination
Note
This reference is part of the healthcareapis extension for the Azure CLI (version 2.66.0 or higher). The extension will automatically install the first time you run an az healthcareapis workspace iot-connector fhir-destination command. Learn more about extensions.
Manage iot connector fhir destination with healthcareapis.
Commands
Name | Description | Type | Status |
---|---|---|---|
az healthcareapis workspace iot-connector fhir-destination create |
Create an IoT Connector FHIR destination resource with the specified parameters. |
Extension | GA |
az healthcareapis workspace iot-connector fhir-destination delete |
Deletes an IoT Connector FHIR destination. |
Extension | GA |
az healthcareapis workspace iot-connector fhir-destination list |
Lists all FHIR destinations for the given IoT Connector. |
Extension | GA |
az healthcareapis workspace iot-connector fhir-destination show |
Gets the properties of the specified Iot Connector FHIR destination. |
Extension | GA |
az healthcareapis workspace iot-connector fhir-destination update |
Update an IoT Connector FHIR destination resource with the specified parameters. |
Extension | GA |
az healthcareapis workspace iot-connector fhir-destination wait |
Place the CLI in a waiting state until a condition of the healthcareapis workspace iot-connector fhir-destination is met. |
Extension | GA |
az healthcareapis workspace iot-connector fhir-destination create
Create an IoT Connector FHIR destination resource with the specified parameters.
az healthcareapis workspace iot-connector fhir-destination create --fhir-destination-name
--fhir-service-resource-id
--iot-connector-name
--resource-group
--resource-identity-resolution-type {Create, Lookup}
--workspace-name
[--content]
[--etag]
[--location]
[--no-wait]
Examples
Create or update an Iot Connector FHIR destination
az healthcareapis workspace iot-connector fhir-destination create --fhir-destination-name "dest1" --iot-connector-name "blue" --location "westus" --content "{\"template\":[{\"template\":{\"codes\":[{\"code\":\"8867-4\",\"display\":\"Heart rate\",\"system\":\"http://loinc.org\"}],\"periodInterval\":60,\"typeName\":\"heartrate\",\"value\":{\"defaultPeriod\":5000,\"unit\":\"count/min\",\"valueName\":\"hr\",\"valueType\":\"SampledData\"}},\"templateType\":\"CodeValueFhir\"}],\"templateType\":\"CollectionFhirTemplate\"}" --fhir-service-resource-id "subscriptions/11111111-2222-3333-4444-555566667777/resourceGroups/myrg/providers/Microsoft.HealthcareApis/workspaces/myworkspace/fhirservices/myfhirservice" --resource-identity-resolution-type "Create" --resource-group "testRG" --workspace-name "workspace1"
Required Parameters
The name of IoT Connector FHIR destination resource.
Fully qualified resource id of the FHIR service to connect to.
The name of IoT Connector resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Determines how resource identity is resolved on the destination.
Property | Value |
---|---|
Accepted values: | Create, Lookup |
The name of workspace resource.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The mapping. Expected value: json-string/json-file/@json-file.
Property | Value |
---|---|
Parameter group: | Fhir Mapping Arguments |
An etag associated with the resource, used for optimistic concurrency when editing it.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az healthcareapis workspace iot-connector fhir-destination delete
Deletes an IoT Connector FHIR destination.
az healthcareapis workspace iot-connector fhir-destination delete [--fhir-destination-name]
[--ids]
[--iot-connector-name]
[--no-wait]
[--resource-group]
[--subscription]
[--workspace-name]
[--yes]
Examples
Delete an IoT Connector destination
az healthcareapis workspace iot-connector fhir-destination delete --fhir-destination-name "dest1" --iot-connector-name "blue" --resource-group "testRG" --workspace-name "workspace1"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name of IoT Connector FHIR destination resource.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The name of IoT Connector resource.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Default value: | False |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The name of workspace resource.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az healthcareapis workspace iot-connector fhir-destination list
Lists all FHIR destinations for the given IoT Connector.
az healthcareapis workspace iot-connector fhir-destination list --iot-connector-name
--resource-group
--workspace-name
Examples
List IoT Connectors
az healthcareapis workspace iot-connector fhir-destination list --iot-connector-name "blue" --resource-group "testRG" --workspace-name "workspace1"
Required Parameters
The name of IoT Connector resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of workspace resource.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az healthcareapis workspace iot-connector fhir-destination show
Gets the properties of the specified Iot Connector FHIR destination.
az healthcareapis workspace iot-connector fhir-destination show [--fhir-destination-name]
[--ids]
[--iot-connector-name]
[--resource-group]
[--subscription]
[--workspace-name]
Examples
Get an IoT Connector destination
az healthcareapis workspace iot-connector fhir-destination show --fhir-destination-name "dest1" --iot-connector-name "blue" --resource-group "testRG" --workspace-name "workspace1"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name of IoT Connector FHIR destination resource.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The name of IoT Connector resource.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The name of workspace resource.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az healthcareapis workspace iot-connector fhir-destination update
Update an IoT Connector FHIR destination resource with the specified parameters.
az healthcareapis workspace iot-connector fhir-destination update --fhir-service-resource-id
--resource-identity-resolution-type {Create, Lookup}
[--add]
[--content]
[--etag]
[--fhir-destination-name]
[--force-string]
[--ids]
[--iot-connector-name]
[--location]
[--no-wait]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--workspace-name]
Required Parameters
Fully qualified resource id of the FHIR service to connect to.
Determines how resource identity is resolved on the destination.
Property | Value |
---|---|
Accepted values: | Create, Lookup |
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Default value: | [] |
The mapping. Expected value: json-string/json-file/@json-file.
Property | Value |
---|---|
Parameter group: | Fhir Mapping Arguments |
An etag associated with the resource, used for optimistic concurrency when editing it.
The name of IoT Connector FHIR destination resource.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Default value: | False |
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The name of IoT Connector resource.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Default value: | False |
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Default value: | [] |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Default value: | [] |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The name of workspace resource.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az healthcareapis workspace iot-connector fhir-destination wait
Place the CLI in a waiting state until a condition of the healthcareapis workspace iot-connector fhir-destination is met.
az healthcareapis workspace iot-connector fhir-destination wait [--created]
[--custom]
[--deleted]
[--exists]
[--fhir-destination-name]
[--ids]
[--interval]
[--iot-connector-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
[--workspace-name]
Examples
Pause executing next line of CLI script until the healthcareapis workspace iot-connector fhir-destination is successfully created.
az healthcareapis workspace iot-connector fhir-destination wait --fhir-destination-name "dest1" --iot-connector-name "blue" --resource-group "testRG" --workspace-name "workspace1" --created
Pause executing next line of CLI script until the healthcareapis workspace iot-connector fhir-destination is successfully updated.
az healthcareapis workspace iot-connector fhir-destination wait --fhir-destination-name "dest1" --iot-connector-name "blue" --resource-group "testRG" --workspace-name "workspace1" --updated
Pause executing next line of CLI script until the healthcareapis workspace iot-connector fhir-destination is successfully deleted.
az healthcareapis workspace iot-connector fhir-destination wait --fhir-destination-name "dest1" --iot-connector-name "blue" --resource-group "testRG" --workspace-name "workspace1" --deleted
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Wait until created with 'provisioningState' at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Wait until deleted.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Wait until the resource exists.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
The name of IoT Connector FHIR destination resource.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Polling interval in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 30 |
The name of IoT Connector resource.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Maximum wait in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 3600 |
Wait until updated with provisioningState at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
The name of workspace resource.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |