New-AzHealthcareApisService
Create or update the metadata of a service instance.
Syntax
New-AzHealthcareApisService
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
-Kind <Kind>
-Location <String>
-CosmosOfferThroughput <Int32>
[-AccessPolicyObjectId <IServiceAccessPolicyEntry[]>]
[-AcrConfigurationLoginServer <String[]>]
[-AcrConfigurationOciArtifact <IServiceOciArtifactEntry[]>]
[-AllowCorsCredential]
[-Audience <String>]
[-Authority <String>]
[-CorsHeader <String[]>]
[-CorsMaxAge <Int32>]
[-CorsMethod <String[]>]
[-CorsOrigin <String[]>]
[-CosmosKeyVaultKeyUri <String>]
[-EnableSmartProxy]
[-Etag <String>]
[-ExportStorageAccountName <String>]
[-IdentityType <ManagedServiceIdentityType>]
[-PrivateEndpointConnection <IPrivateEndpointConnection[]>]
[-PublicNetworkAccess <PublicNetworkAccess>]
[-Tag <Hashtable>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Create or update the metadata of a service instance.
Examples
Example 1: Create or update the metadata of a service instance.
New-AzHealthcareApisService -ResourceGroupName azps_test_group -Name azpsapiservice -Kind 'fhir' -Location eastus2 -CosmosOfferThroughput 400
Location Name Kind ResourceGroupName
-------- ---- ---- -----------------
eastus2 azpsapiservice fhir azps_test_groupCreate or update the metadata of a service instance.
Parameters
-AccessPolicyObjectId
The access policies of the service instance. To construct, see NOTES section for ACCESSPOLICYOBJECTID properties and create a hash table.
| Type: | IServiceAccessPolicyEntry[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AcrConfigurationLoginServer
The list of the ACR login servers.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AcrConfigurationOciArtifact
The list of Open Container Initiative (OCI) artifacts. To construct, see NOTES section for ACRCONFIGURATIONOCIARTIFACT properties and create a hash table.
| Type: | IServiceOciArtifactEntry[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AllowCorsCredential
If credentials are allowed via CORS.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AsJob
Run the command as a job
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Audience
The audience url for the service
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Authority
The authority url for the service
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CorsHeader
The headers to be allowed via CORS.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CorsMaxAge
The max age to be allowed via CORS.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CorsMethod
The methods to be allowed via CORS.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CorsOrigin
The origins to be allowed via CORS.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CosmosKeyVaultKeyUri
The URI of the customer-managed key for the backing database.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CosmosOfferThroughput
The provisioned throughput for the backing database.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnableSmartProxy
If the SMART on FHIR proxy is enabled
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Etag
An etag associated with the resource, used for optimistic concurrency when editing it.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExportStorageAccountName
The name of the default export storage account.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IdentityType
Type of identity being specified, currently SystemAssigned and None are allowed.
| Type: | ManagedServiceIdentityType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Kind
The kind of the service.
| Type: | Kind |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Location
The resource location.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
The name of the service instance.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NoWait
Run the command asynchronously
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PrivateEndpointConnection
The list of private endpoint connections that are set up for this resource. To construct, see NOTES section for PRIVATEENDPOINTCONNECTION properties and create a hash table.
| Type: | IPrivateEndpointConnection[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PublicNetworkAccess
Control permission for data plane traffic coming from public networks while private endpoint is enabled.
| Type: | PublicNetworkAccess |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group that contains the service instance.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
The subscription identifier.
| Type: | String |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Tag
The resource tags.
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Outputs
Azure PowerShell