Edit

Share via

Get-AzureRmDeploymentManagerServiceTopology

  • Reference
Module:
AzureRM.DeploymentManager

Gets a service topology.

Syntax

Get-AzureRmDeploymentManagerServiceTopology
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmDeploymentManagerServiceTopology
   [-ResourceId] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmDeploymentManagerServiceTopology
   [-ServiceTopology] <PSServiceTopologyResource>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureRmDeploymentManagerServiceTopology cmdlet gets a service topology.

You can modify this object locally, and then apply changes to the topology by using the Set-AzureRmDeploymentManagerServiceTopology cmdlet. Specify the service topology by its name and the resource group name. Alternately, you can provide the ServiceTopology object or the ResourceId.

Examples

Example 1

PS C:\> Get-AzureRmDeploymentManagerServiceTopology -ResourceGroupName ContosoResourceGroup -Name ContosoServiceTopology

This command gets a service topology named ContosoServiceTopology in the ContosoResourceGroup.

Example 2: Get a service topology using the resource identifier.

PS C:\> Get-AzureRmDeploymentManagerServiceTopology -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/serviceTopologies/ContosoServiceTopology"

This command gets a service topology named ContosoServiceTopology in the ContosoResourceGroup.

Example 3: Get a service topology using the service topology object.

PS C:\> Get-AzureRmDeploymentManagerService -ServiceTopology $serviceTopologyObject

This command gets a service topology whose name and ResourceGroup match the Name and ResourceGroupName properties of the $serviceTopologyObject, respectively.

Parameters

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

The name of the service topology.

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

-ResourceGroupName

The resource group.

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

-ResourceId

The resource identifier.

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

-ServiceTopology

Service topology resource object.

Type:Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

None

Outputs

Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource