Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

format the help markdown file of Az.HealthcareApis #18418

Merged
merged 1 commit into from
Jun 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions src/HealthcareApis/help/Get-AzHealthcareApisService.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,10 @@ Get the metadata of a service instance.

### Example 1: List the metadata of service instance.
```powershell
PS C:\> Get-AzHealthcareApisService
Get-AzHealthcareApisService
```

```output
Location Name Kind ResourceGroupName
-------- ---- ---- -----------------
eastus2 azpsapiservice fhir azps_test_group
Expand All @@ -53,8 +55,10 @@ List the metadata of service instance.

### Example 2: List the metadata of service instance by resource group.
```powershell
PS C:\> Get-AzHealthcareApisService -ResourceGroupName azps_test_group
Get-AzHealthcareApisService -ResourceGroupName azps_test_group
```

```output
Location Name Kind ResourceGroupName
-------- ---- ---- -----------------
eastus2 azpsapiservice fhir azps_test_group
Expand All @@ -64,8 +68,10 @@ List the metadata of service instance by resource group.

### Example 3: Get the metadata of a service instance.
```powershell
PS C:\> Get-AzHealthcareApisService -ResourceGroupName azps_test_group -Name azpsapiservice
Get-AzHealthcareApisService -ResourceGroupName azps_test_group -Name azpsapiservice
```

```output
Location Name Kind ResourceGroupName
-------- ---- ---- -----------------
eastus2 azpsapiservice fhir azps_test_group
Expand Down
12 changes: 9 additions & 3 deletions src/HealthcareApis/help/Get-AzHealthcareApisWorkspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,10 @@ Gets the properties of the specified workspace.

### Example 1: List the properties.
```powershell
PS C:\> Get-AzHealthcareApisWorkspace
Get-AzHealthcareApisWorkspace
```

```output
Location Name ResourceGroupName
-------- ---- -----------------
eastus2 azpshcws azps_test_group
Expand All @@ -54,8 +56,10 @@ List the properties.

### Example 2: Gets the properties of the specified workspace.
```powershell
PS C:\> Get-AzHealthcareApisWorkspace -Name azpshcws -ResourceGroupName azps_test_group
Get-AzHealthcareApisWorkspace -Name azpshcws -ResourceGroupName azps_test_group
```

```output
Location Name ResourceGroupName
-------- ---- -----------------
eastus2 azpshcws azps_test_group
Expand All @@ -65,8 +69,10 @@ Gets the properties of the specified workspace.

### Example 3: List the properties of the resource group.
```powershell
PS C:\> Get-AzHealthcareApisWorkspace -ResourceGroupName azps_test_group
Get-AzHealthcareApisWorkspace -ResourceGroupName azps_test_group
```

```output
Location Name ResourceGroupName
-------- ---- -----------------
eastus2 azpshcws azps_test_group
Expand Down
8 changes: 6 additions & 2 deletions src/HealthcareApis/help/Get-AzHealthcareDicomService.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,10 @@ Gets the properties of the specified DICOM Service.

### Example 1: List the properties of the specified workspace.
```powershell
PS C:\> Get-AzHealthcareDicomService -ResourceGroupName azps_test_group -WorkspaceName azpshcws
Get-AzHealthcareDicomService -ResourceGroupName azps_test_group -WorkspaceName azpshcws
```

```output
Location Name ResourceGroupName
-------- ---- -----------------
eastus2 azpshcws/azpsdicom azps_test_group
Expand All @@ -48,8 +50,10 @@ List the properties of the specified workspace.

### Example 2: Gets the properties of the specified DICOM Service.
```powershell
PS C:\> Get-AzHealthcareDicomService -Name azpsdicom -ResourceGroupName azps_test_group -WorkspaceName azpshcws
Get-AzHealthcareDicomService -Name azpsdicom -ResourceGroupName azps_test_group -WorkspaceName azpshcws
```

```output
Location Name ResourceGroupName
-------- ---- -----------------
eastus2 azpshcws/azpsdicom azps_test_group
Expand Down
4 changes: 3 additions & 1 deletion src/HealthcareApis/help/Get-AzHealthcareFhirDestination.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ Lists all FHIR destinations for the given IoT Connector

### Example 1: Lists all FHIR destinations for the given IoT Connector
```powershell
PS C:\> Get-AzHealthcareFhirDestination -IotConnectorName azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws
Get-AzHealthcareFhirDestination -IotConnectorName azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws
```

```output
Location Name ResourceGroupName
-------- ---- -----------------
eastus2 azpshcws/azpsiotconnector/azpsfhirdestination azps_test_group
Expand Down
8 changes: 6 additions & 2 deletions src/HealthcareApis/help/Get-AzHealthcareFhirService.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,10 @@ Gets the properties of the specified FHIR Service.

### Example 1: List the properties of the specified FHIR Service.
```powershell
PS C:\> Get-AzHealthcareFhirService -ResourceGroupName azps_test_group -WorkspaceName azpshcws
Get-AzHealthcareFhirService -ResourceGroupName azps_test_group -WorkspaceName azpshcws
```

```output
Location Name Kind ResourceGroupName
-------- ---- ---- -----------------
eastus2 azpshcws/azpsfhirservice fhir-R4 azps_test_group
Expand All @@ -48,8 +50,10 @@ List the properties of the specified FHIR Service.

### Example 2: Gets the properties of the specified FHIR Service.
```powershell
PS C:\> Get-AzHealthcareFhirService -Name azpsfhirservice -ResourceGroupName azps_test_group -WorkspaceName azpshcws
Get-AzHealthcareFhirService -Name azpsfhirservice -ResourceGroupName azps_test_group -WorkspaceName azpshcws
```

```output
Location Name Kind ResourceGroupName
-------- ---- ---- -----------------
eastus2 azpshcws/azpsfhirservice fhir-R4 azps_test_group
Expand Down
8 changes: 6 additions & 2 deletions src/HealthcareApis/help/Get-AzHealthcareIotConnector.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,10 @@ Gets the properties of the specified IoT Connector.

### Example 1: List the properties of the specified IoT Connector.
```powershell
PS C:\> Get-AzHealthcareIotConnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws
Get-AzHealthcareIotConnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws
```

```output
Location Name ResourceGroupName
-------- ---- -----------------
eastus2 azpshcws/azpsiotconnector azps_test_group
Expand All @@ -48,8 +50,10 @@ List the properties of the specified IoT Connector.

### Example 2: Gets the properties of the specified IoT Connector.
```powershell
PS C:\> Get-AzHealthcareIotConnector -Name azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws
Get-AzHealthcareIotConnector -Name azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws
```

```output
Location Name ResourceGroupName
-------- ---- -----------------
eastus2 azpshcws/azpsiotconnector azps_test_group
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,10 @@ Gets the properties of the specified Iot Connector FHIR destination.

### Example 1: Gets the properties of the specified Iot Connector FHIR destination.
```powershell
PS C:\> Get-AzHealthcareIotConnectorFhirDestination -FhirDestinationName azpsfhirdestination -IotConnectorName azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws
Get-AzHealthcareIotConnectorFhirDestination -FhirDestinationName azpsfhirdestination -IotConnectorName azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws
```

```output
Location Name ResourceGroupName
-------- ---- -----------------
eastus2 azpshcws/azpsiotconnector/azpsfhirdestination azps_test_group
Expand Down
4 changes: 3 additions & 1 deletion src/HealthcareApis/help/New-AzHealthcareApisService.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,10 @@ Create or update the metadata of a service instance.

### Example 1: Create or update the metadata of a service instance.
```powershell
PS C:\> New-AzHealthcareApisService -ResourceGroupName azps_test_group -Name azpsapiservice -Kind 'fhir' -Location eastus2 -CosmosOfferThroughput 400
New-AzHealthcareApisService -ResourceGroupName azps_test_group -Name azpsapiservice -Kind 'fhir' -Location eastus2 -CosmosOfferThroughput 400
```

```output
Location Name Kind ResourceGroupName
-------- ---- ---- -----------------
eastus2 azpsapiservice fhir azps_test_group
Expand Down
4 changes: 3 additions & 1 deletion src/HealthcareApis/help/New-AzHealthcareApisWorkspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,10 @@ Creates or updates a workspace resource with the specified parameters.

### Example 1: Creates or update a workspace resource with the specified parameters.
```powershell
PS C:\> New-AzHealthcareApisWorkspace -Name azpshcws -ResourceGroupName azps_test_group -Location eastus2
New-AzHealthcareApisWorkspace -Name azpshcws -ResourceGroupName azps_test_group -Location eastus2
```

```output
Location Name ResourceGroupName
-------- ---- -----------------
eastus2 azpshcws azps_test_group
Expand Down
4 changes: 3 additions & 1 deletion src/HealthcareApis/help/New-AzHealthcareDicomService.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,10 @@ Creates or updates a DICOM Service resource with the specified parameters.

### Example 1: Creates or updates a DICOM Service resource with the specified parameters.
```powershell
PS C:\> New-AzHealthcareDicomService -Name azpsdicom -ResourceGroupName azps_test_group -WorkspaceName azpshcws -Location eastus2
New-AzHealthcareDicomService -Name azpsdicom -ResourceGroupName azps_test_group -WorkspaceName azpshcws -Location eastus2
```

```output
Location Name ResourceGroupName
-------- ---- -----------------
eastus2 azpshcws/azpsdicom azps_test_group
Expand Down
4 changes: 3 additions & 1 deletion src/HealthcareApis/help/New-AzHealthcareFhirService.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,10 @@ Creates or updates a FHIR Service resource with the specified parameters.

### Example 1: Creates or updates a FHIR Service resource with the specified parameters.
```powershell
PS C:\> New-AzHealthcareFhirService -Name azpsfhirservice -ResourceGroupName azps_test_group -WorkspaceName azpshcws -Location eastus2 -Kind 'fhir-R4' -Authority "https://login.microsoftonline.com/{DirectoryID}" -Audience "https://azpshcws-{FhirServiceName}.fhir.azurehealthcareapis.com"
New-AzHealthcareFhirService -Name azpsfhirservice -ResourceGroupName azps_test_group -WorkspaceName azpshcws -Location eastus2 -Kind 'fhir-R4' -Authority "https://login.microsoftonline.com/{DirectoryID}" -Audience "https://azpshcws-{FhirServiceName}.fhir.azurehealthcareapis.com"
```

```output
Location Name Kind ResourceGroupName
-------- ---- ---- -----------------
eastus2 azpshcws/azpsfhirservice fhir-R4 azps_test_group
Expand Down
6 changes: 4 additions & 2 deletions src/HealthcareApis/help/New-AzHealthcareIotConnector.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,11 @@ Creates or updates an IoT Connector resource with the specified parameters.

### Example 1: Creates or updates an IoT Connector resource with the specified parameters.
```powershell
PS C:\> $arr = @()
PS C:\> New-AzHealthcareIotConnector -Name azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws -Location eastus2 -IngestionEndpointConfigurationConsumerGroup "sajob-01-portal_input-01_consumer_group" -IngestionEndpointConfigurationEventHubName "sajob01portaleventhub" -IngestionEndpointConfigurationFullyQualifiedEventHubNamespace "sdk-Namespace-4761.servicebus.windows.net" -DeviceMappingContent @{"templateType"="CollectionContent";"template"=$arr}
$arr = @()
New-AzHealthcareIotConnector -Name azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws -Location eastus2 -IngestionEndpointConfigurationConsumerGroup "sajob-01-portal_input-01_consumer_group" -IngestionEndpointConfigurationEventHubName "sajob01portaleventhub" -IngestionEndpointConfigurationFullyQualifiedEventHubNamespace "sdk-Namespace-4761.servicebus.windows.net" -DeviceMappingContent @{"templateType"="CollectionContent";"template"=$arr}
```

```output
Location Name ResourceGroupName
-------- ---- -----------------
eastus2 azpshcws/azpsiotconnector azps_test_group
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,11 @@ Creates or updates an IoT Connector FHIR destination resource with the specified

### Example 1: Creates or updates an IoT Connector FHIR destination resource with the specified parameters.
```powershell
PS C:\> $arr = @()
PS C:\> New-AzHealthcareIotConnectorFhirDestination -FhirDestinationName azpsfhirdestination -IotConnectorName azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws -FhirServiceResourceId "/subscriptions/{SubscriptionId}/resourceGroups/azps_test_group/providers/Microsoft.HealthcareApis/workspaces/azpshcws/fhirservices/azpsfhirservice" -ResourceIdentityResolutionType 'Create' -Location eastus2 -FhirMappingContent @{"templateType"="CollectionFhirTemplate";"template"=$arr}
$arr = @()
New-AzHealthcareIotConnectorFhirDestination -FhirDestinationName azpsfhirdestination -IotConnectorName azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws -FhirServiceResourceId "/subscriptions/{SubscriptionId}/resourceGroups/azps_test_group/providers/Microsoft.HealthcareApis/workspaces/azpshcws/fhirservices/azpsfhirservice" -ResourceIdentityResolutionType 'Create' -Location eastus2 -FhirMappingContent @{"templateType"="CollectionFhirTemplate";"template"=$arr}
```

```output
Location Name ResourceGroupName
-------- ---- -----------------
eastus2 azpshcws/azpsiotconnector/azpsfhirdestination azps_test_group
Expand Down
6 changes: 2 additions & 4 deletions src/HealthcareApis/help/Remove-AzHealthcareApisService.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,14 @@ Delete a service instance.

### Example 1: Delete a service instance.
```powershell
PS C:\> Remove-AzHealthcareApisService -ResourceGroupName azps_test_group -Name azpsapiservice

Remove-AzHealthcareApisService -ResourceGroupName azps_test_group -Name azpsapiservice
```

Delete a service instance.

### Example 2: Delete a service instance.
```powershell
PS C:\> Get-AzHealthcareApisService -ResourceGroupName azps_test_group -Name azpsapiservice | Remove-AzHealthcareApisService

Get-AzHealthcareApisService -ResourceGroupName azps_test_group -Name azpsapiservice | Remove-AzHealthcareApisService
```

Delete a service instance.
Expand Down
6 changes: 2 additions & 4 deletions src/HealthcareApis/help/Remove-AzHealthcareApisWorkspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,14 @@ Deletes a specified workspace.

### Example 1: Deletes a specified workspace.
```powershell
PS C:\> Remove-AzHealthcareApisWorkspace -Name azpshcws -ResourceGroupName azps_test_group

Remove-AzHealthcareApisWorkspace -Name azpshcws -ResourceGroupName azps_test_group
```

Deletes a specified workspace.

### Example 2: Deletes a specified workspace.
```powershell
PS C:\> Get-AzHealthcareApisWorkspace -Name azpshcws -ResourceGroupName azps_test_group | Remove-AzHealthcareApisWorkspace

Get-AzHealthcareApisWorkspace -Name azpshcws -ResourceGroupName azps_test_group | Remove-AzHealthcareApisWorkspace
```

Deletes a specified workspace.
Expand Down
6 changes: 2 additions & 4 deletions src/HealthcareApis/help/Remove-AzHealthcareDicomService.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,14 @@ Deletes a DICOM Service.

### Example 1: Delete
```powershell
PS C:\> Remove-AzHealthcareDicomService -Name azpsdicom -ResourceGroupName azps_test_group -WorkspaceName azpshcws

Remove-AzHealthcareDicomService -Name azpsdicom -ResourceGroupName azps_test_group -WorkspaceName azpshcws
```

Deletes a DICOM Service.

### Example 2: DeleteViaIdentity
```powershell
PS C:\> Get-AzHealthcareDicomService -Name azpsdicom -ResourceGroupName azps_test_group -WorkspaceName azpshcws | Remove-AzHealthcareDicomService

Get-AzHealthcareDicomService -Name azpsdicom -ResourceGroupName azps_test_group -WorkspaceName azpshcws | Remove-AzHealthcareDicomService
```

Deletes a DICOM Service.
Expand Down
6 changes: 2 additions & 4 deletions src/HealthcareApis/help/Remove-AzHealthcareFhirService.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,14 @@ Deletes a FHIR Service.

### Example 1: Deletes a FHIR Service.
```powershell
PS C:\> Remove-AzHealthcareFhirService -Name azpsfhirservice -ResourceGroupName azps_test_group -WorkspaceName azpshcws

Remove-AzHealthcareFhirService -Name azpsfhirservice -ResourceGroupName azps_test_group -WorkspaceName azpshcws
```

Deletes a FHIR Service.

### Example 2: Deletes a FHIR Service.
```powershell
PS C:\> Get-AzHealthcareFhirService -Name azpsfhirservice -ResourceGroupName azps_test_group -WorkspaceName azpshcws | Remove-AzHealthcareFhirService

Get-AzHealthcareFhirService -Name azpsfhirservice -ResourceGroupName azps_test_group -WorkspaceName azpshcws | Remove-AzHealthcareFhirService
```

Deletes a FHIR Service.
Expand Down
6 changes: 2 additions & 4 deletions src/HealthcareApis/help/Remove-AzHealthcareIotConnector.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,14 @@ Deletes an IoT Connector.

### Example 1: Deletes an IoT Connector.
```powershell
PS C:\> Remove-AzHealthcareIotConnector -Name azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws

Remove-AzHealthcareIotConnector -Name azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws
```

Deletes an IoT Connector.

### Example 2: Deletes an IoT Connector.
```powershell
PS C:\> Get-AzHealthcareIotConnector -Name azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws | Remove-AzHealthcareIotConnector

Get-AzHealthcareIotConnector -Name azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws | Remove-AzHealthcareIotConnector
```

Deletes an IoT Connector.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,14 @@ Deletes an IoT Connector FHIR destination.

### Example 1: Deletes an IoT Connector FHIR destination.
```powershell
PS C:\> Remove-AzHealthcareIotConnectorFhirDestination -FhirDestinationName azpsfhirdestination -IotConnectorName azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws

Remove-AzHealthcareIotConnectorFhirDestination -FhirDestinationName azpsfhirdestination -IotConnectorName azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws
```

Deletes an IoT Connector FHIR destination.

### Example 2: Deletes an IoT Connector FHIR destination.
```powershell
PS C:\> Get-AzHealthcareIotConnectorFhirDestination -FhirDestinationName azpsfhirdestination -IotConnectorName azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws | Remove-AzHealthcareIotConnectorFhirDestination

Get-AzHealthcareIotConnectorFhirDestination -FhirDestinationName azpsfhirdestination -IotConnectorName azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws | Remove-AzHealthcareIotConnectorFhirDestination
```

Deletes an IoT Connector FHIR destination.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,10 @@ Check if a service instance name is available.

### Example 1: Check if a service instance name is available.
```powershell
PS C:\> Test-AzHealthcareServiceNameAvailability -Name azpsdicom -Type Microsoft.HealthcareApis/services
Test-AzHealthcareServiceNameAvailability -Name azpsdicom -Type Microsoft.HealthcareApis/services
```

```output
Message NameAvailable Reason
------- ------------- ------
True
Expand Down
8 changes: 6 additions & 2 deletions src/HealthcareApis/help/Update-AzHealthcareApisService.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,10 @@ Update the metadata of a service instance.

### Example 1: Update the metadata of a service instance.
```powershell
PS C:\> Update-AzHealthcareApisService -ResourceGroupName azps_test_group -Name azpsapiservice -Tag @{"abc"="123"}
Update-AzHealthcareApisService -ResourceGroupName azps_test_group -Name azpsapiservice -Tag @{"abc"="123"}
```

```output
Location Name Kind ResourceGroupName
-------- ---- ---- -----------------
eastus2 azpsapiservice fhir azps_test_group
Expand All @@ -44,8 +46,10 @@ Update the metadata of a service instance.

### Example 2: Update the metadata of a service instance.
```powershell
PS C:\> Get-AzHealthcareApisService -ResourceGroupName azps_test_group -Name azpsapiservice | Update-AzHealthcareApisService -Tag @{"abc"="123"}
Get-AzHealthcareApisService -ResourceGroupName azps_test_group -Name azpsapiservice | Update-AzHealthcareApisService -Tag @{"abc"="123"}
```

```output
Location Name Kind ResourceGroupName
-------- ---- ---- -----------------
eastus2 azpsapiservice fhir azps_test_group
Expand Down
Loading