Edit

Share via

Get-AzureRmDeploymentManagerService

  • Reference
Module:
AzureRM.DeploymentManager

Gets a service in a service topology.

Syntax

Get-AzureRmDeploymentManagerService
   [-ResourceGroupName] <String>
   [-ServiceTopologyName] <String>
   [-Name] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmDeploymentManagerService
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-ServiceTopology] <PSServiceTopologyResource>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmDeploymentManagerService
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-ServiceTopologyResourceId] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmDeploymentManagerService
   [-ResourceId] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmDeploymentManagerService
   [-Service] <PSServiceResource>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureRmDeploymentManagerService cmdlet gets a service under a service topology, and returns an object that represents that service. Specify the service by its name, service topology it is in and the resource group name. Alternately, you can provide the Service object or the ResourceId.

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

Examples

Example 1

PS C:\> Get-AzureRmDeploymentManagerService -ResourceGroupName ContosoResourceGroup -ServiceTopologyName ContosoServiceTopology -Name ContosoService1

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

Example 2: Get a service using the resource identifier.

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

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

Example 3: Get a service using the service object.

PS C:\> Get-AzureRmDeploymentManagerService -Service $serviceObject

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

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

Service object.

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

-ServiceTopology

The service topology object in which the service 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.

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 should be created.

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

Inputs

None

Outputs

Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource