New-AzCosmosDBLocationObject

  • Reference
Module:
Az.CosmosDB

Create a new CosmosDB Location Object(PSLocation).

Syntax

New-AzCosmosDBLocationObject
   -LocationName <String>
   [-FailoverPriority <Int32>]
   [-IsZoneRedundant <Boolean>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Create a new CosmosDB Location Object(PSLocation).

Examples

Example 1

New-AzCosmosDBLocationObject -LocationName "locationName" -FailoverPriority 2 -IsZoneRedundant 0

LocationName     FailoverPriority IsZoneRedundant
------------     ---------------- ---------------
{locationName}                 2           False

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FailoverPriority

Failover priority of the location.

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IsZoneRedundant

Boolean to indicate whether or not this region is an AvailabilityZone.

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LocationName

Name of the Location in string.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

PSLocation