Editar

Partilhar via

New-AzCosmosDBSqlContainer

  • Reference
Module:
Az.CosmosDB

Creates a new CosmosDB Sql Container.

Syntax

New-AzCosmosDBSqlContainer
   -ResourceGroupName <String>
   -AccountName <String>
   -DatabaseName <String>
   -Name <String>
   [-IndexingPolicy <PSSqlIndexingPolicy>]
   [-PartitionKeyVersion <Int32>]
   -PartitionKeyKind <String>
   -PartitionKeyPath <String[]>
   [-Throughput <Int32>]
   [-AutoscaleMaxThroughput <Int32>]
   [-TtlInSeconds <Int32>]
   [-UniqueKeyPolicy <PSSqlUniqueKeyPolicy>]
   [-ConflictResolutionPolicyMode <String>]
   [-ConflictResolutionPolicyPath <String>]
   [-ConflictResolutionPolicyProcedure <String>]
   [-ConflictResolutionPolicy <PSSqlConflictResolutionPolicy>]
   [-ClientEncryptionPolicy <PSSqlClientEncryptionPolicy>]
   [-AnalyticalStorageTtl <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzCosmosDBSqlContainer
   -Name <String>
   [-IndexingPolicy <PSSqlIndexingPolicy>]
   [-PartitionKeyVersion <Int32>]
   -PartitionKeyKind <String>
   -PartitionKeyPath <String[]>
   [-Throughput <Int32>]
   [-AutoscaleMaxThroughput <Int32>]
   [-TtlInSeconds <Int32>]
   [-UniqueKeyPolicy <PSSqlUniqueKeyPolicy>]
   [-ConflictResolutionPolicyMode <String>]
   [-ConflictResolutionPolicyPath <String>]
   [-ConflictResolutionPolicyProcedure <String>]
   [-ConflictResolutionPolicy <PSSqlConflictResolutionPolicy>]
   [-ClientEncryptionPolicy <PSSqlClientEncryptionPolicy>]
   [-AnalyticalStorageTtl <Int32>]
   -ParentObject <PSSqlDatabaseGetResults>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Creates a new CosmosDB Sql Container.

Examples

Example 1

New-AzCosmosDBSqlContainer -AccountName myAccountName -DatabaseName myDatabaseName -ResourceGroupName myRgName -Name myContainerName -PartitionKeyPath /a/b/c -PartitionKeyKind Hash

Name     : myContainerName
Id       : /subscriptions/mySubscriptionId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlDatabases/myDatabaseName/contain
           ers/myContainerName
Location :
Tags     :
Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetPropertiesResource

Example 2: Create a new CosmosDB Sql Container with Client Encryption Policy

$includedPath1 = [Microsoft.Azure.Management.CosmosDB.Models.ClientEncryptionIncludedPath]::new("/path1","key1","Deterministic","AEAD_AES_256_CBC_HMAC_SHA256");
$includedPath2 = [Microsoft.Azure.Management.CosmosDB.Models.ClientEncryptionIncludedPath]::new("/path2","key2","Randomized","AEAD_AES_256_CBC_HMAC_SHA256");
$listofIncludedPaths = New-Object Collections.Generic.List[Microsoft.Azure.Management.CosmosDB.Models.ClientEncryptionIncludedPath]
$listofIncludedPaths.Add($includedPath1)
$listofIncludedPaths.Add($includedPath2)
$newClientEncryptionPolicy =  [Microsoft.Azure.Management.CosmosDB.Models.ClientEncryptionPolicy]::new($listofIncludedPaths, 2)
$newPSSqlClientEncryptionPolicy = [Microsoft.Azure.Commands.CosmosDB.Models.PSSqlClientEncryptionPolicy]::new($newClientEncryptionPolicy)
New-AzCosmosDBSqlContainer -AccountName myAccountName -DatabaseName myDatabaseName -ResourceGroupName myRgName -Name myContainerName -PartitionKeyPath /a/b/c -PartitionKeyKind Hash -ClientEncryptionPolicy $newPSSqlClientEncryptionPolicy

Name     : myContainerName
Id       : /subscriptions/mySubscriptionId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlDatabases/myDatabaseName/contain
           ers/myContainerName
Location :
Tags     :
Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetPropertiesResource

Parameters

-AccountName

Name of the Cosmos DB database account.

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

-AnalyticalStorageTtl

TTL for Analytical Storage (in Seconds).

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

-AutoscaleMaxThroughput

Maximum Throughput value if autoscale is enabled.

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

-ClientEncryptionPolicy

ClientEncryptionPolicy Object of type PSSqlClientEncryptionPolicy, when provided this is set as the ClientEncryptionPolicy of the container.

Type:PSSqlClientEncryptionPolicy
Position:Named
Default value:None
Required:False
Accept pipeline input:True
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

-ConflictResolutionPolicy

ConflictResolutionPolicy Object of type PSSqlConflictResolutionPolicy, when provided this is set as the ConflictResolutionPolicy of the container.

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

-ConflictResolutionPolicyMode

Can have the values: LastWriterWins, Custom, Manual. If provided along with ConflictResolutionPolicy parameter, it is ignored.

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

-ConflictResolutionPolicyPath

To be provided when the type is LastWriterWins. If provided along with ConflictResolutionPolicy parameter, it is ignored.

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

-ConflictResolutionPolicyProcedure

To be provided when the type is custom. If provided along with ConflictResolutionPolicy parameter, it is ignored.

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

-DatabaseName

Database name.

Type:String
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:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IndexingPolicy

Indexing Policy Object of type Microsoft.Azure.Commands.CosmosDB.PSSqlIndexingPolicy.

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

-Name

Container name.

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

-ParentObject

Sql Database object.

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

-PartitionKeyKind

The kind of algorithm used for partitioning. Possible values include: 'Hash', 'Range'

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

-PartitionKeyPath

Partition Key Path, e.g., '/address/zipcode'.

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

-PartitionKeyVersion

The version of the partition key definition

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

-ResourceGroupName

Name of resource group.

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

-Throughput

The throughput of SQL container (RU/s). Default value is 400.

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

-TtlInSeconds

Default Ttl in seconds. If the value is missing or set to - 1, items don't expire. If the value is set to n, items will expire n seconds after last modified time.

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

-UniqueKeyPolicy

UniqueKeyPolicy Object of type Microsoft.Azure.Commands.CosmosDB.PSSqlUniqueKeyPolicy.

Type:PSSqlUniqueKeyPolicy
Position:Named
Default value:None
Required:False
Accept pipeline input:True
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

Inputs

PSSqlIndexingPolicy

PSSqlUniqueKeyPolicy

PSSqlConflictResolutionPolicy

PSSqlDatabaseGetResults

Outputs

PSSqlDatabaseGetResults

ConflictingResourceException