Edit

Share via

Get-AzureRmDeploymentManagerServiceUnit

  • Reference
Module:
AzureRM.DeploymentManager

Gets a service unit.

Syntax

Get-AzureRmDeploymentManagerServiceUnit
   [-ResourceGroupName] <String>
   [-ServiceTopologyName] <String>
   [-ServiceName] <String>
   [-Name] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmDeploymentManagerServiceUnit
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-Service] <PSServiceResource>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmDeploymentManagerServiceUnit
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-ServiceResourceId] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmDeploymentManagerServiceUnit
   [-ResourceGroupName] <String>
   [-ServiceName] <String>
   [-Name] <String>
   [-ServiceTopology] <PSServiceTopologyResource>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmDeploymentManagerServiceUnit
   [-ResourceGroupName] <String>
   [-ServiceName] <String>
   [-Name] <String>
   [-ServiceTopologyResourceId] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmDeploymentManagerServiceUnit
   [-ResourceId] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmDeploymentManagerServiceUnit
   [-ServiceUnit] <PSServiceUnitResource>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureRmDeploymentManagerServiceUnit cmdlet gets a service unit in a service.

Specify the service unit by its name, the service under which it was defined, the service topology name and the resource group name. Alternately, you can provide the ServiceUnit object or the ResourceId.

You can modify this object locally, and then apply changes to the service unit by using the Set-AzureRmDeploymentManagerServiceUnit cmdlet.

Examples

Example 1

PS C:\> Get-AzureRmDeploymentManagerServiceUnit -ResourceGroupName ContosoResourceGroup -ServiceTopologyName ContosoServiceTopology -ServiceName ContosoService1  -Name ContosoService1Storage

This command gets a service unit named ContosoService1Storage under a service ContosoService1 in a service topology named ContosoServiceTopology in the ContosoResourceGroup.

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

PS C:\> Get-AzureRmDeploymentManagerServiceUnit -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/serviceTopologies/ContosoServiceTopology/services/ContosoService1/serviceUnits/ContosoService1Storage"

This command gets a service unit named ContosoService1Storage under a service ContosoService1 in a service topology named ContosoServiceTopology in the ContosoResourceGroup.

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

PS C:\> Get-AzureRmDeploymentManagerServiceUnit -ServiceUnit $serviceUnitObject

This command gets a service unit whose name, service name, service topology name and ResourceGroup match the Name, ServiceName, ServiceTopologyName and ResourceGroupName properties of the $serviceUnitObject, 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 unit.

Type:String
Position:3
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

-Service

The service object in which the service unit should be created.

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

-ServiceName

The name of the service the service unit is part of.

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

-ServiceResourceId

The service resource identifier in which the service unit should be created.

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

-ServiceTopology

The service topology object in which the service unit should be created.

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

-ServiceTopologyName

The name of the service topology the service unit is part of.

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

-ServiceTopologyResourceId

The service topology resource identifier in which the service unit should be created.

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

-ServiceUnit

Service unit resource object.

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

Inputs

None

Outputs

Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceUnitResource