Get-AzCosmosDBService

Reference

Module:: Az.CosmosDB

Gets the CosmosDB Service

Syntax

Get-AzCosmosDBService
   -ResourceGroupName <String>
   -AccountName <String>
   [-ServiceName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzCosmosDBService
   [-ServiceName <String>]
   -ParentObject <PSDatabaseAccountGetResults>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzCosmosDBService cmdlet gets the list of all existing CosmosDB Services for a given ResourceGroupName, AccountName and DatabaseName and gets a single CosmosDB Service for a given ResourceGroupName, AccountName, DatabaseName and ServiceName.

Examples

Example 1

Get-AzCosmosDBService -AccountName "accountName" -ResourceGroupName "resourceGroupName" -ServiceName "sqlDedicatedGateway"

Name                     : sqlDedicatedGateway
Id                       : {Id}
Resource                 : Microsoft.Azure.Commands.CosmosDB.Models.PSServiceGetResults

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

-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

-ParentObject

CosmosDB Account object

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

-ServiceName

Unique ID (Guid) for the Role Definition.

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

Inputs

PSDatabaseAccountGetResults

Outputs

PSServiceGetResults