Skip to content

Latest commit

 

History

History
215 lines (163 loc) · 5.88 KB

Get-AzureRmDeploymentManagerService.md

File metadata and controls

215 lines (163 loc) · 5.88 KB
Raw
external help file Module Name online version schema
Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml
AzureRM.DeploymentManager
2.0.0

Get-AzureRmDeploymentManagerService

SYNOPSIS

Gets a service in a service topology.

SYNTAX

Interactive (Default)

Get-AzureRmDeploymentManagerService [-ResourceGroupName] <String> [-ServiceTopologyName] <String>
 [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]

ByServiceTopologyObject

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

ByServiceTopologyResourceId

Get-AzureRmDeploymentManagerService [-ResourceGroupName] <String> [-Name] <String>
 [-ServiceTopologyResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]

ResourceId

Get-AzureRmDeploymentManagerService [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

InputObject

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: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzureRmContext, AzureCredential

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

-Name

The name of the service.

Type: System.String
Parameter Sets: Interactive, ByServiceTopologyObject, ByServiceTopologyResourceId
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ResourceGroupName

The resource group.

Type: System.String
Parameter Sets: Interactive, ByServiceTopologyObject, ByServiceTopologyResourceId
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ResourceId

The resource identifier.

Type: System.String
Parameter Sets: ResourceId
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Service

Service object.

Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource
Parameter Sets: InputObject
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ServiceTopology

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

Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource
Parameter Sets: ByServiceTopologyObject
Aliases:

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

-ServiceTopologyName

The name of the service topology.

Type: System.String
Parameter Sets: Interactive
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ServiceTopologyResourceId

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

Type: System.String
Parameter Sets: ByServiceTopologyResourceId
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

None

OUTPUTS

Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource

NOTES

RELATED LINKS

New-AzureRmDeploymentManagerService

Remove-AzureRmDeploymentManagerService

Set-AzureRmDeploymentManagerService