Edit

Share via

Get-AzCosmosDBService

Module:
Az.CosmosDB Module

Gets the CosmosDB Service

Syntax

ByNameParameterSet (Default) 

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

ByParentObjectParameterSet 

Get-AzCosmosDBService
    -ParentObject <PSDatabaseAccountGetResults>
    [-ServiceName <String>]
    [-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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByNameParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultProfile

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

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ParentObject

CosmosDB Account object

Parameter properties

Type:PSDatabaseAccountGetResults
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByParentObjectParameterSet
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

Name of resource group.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByNameParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ServiceName

Unique ID (Guid) for the Role Definition.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Inputs

PSDatabaseAccountGetResults

Outputs

PSServiceGetResults