Edit

Share via

New-AzCosmosDBVirtualNetworkRule

  • Reference
Module:
Az.CosmosDB

Create a new CosmosDB VirtualNetworkRule Object(PSVirtualNetworkRule).

Syntax

New-AzCosmosDBVirtualNetworkRule
   -Id <String>
   [-IgnoreMissingVNetServiceEndpoint <Boolean>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Create a new CosmosDB VirtualNetworkRule Object(PSVirtualNetworkRule).

Examples

Example 1

New-AzCosmosDBVirtualNetworkRule -Id "id" -IgnoreMissingVNetServiceEndpoint 0

Id  IgnoreMissingVNetServiceEndpoint
--   --------------------------------
{id}                            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

-Id

Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

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

-IgnoreMissingVNetServiceEndpoint

Boolean to indicate if to create firewall rule before the virtual network has vnet service endpoint enabled.

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

Inputs

None

Outputs

PSVirtualNetworkRule