New-AzCosmosDBLocationObject.md

external help file	Module Name	online version	schema
Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml	Az.CosmosDB	https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdblocationobject	2.0.0

New-AzCosmosDBLocationObject

SYNOPSIS

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: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

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

-FailoverPriority

Failover priority of the location.

Type: System.Nullable`1[System.Int32]
Parameter Sets: (All)
Aliases:

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

-IsZoneRedundant

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

Type: System.Nullable`1[System.Boolean]
Parameter Sets: (All)
Aliases:

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

-LocationName

Name of the Location in string.

Type: System.String
Parameter Sets: (All)
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

Microsoft.Azure.Commands.CosmosDB.Models.PSLocation

NOTES

RELATED LINKS