diff --git a/azuredmps-0.9.0/AzureRM.DeploymentManager/AzureRM.DeploymentManager.md b/azuredmps-0.9.0/AzureRM.DeploymentManager/AzureRM.DeploymentManager.md index 59fd29f6a1..8290a1e376 100644 --- a/azuredmps-0.9.0/AzureRM.DeploymentManager/AzureRM.DeploymentManager.md +++ b/azuredmps-0.9.0/AzureRM.DeploymentManager/AzureRM.DeploymentManager.md @@ -1,85 +1,85 @@ ---- -Module Name: AzureRM.DeploymentManager -Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager -Help Version: 0.0.1.0 -Locale: en-US ---- - -# AzureRM.DeploymentManager Module -## Description -Deployment Manager enables you to use safe deployment practices when deploying your service across many regions. Azure Deployment Manager is in public preview. To learn how to sign up for the preview and use Azure Deployment Manager, see [Enable safe deployment practices with Azure Deployment Manager](https://docs.microsoft.com/en-us/azure/azure-resource-manager/deployment-manager-overview). For a tutorial, see [Use Azure Deployment Manager with Resource Manager templates](https://docs.microsoft.com/en-us/azure/azure-resource-manager/deployment-manager-tutorial>). - -## AzureRM.DeploymentManager Cmdlets -### [Get-AzureRmDeploymentManagerArtifactSource](Get-AzureRmDeploymentManagerArtifactSource.md) -Gets an artifact source. - -### [Get-AzureRmDeploymentManagerRollout](Get-AzureRmDeploymentManagerRollout.md) -Gets a rollout. - -### [Get-AzureRmDeploymentManagerService](Get-AzureRmDeploymentManagerService.md) -Gets a service in a service topology. - -### [Get-AzureRmDeploymentManagerServiceTopology](Get-AzureRmDeploymentManagerServiceTopology.md) -Gets a service topology. - -### [Get-AzureRmDeploymentManagerServiceUnit](Get-AzureRmDeploymentManagerServiceUnit.md) -Gets a service unit. - -### [Get-AzureRmDeploymentManagerStep](Get-AzureRmDeploymentManagerStep.md) -Gets the deployment step. - -### [New-AzureRmDeploymentManagerArtifactSource](New-AzureRmDeploymentManagerArtifactSource.md) -Creates an artifact source. - -### [New-AzureRmDeploymentManagerService](New-AzureRmDeploymentManagerService.md) -Creates a service in a service topology. - -### [New-AzureRmDeploymentManagerServiceTopology](New-AzureRmDeploymentManagerServiceTopology.md) -Creates a new service topology. - -### [New-AzureRmDeploymentManagerServiceUnit](New-AzureRmDeploymentManagerServiceUnit.md) -Creates a new service unit under a service in a service topology. - -### [New-AzureRmDeploymentManagerStep](New-AzureRmDeploymentManagerStep.md) -Creates a new deployment step. - -### [Remove-AzureRmDeploymentManagerArtifactSource](Remove-AzureRmDeploymentManagerArtifactSource.md) -Deletes an artifact source. - -### [Remove-AzureRmDeploymentManagerRollout](Remove-AzureRmDeploymentManagerRollout.md) -Deletes a rollout. - -### [Remove-AzureRmDeploymentManagerService](Remove-AzureRmDeploymentManagerService.md) -Deletes a service in a service topology. - -### [Remove-AzureRmDeploymentManagerServiceTopology](Remove-AzureRmDeploymentManagerServiceTopology.md) -Deletes a service topology and all its resources. - -### [Remove-AzureRmDeploymentManagerServiceUnit](Remove-AzureRmDeploymentManagerServiceUnit.md) -Deletes the service unit of a service in a service topology. - -### [Remove-AzureRmDeploymentManagerStep](Remove-AzureRmDeploymentManagerStep.md) -Deletes a step. - -### [Restart-AzureRmDeploymentManagerRollout](Restart-AzureRmDeploymentManagerRollout.md) -Restart a failed rollout. - -### [Set-AzureRmDeploymentManagerArtifactSource](Set-AzureRmDeploymentManagerArtifactSource.md) -Updates an artifact source. - -### [Set-AzureRmDeploymentManagerService](Set-AzureRmDeploymentManagerService.md) -Updates a service in service topology. - -### [Set-AzureRmDeploymentManagerServiceTopology](Set-AzureRmDeploymentManagerServiceTopology.md) -Updates the service topology. - -### [Set-AzureRmDeploymentManagerServiceUnit](Set-AzureRmDeploymentManagerServiceUnit.md) -Updates a service unit. - -### [Set-AzureRmDeploymentManagerStep](Set-AzureRmDeploymentManagerStep.md) -Updates a step. - -### [Stop-AzureRmDeploymentManagerRollout](Stop-AzureRmDeploymentManagerRollout.md) -Stops a rollout in progress. - +--- +Module Name: AzureRM.DeploymentManager +Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager +Help Version: 0.0.1.0 +Locale: en-US +--- + +# AzureRM.DeploymentManager Module +## Description +Deployment Manager enables you to use safe deployment practices when deploying your service across many regions. Azure Deployment Manager is in public preview. To learn how to sign up for the preview and use Azure Deployment Manager, see [Enable safe deployment practices with Azure Deployment Manager](https://docs.microsoft.com/en-us/azure/azure-resource-manager/deployment-manager-overview). For a tutorial, see [Use Azure Deployment Manager with Resource Manager templates](https://docs.microsoft.com/en-us/azure/azure-resource-manager/deployment-manager-tutorial>). + +## AzureRM.DeploymentManager Cmdlets +### [Get-AzureRmDeploymentManagerArtifactSource](Get-AzureRmDeploymentManagerArtifactSource.md) +Gets an artifact source. + +### [Get-AzureRmDeploymentManagerRollout](Get-AzureRmDeploymentManagerRollout.md) +Gets a rollout. + +### [Get-AzureRmDeploymentManagerService](Get-AzureRmDeploymentManagerService.md) +Gets a service in a service topology. + +### [Get-AzureRmDeploymentManagerServiceTopology](Get-AzureRmDeploymentManagerServiceTopology.md) +Gets a service topology. + +### [Get-AzureRmDeploymentManagerServiceUnit](Get-AzureRmDeploymentManagerServiceUnit.md) +Gets a service unit. + +### [Get-AzureRmDeploymentManagerStep](Get-AzureRmDeploymentManagerStep.md) +Gets the deployment step. + +### [New-AzureRmDeploymentManagerArtifactSource](New-AzureRmDeploymentManagerArtifactSource.md) +Creates an artifact source. + +### [New-AzureRmDeploymentManagerService](New-AzureRmDeploymentManagerService.md) +Creates a service in a service topology. + +### [New-AzureRmDeploymentManagerServiceTopology](New-AzureRmDeploymentManagerServiceTopology.md) +Creates a new service topology. + +### [New-AzureRmDeploymentManagerServiceUnit](New-AzureRmDeploymentManagerServiceUnit.md) +Creates a new service unit under a service in a service topology. + +### [New-AzureRmDeploymentManagerStep](New-AzureRmDeploymentManagerStep.md) +Creates a new deployment step. + +### [Remove-AzureRmDeploymentManagerArtifactSource](Remove-AzureRmDeploymentManagerArtifactSource.md) +Deletes an artifact source. + +### [Remove-AzureRmDeploymentManagerRollout](Remove-AzureRmDeploymentManagerRollout.md) +Deletes a rollout. + +### [Remove-AzureRmDeploymentManagerService](Remove-AzureRmDeploymentManagerService.md) +Deletes a service in a service topology. + +### [Remove-AzureRmDeploymentManagerServiceTopology](Remove-AzureRmDeploymentManagerServiceTopology.md) +Deletes a service topology and all its resources. + +### [Remove-AzureRmDeploymentManagerServiceUnit](Remove-AzureRmDeploymentManagerServiceUnit.md) +Deletes the service unit of a service in a service topology. + +### [Remove-AzureRmDeploymentManagerStep](Remove-AzureRmDeploymentManagerStep.md) +Deletes a step. + +### [Restart-AzureRmDeploymentManagerRollout](Restart-AzureRmDeploymentManagerRollout.md) +Restart a failed rollout. + +### [Set-AzureRmDeploymentManagerArtifactSource](Set-AzureRmDeploymentManagerArtifactSource.md) +Updates an artifact source. + +### [Set-AzureRmDeploymentManagerService](Set-AzureRmDeploymentManagerService.md) +Updates a service in service topology. + +### [Set-AzureRmDeploymentManagerServiceTopology](Set-AzureRmDeploymentManagerServiceTopology.md) +Updates the service topology. + +### [Set-AzureRmDeploymentManagerServiceUnit](Set-AzureRmDeploymentManagerServiceUnit.md) +Updates a service unit. + +### [Set-AzureRmDeploymentManagerStep](Set-AzureRmDeploymentManagerStep.md) +Updates a step. + +### [Stop-AzureRmDeploymentManagerRollout](Stop-AzureRmDeploymentManagerRollout.md) +Stops a rollout in progress. + diff --git a/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerArtifactSource.md b/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerArtifactSource.md index 9d7b3cb551..4097e7072e 100644 --- a/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerArtifactSource.md +++ b/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerArtifactSource.md @@ -1,158 +1,158 @@ ---- -external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml -Module Name: AzureRM.DeploymentManager -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/get-azurermdeploymentmanagerartifactsource -schema: 2.0.0 ---- - -# Get-AzureRmDeploymentManagerArtifactSource - -## SYNOPSIS -Gets an artifact source. - -## SYNTAX - -### Interactive (Default) -``` -Get-AzureRmDeploymentManagerArtifactSource [-ResourceGroupName] [-Name] - [-DefaultProfile ] [] -``` - -### ResourceId -``` -Get-AzureRmDeploymentManagerArtifactSource [-ResourceId] [-DefaultProfile ] - [] -``` - -### InputObject -``` -Get-AzureRmDeploymentManagerArtifactSource [-ArtifactSource] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmDeploymentManagerArtifactSource** cmdlet gets an artifact source, and returns an object that represents that artifact source. -Specify the artifact source by its name and resource group name. Alternately, you can provide the ArtifactSource object or the ResourceId. - -You can modify this object locally, and then apply changes to the artifact source by using the Set-AzureRmDeploymentManagerArtifactSource cmdlet. - -## EXAMPLES - -### Example 1: Get an artifact source -```powershell -PS C:\> Get-AzureRmDeploymentManagerArtifactSource -ResourceGroupName "ContosoResourceGroup" -Name "ContosoArtifactSource" -``` - -This command gets an artifact source named ContosoArtifactSource in ContosoResourceGroup. - -### Example 2: Get an artifact source using the resource identifier -```powershell -PS C:\> Get-AzureRmDeploymentManagerArtifactSource -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/artifactSources/ContosoArtifactSource" -``` - -This command gets an artifact source named ContosoArtifactSource in ContosoResourceGroup. - -### Example 3: Get an artifact source using an object returned by New-AzureRmDeploymentManagerArtifactSource -```powershell -PS C:\> Get-AzureRmDeploymentManagerArtifactSource -ArtifactSource $artifactSourceObject -``` - -This command gets an artifact source whose name and ResourceGroup match the Name and ResourceGroupName properties of the $artifactSourceObject, respectively. - -## PARAMETERS - -### -ArtifactSource -Artifact Source object. - -```yaml -Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSArtifactSource -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -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 artifact source. - -```yaml -Type: System.String -Parameter Sets: Interactive -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group. - -```yaml -Type: System.String -Parameter Sets: Interactive -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource identifier. - -```yaml -Type: System.String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.DeploymentManager.Models.PSArtifactSource - -## NOTES - -## RELATED LINKS - -[New-AzureRmDeploymentManagerArtifactSource](./New-AzureRmDeploymentManagerArtifactSource.md) - -[Remove-AzureRmDeploymentManagerArtifactSource](./Remove-AzureRmDeploymentManagerArtifactSource.md) - +--- +external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml +Module Name: AzureRM.DeploymentManager +online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/get-azurermdeploymentmanagerartifactsource +schema: 2.0.0 +--- + +# Get-AzureRmDeploymentManagerArtifactSource + +## SYNOPSIS +Gets an artifact source. + +## SYNTAX + +### Interactive (Default) +``` +Get-AzureRmDeploymentManagerArtifactSource [-ResourceGroupName] [-Name] + [-DefaultProfile ] [] +``` + +### ResourceId +``` +Get-AzureRmDeploymentManagerArtifactSource [-ResourceId] [-DefaultProfile ] + [] +``` + +### InputObject +``` +Get-AzureRmDeploymentManagerArtifactSource [-ArtifactSource] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzureRmDeploymentManagerArtifactSource** cmdlet gets an artifact source, and returns an object that represents that artifact source. +Specify the artifact source by its name and resource group name. Alternately, you can provide the ArtifactSource object or the ResourceId. + +You can modify this object locally, and then apply changes to the artifact source by using the Set-AzureRmDeploymentManagerArtifactSource cmdlet. + +## EXAMPLES + +### Example 1: Get an artifact source +```powershell +PS C:\> Get-AzureRmDeploymentManagerArtifactSource -ResourceGroupName "ContosoResourceGroup" -Name "ContosoArtifactSource" +``` + +This command gets an artifact source named ContosoArtifactSource in ContosoResourceGroup. + +### Example 2: Get an artifact source using the resource identifier +```powershell +PS C:\> Get-AzureRmDeploymentManagerArtifactSource -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/artifactSources/ContosoArtifactSource" +``` + +This command gets an artifact source named ContosoArtifactSource in ContosoResourceGroup. + +### Example 3: Get an artifact source using an object returned by New-AzureRmDeploymentManagerArtifactSource +```powershell +PS C:\> Get-AzureRmDeploymentManagerArtifactSource -ArtifactSource $artifactSourceObject +``` + +This command gets an artifact source whose name and ResourceGroup match the Name and ResourceGroupName properties of the $artifactSourceObject, respectively. + +## PARAMETERS + +### -ArtifactSource +Artifact Source object. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSArtifactSource +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +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 artifact source. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +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 (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSArtifactSource + +## NOTES + +## RELATED LINKS + +[New-AzureRmDeploymentManagerArtifactSource](./New-AzureRmDeploymentManagerArtifactSource.md) + +[Remove-AzureRmDeploymentManagerArtifactSource](./Remove-AzureRmDeploymentManagerArtifactSource.md) + [Set-AzureRmDeploymentManagerArtifactSource](./Set-AzureRmDeploymentManagerArtifactSource.md) \ No newline at end of file diff --git a/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerRollout.md b/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerRollout.md index 0a201e3e64..a06ea6ad8e 100644 --- a/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerRollout.md +++ b/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerRollout.md @@ -1,171 +1,171 @@ ---- -external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml -Module Name: AzureRM.DeploymentManager -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/get-azurermdeploymentmanagerrollout -schema: 2.0.0 ---- - -# Get-AzureRmDeploymentManagerRollout - -## SYNOPSIS -Gets a rollout. - -## SYNTAX - -### Interactive (Default) -``` -Get-AzureRmDeploymentManagerRollout [-ResourceGroupName] [-Name] [[-RetryAttempt] ] - [-DefaultProfile ] [] -``` - -### ResourceId -``` -Get-AzureRmDeploymentManagerRollout [-ResourceId] [-DefaultProfile ] - [] -``` - -### InputObject -``` -Get-AzureRmDeploymentManagerRollout [-Rollout] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Get-AzureRmDeploymentManagerRollout** cmdlet gets a rollout, and returns an object that represents that rollout with all the detailed information on the progress of the rollout. -Specify the rollout by its name and resource group name. Alternately, you can provide the Rollout object or the ResourceId. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmDeploymentManagerRollout -ResourceGroupName ContosoResourceGroup -Name ContosoRollout -``` - -This command gets a rollout named ContosoRollout in the ContosoResourceGroup. - -### Example 2: Get a rollout using the resource identifier -```powershell -PS C:\> Get-AzureRmDeploymentManagerRollout -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/rollouts/ContosoRollout" -``` - -This command gets a rollout named ContosoRollout in the ContosoResourceGroup. - -### Example 3: Get a rollout using the rollout object. -```powershell -PS C:\> Get-AzureRmDeploymentManagerRollout -Rollout $rolloutObject -``` - -This command gets a rollout whose name and ResourceGroup match the Name and ResourceGroupName properties of the $rolloutObject, respectively. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -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 rollout. - -```yaml -Type: System.String -Parameter Sets: Interactive -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group. - -```yaml -Type: System.String -Parameter Sets: Interactive -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource identifier. - -```yaml -Type: System.String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RetryAttempt -The retry attempt of the rollout. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: Interactive -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Rollout -Rollout object. - -```yaml -Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout - -## NOTES - -## RELATED LINKS - -[Stop-AzureRmDeploymentManagerRollout](./Stop-AzureRmDeploymentManagerRollout.md) - -[Restart-AzureRmDeploymentManagerRollout](./Restart-AzureRmDeploymentManagerRollout.md) - +--- +external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml +Module Name: AzureRM.DeploymentManager +online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/get-azurermdeploymentmanagerrollout +schema: 2.0.0 +--- + +# Get-AzureRmDeploymentManagerRollout + +## SYNOPSIS +Gets a rollout. + +## SYNTAX + +### Interactive (Default) +``` +Get-AzureRmDeploymentManagerRollout [-ResourceGroupName] [-Name] [[-RetryAttempt] ] + [-DefaultProfile ] [] +``` + +### ResourceId +``` +Get-AzureRmDeploymentManagerRollout [-ResourceId] [-DefaultProfile ] + [] +``` + +### InputObject +``` +Get-AzureRmDeploymentManagerRollout [-Rollout] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Get-AzureRmDeploymentManagerRollout** cmdlet gets a rollout, and returns an object that represents that rollout with all the detailed information on the progress of the rollout. +Specify the rollout by its name and resource group name. Alternately, you can provide the Rollout object or the ResourceId. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-AzureRmDeploymentManagerRollout -ResourceGroupName ContosoResourceGroup -Name ContosoRollout +``` + +This command gets a rollout named ContosoRollout in the ContosoResourceGroup. + +### Example 2: Get a rollout using the resource identifier +```powershell +PS C:\> Get-AzureRmDeploymentManagerRollout -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/rollouts/ContosoRollout" +``` + +This command gets a rollout named ContosoRollout in the ContosoResourceGroup. + +### Example 3: Get a rollout using the rollout object. +```powershell +PS C:\> Get-AzureRmDeploymentManagerRollout -Rollout $rolloutObject +``` + +This command gets a rollout whose name and ResourceGroup match the Name and ResourceGroupName properties of the $rolloutObject, respectively. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +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 rollout. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RetryAttempt +The retry attempt of the rollout. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: Interactive +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Rollout +Rollout object. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +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 (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout + +## NOTES + +## RELATED LINKS + +[Stop-AzureRmDeploymentManagerRollout](./Stop-AzureRmDeploymentManagerRollout.md) + +[Restart-AzureRmDeploymentManagerRollout](./Restart-AzureRmDeploymentManagerRollout.md) + [Remove-AzureRmDeploymentManagerRollout](./Remove-AzureRmDeploymentManagerRollout.md) \ No newline at end of file diff --git a/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerService.md b/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerService.md index 5755a1beb8..4d60b58988 100644 --- a/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerService.md +++ b/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerService.md @@ -1,216 +1,216 @@ ---- -external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml -Module Name: AzureRM.DeploymentManager -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/get-azurermdeploymentmanagerservice -schema: 2.0.0 -content_git_url: ---- - -# Get-AzureRmDeploymentManagerService - -## SYNOPSIS -Gets a service in a service topology. - -## SYNTAX - -### Interactive (Default) -``` -Get-AzureRmDeploymentManagerService [-ResourceGroupName] [-ServiceTopologyName] - [-Name] [-DefaultProfile ] [] -``` - -### ByServiceTopologyObject -``` -Get-AzureRmDeploymentManagerService [-ResourceGroupName] [-Name] - [-ServiceTopology] [-DefaultProfile ] [] -``` - -### ByServiceTopologyResourceId -``` -Get-AzureRmDeploymentManagerService [-ResourceGroupName] [-Name] - [-ServiceTopologyResourceId] [-DefaultProfile ] [] -``` - -### ResourceId -``` -Get-AzureRmDeploymentManagerService [-ResourceId] [-DefaultProfile ] - [] -``` - -### InputObject -``` -Get-AzureRmDeploymentManagerService [-Service] [-DefaultProfile ] - [] -``` - -## 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 -```powershell -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. -```powershell -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. -```powershell -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. - -```yaml -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. - -```yaml -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. - -```yaml -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. - -```yaml -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. - -```yaml -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. - -```yaml -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. - -```yaml -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. - -```yaml -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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource - -## NOTES - -## RELATED LINKS - -[New-AzureRmDeploymentManagerService](./New-AzureRmDeploymentManagerService.md) - -[Remove-AzureRmDeploymentManagerService](./Remove-AzureRmDeploymentManagerService.md) - +--- +external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml +Module Name: AzureRM.DeploymentManager +online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/get-azurermdeploymentmanagerservice +schema: 2.0.0 +content_git_url: +--- + +# Get-AzureRmDeploymentManagerService + +## SYNOPSIS +Gets a service in a service topology. + +## SYNTAX + +### Interactive (Default) +``` +Get-AzureRmDeploymentManagerService [-ResourceGroupName] [-ServiceTopologyName] + [-Name] [-DefaultProfile ] [] +``` + +### ByServiceTopologyObject +``` +Get-AzureRmDeploymentManagerService [-ResourceGroupName] [-Name] + [-ServiceTopology] [-DefaultProfile ] [] +``` + +### ByServiceTopologyResourceId +``` +Get-AzureRmDeploymentManagerService [-ResourceGroupName] [-Name] + [-ServiceTopologyResourceId] [-DefaultProfile ] [] +``` + +### ResourceId +``` +Get-AzureRmDeploymentManagerService [-ResourceId] [-DefaultProfile ] + [] +``` + +### InputObject +``` +Get-AzureRmDeploymentManagerService [-Service] [-DefaultProfile ] + [] +``` + +## 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 +```powershell +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. +```powershell +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. +```powershell +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. + +```yaml +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. + +```yaml +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. + +```yaml +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. + +```yaml +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. + +```yaml +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. + +```yaml +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. + +```yaml +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. + +```yaml +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 (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource + +## NOTES + +## RELATED LINKS + +[New-AzureRmDeploymentManagerService](./New-AzureRmDeploymentManagerService.md) + +[Remove-AzureRmDeploymentManagerService](./Remove-AzureRmDeploymentManagerService.md) + [Set-AzureRmDeploymentManagerService](./Set-AzureRmDeploymentManagerService.md) \ No newline at end of file diff --git a/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerServiceTopology.md b/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerServiceTopology.md index 69187f2ff5..4530d3777f 100644 --- a/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerServiceTopology.md +++ b/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerServiceTopology.md @@ -1,158 +1,158 @@ ---- -external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml -Module Name: AzureRM.DeploymentManager -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/get-azurermdeploymentmanagerservicetopology -schema: 2.0.0 ---- - -# Get-AzureRmDeploymentManagerServiceTopology - -## SYNOPSIS -Gets a service topology. - -## SYNTAX - -### Interactive (Default) -``` -Get-AzureRmDeploymentManagerServiceTopology [-ResourceGroupName] [-Name] - [-DefaultProfile ] [] -``` - -### ResourceId -``` -Get-AzureRmDeploymentManagerServiceTopology [-ResourceId] [-DefaultProfile ] - [] -``` - -### InputObject -``` -Get-AzureRmDeploymentManagerServiceTopology [-ServiceTopology] - [-DefaultProfile ] [] -``` - -## 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 -```powershell -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. -```powershell -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. -```powershell -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. - -```yaml -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 topology. - -```yaml -Type: System.String -Parameter Sets: Interactive -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group. - -```yaml -Type: System.String -Parameter Sets: Interactive -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource identifier. - -```yaml -Type: System.String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceTopology -Service topology resource object. - -```yaml -Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource - -## NOTES - -## RELATED LINKS - -[New-AzureRmDeploymentManagerServiceTopology](./New-AzureRmDeploymentManagerServiceTopology.md) - -[Remove-AzureRmDeploymentManagerServiceTopology](./Remove-AzureRmDeploymentManagerServiceTopology.md) - +--- +external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml +Module Name: AzureRM.DeploymentManager +online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/get-azurermdeploymentmanagerservicetopology +schema: 2.0.0 +--- + +# Get-AzureRmDeploymentManagerServiceTopology + +## SYNOPSIS +Gets a service topology. + +## SYNTAX + +### Interactive (Default) +``` +Get-AzureRmDeploymentManagerServiceTopology [-ResourceGroupName] [-Name] + [-DefaultProfile ] [] +``` + +### ResourceId +``` +Get-AzureRmDeploymentManagerServiceTopology [-ResourceId] [-DefaultProfile ] + [] +``` + +### InputObject +``` +Get-AzureRmDeploymentManagerServiceTopology [-ServiceTopology] + [-DefaultProfile ] [] +``` + +## 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 +```powershell +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. +```powershell +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. +```powershell +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. + +```yaml +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 topology. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceTopology +Service topology resource object. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +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 (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource + +## NOTES + +## RELATED LINKS + +[New-AzureRmDeploymentManagerServiceTopology](./New-AzureRmDeploymentManagerServiceTopology.md) + +[Remove-AzureRmDeploymentManagerServiceTopology](./Remove-AzureRmDeploymentManagerServiceTopology.md) + [Set-AzureRmDeploymentManagerServiceTopology](./Set-AzureRmDeploymentManagerServiceTopology.md) \ No newline at end of file diff --git a/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerServiceUnit.md b/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerServiceUnit.md index c73968c19a..73c64085d7 100644 --- a/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerServiceUnit.md +++ b/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerServiceUnit.md @@ -1,273 +1,273 @@ ---- -external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml -Module Name: AzureRM.DeploymentManager -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/get-azurermdeploymentmanagerserviceunit -schema: 2.0.0 ---- - -# Get-AzureRmDeploymentManagerServiceUnit - -## SYNOPSIS -Gets a service unit. - -## SYNTAX - -### Interactive (Default) -``` -Get-AzureRmDeploymentManagerServiceUnit [-ResourceGroupName] [-ServiceTopologyName] - [-ServiceName] [-Name] [-DefaultProfile ] [] -``` - -### ByServiceObject -``` -Get-AzureRmDeploymentManagerServiceUnit [-ResourceGroupName] [-Name] - [-Service] [-DefaultProfile ] [] -``` - -### ByServiceResourceId -``` -Get-AzureRmDeploymentManagerServiceUnit [-ResourceGroupName] [-Name] - [-ServiceResourceId] [-DefaultProfile ] [] -``` - -### ByTopologyObjectAndServiceName -``` -Get-AzureRmDeploymentManagerServiceUnit [-ResourceGroupName] [-ServiceName] [-Name] - [-ServiceTopology] [-DefaultProfile ] [] -``` - -### ByTopologyResourceAndServiceName -``` -Get-AzureRmDeploymentManagerServiceUnit [-ResourceGroupName] [-ServiceName] [-Name] - [-ServiceTopologyResourceId] [-DefaultProfile ] [] -``` - -### ResourceId -``` -Get-AzureRmDeploymentManagerServiceUnit [-ResourceId] [-DefaultProfile ] - [] -``` - -### InputObject -``` -Get-AzureRmDeploymentManagerServiceUnit [-ServiceUnit] - [-DefaultProfile ] [] -``` - -## 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 -```powershell -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. -```powershell -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. -```powershell -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. - -```yaml -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 unit. - -```yaml -Type: System.String -Parameter Sets: Interactive, ByServiceObject, ByServiceResourceId, ByTopologyObjectAndServiceName, ByTopologyResourceAndServiceName -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group. - -```yaml -Type: System.String -Parameter Sets: Interactive, ByServiceObject, ByServiceResourceId, ByTopologyObjectAndServiceName, ByTopologyResourceAndServiceName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource identifier. - -```yaml -Type: System.String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Service -The service object in which the service unit should be created. - -```yaml -Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource -Parameter Sets: ByServiceObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceName -The name of the service the service unit is part of. - -```yaml -Type: System.String -Parameter Sets: Interactive, ByTopologyObjectAndServiceName, ByTopologyResourceAndServiceName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceResourceId -The service resource identifier in which the service unit should be created. - -```yaml -Type: System.String -Parameter Sets: ByServiceResourceId -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceTopology -The service topology object in which the service unit should be created. - -```yaml -Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource -Parameter Sets: ByTopologyObjectAndServiceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceTopologyName -The name of the service topology the service unit is part of. - -```yaml -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 unit should be created. - -```yaml -Type: System.String -Parameter Sets: ByTopologyResourceAndServiceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceUnit -Service unit resource object. - -```yaml -Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceUnitResource -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceUnitResource - -## NOTES - -## RELATED LINKS - -[New-AzureRmDeploymentManagerServiceUnit](./New-AzureRmDeploymentManagerServiceUnit.md) - -[Remove-AzureRmDeploymentManagerServiceUnit](./Remove-AzureRmDeploymentManagerServiceUnit.md) - +--- +external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml +Module Name: AzureRM.DeploymentManager +online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/get-azurermdeploymentmanagerserviceunit +schema: 2.0.0 +--- + +# Get-AzureRmDeploymentManagerServiceUnit + +## SYNOPSIS +Gets a service unit. + +## SYNTAX + +### Interactive (Default) +``` +Get-AzureRmDeploymentManagerServiceUnit [-ResourceGroupName] [-ServiceTopologyName] + [-ServiceName] [-Name] [-DefaultProfile ] [] +``` + +### ByServiceObject +``` +Get-AzureRmDeploymentManagerServiceUnit [-ResourceGroupName] [-Name] + [-Service] [-DefaultProfile ] [] +``` + +### ByServiceResourceId +``` +Get-AzureRmDeploymentManagerServiceUnit [-ResourceGroupName] [-Name] + [-ServiceResourceId] [-DefaultProfile ] [] +``` + +### ByTopologyObjectAndServiceName +``` +Get-AzureRmDeploymentManagerServiceUnit [-ResourceGroupName] [-ServiceName] [-Name] + [-ServiceTopology] [-DefaultProfile ] [] +``` + +### ByTopologyResourceAndServiceName +``` +Get-AzureRmDeploymentManagerServiceUnit [-ResourceGroupName] [-ServiceName] [-Name] + [-ServiceTopologyResourceId] [-DefaultProfile ] [] +``` + +### ResourceId +``` +Get-AzureRmDeploymentManagerServiceUnit [-ResourceId] [-DefaultProfile ] + [] +``` + +### InputObject +``` +Get-AzureRmDeploymentManagerServiceUnit [-ServiceUnit] + [-DefaultProfile ] [] +``` + +## 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 +```powershell +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. +```powershell +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. +```powershell +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. + +```yaml +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 unit. + +```yaml +Type: System.String +Parameter Sets: Interactive, ByServiceObject, ByServiceResourceId, ByTopologyObjectAndServiceName, ByTopologyResourceAndServiceName +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive, ByServiceObject, ByServiceResourceId, ByTopologyObjectAndServiceName, ByTopologyResourceAndServiceName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Service +The service object in which the service unit should be created. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource +Parameter Sets: ByServiceObject +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the service the service unit is part of. + +```yaml +Type: System.String +Parameter Sets: Interactive, ByTopologyObjectAndServiceName, ByTopologyResourceAndServiceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceResourceId +The service resource identifier in which the service unit should be created. + +```yaml +Type: System.String +Parameter Sets: ByServiceResourceId +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopology +The service topology object in which the service unit should be created. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource +Parameter Sets: ByTopologyObjectAndServiceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopologyName +The name of the service topology the service unit is part of. + +```yaml +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 unit should be created. + +```yaml +Type: System.String +Parameter Sets: ByTopologyResourceAndServiceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceUnit +Service unit resource object. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceUnitResource +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +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 (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceUnitResource + +## NOTES + +## RELATED LINKS + +[New-AzureRmDeploymentManagerServiceUnit](./New-AzureRmDeploymentManagerServiceUnit.md) + +[Remove-AzureRmDeploymentManagerServiceUnit](./Remove-AzureRmDeploymentManagerServiceUnit.md) + [Set-AzureRmDeploymentManagerServiceUnit](./Set-AzureRmDeploymentManagerServiceUnit.md) \ No newline at end of file diff --git a/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerStep.md b/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerStep.md index 0ce93abb15..d9d1d53c48 100644 --- a/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerStep.md +++ b/azuredmps-0.9.0/AzureRM.DeploymentManager/Get-AzureRmDeploymentManagerStep.md @@ -1,156 +1,156 @@ ---- -external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml -Module Name: AzureRM.DeploymentManager -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/get-azurermdeploymentmanagerstep -schema: 2.0.0 ---- - -# Get-AzureRmDeploymentManagerStep - -## SYNOPSIS -Gets the deployment step. - -## SYNTAX - -### Interactive (Default) -``` -Get-AzureRmDeploymentManagerStep [-ResourceGroupName] [-Name] - [-DefaultProfile ] [] -``` - -### ResourceId -``` -Get-AzureRmDeploymentManagerStep [-ResourceId] [-DefaultProfile ] - [] -``` - -### InputObject -``` -Get-AzureRmDeploymentManagerStep [-Step] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Get-AzureRmDeploymentManagerStep** cmdlet gets a step, and returns an object that represents that step. -Specify the step by its name and resource group name. Alternately, you can provide the Step object or the ResourceId. - -You can modify this object locally, and then apply changes to the artifact source by using the Set-AzureRmDeploymentManagerStep cmdlet. - -## EXAMPLES - -### Example 1: Get a step -```powershell -PS C:\> New-AzureRmDeploymentManagerStep -ResourceGroupName ContosoResourceGroup -Name ContosoService1WaitStep -``` - -This command gets a step named ContosoService1WaitStep in ContosoResourceGroup. - -### Example 2: Get a step using the resource identifier -```powershell -PS C:\> Get-AzureRmDeploymentManagerStep -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/steps/ContosoService1WaitStep" -``` - -This command gets a step named ContosoService1WaitStep in ContosoResourceGroup. - -### Example 3: Get a step using an object returned by New-AzureRmDeploymentManagerStep -```powershell -PS C:\> Get-AzureRmDeploymentManagerStep -Step $stepObject -``` - - This command gets a step whose name and ResourceGroup match the Name and ResourceGroupName properties of the $stepObject, respectively. - - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -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 step. - -```yaml -Type: System.String -Parameter Sets: Interactive -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group. - -```yaml -Type: System.String -Parameter Sets: Interactive -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource identifier. - -```yaml -Type: System.String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Step -The step resource object. - -```yaml -Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSStepResource -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DeploymentManager.Models.PSStepResource - -## OUTPUTS - -### Microsoft.Azure.Commands.DeploymentManager.Models.PSStepResource - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml +Module Name: AzureRM.DeploymentManager +online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/get-azurermdeploymentmanagerstep +schema: 2.0.0 +--- + +# Get-AzureRmDeploymentManagerStep + +## SYNOPSIS +Gets the deployment step. + +## SYNTAX + +### Interactive (Default) +``` +Get-AzureRmDeploymentManagerStep [-ResourceGroupName] [-Name] + [-DefaultProfile ] [] +``` + +### ResourceId +``` +Get-AzureRmDeploymentManagerStep [-ResourceId] [-DefaultProfile ] + [] +``` + +### InputObject +``` +Get-AzureRmDeploymentManagerStep [-Step] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Get-AzureRmDeploymentManagerStep** cmdlet gets a step, and returns an object that represents that step. +Specify the step by its name and resource group name. Alternately, you can provide the Step object or the ResourceId. + +You can modify this object locally, and then apply changes to the artifact source by using the Set-AzureRmDeploymentManagerStep cmdlet. + +## EXAMPLES + +### Example 1: Get a step +```powershell +PS C:\> New-AzureRmDeploymentManagerStep -ResourceGroupName ContosoResourceGroup -Name ContosoService1WaitStep +``` + +This command gets a step named ContosoService1WaitStep in ContosoResourceGroup. + +### Example 2: Get a step using the resource identifier +```powershell +PS C:\> Get-AzureRmDeploymentManagerStep -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/steps/ContosoService1WaitStep" +``` + +This command gets a step named ContosoService1WaitStep in ContosoResourceGroup. + +### Example 3: Get a step using an object returned by New-AzureRmDeploymentManagerStep +```powershell +PS C:\> Get-AzureRmDeploymentManagerStep -Step $stepObject +``` + + This command gets a step whose name and ResourceGroup match the Name and ResourceGroupName properties of the $stepObject, respectively. + + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +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 step. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Step +The step resource object. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSStepResource +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +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 (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSStepResource + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSStepResource + +## NOTES + +## RELATED LINKS diff --git a/azuredmps-0.9.0/AzureRM.DeploymentManager/New-AzureRmDeploymentManagerArtifactSource.md b/azuredmps-0.9.0/AzureRM.DeploymentManager/New-AzureRmDeploymentManagerArtifactSource.md index 30726b2d58..3d7925bad7 100644 --- a/azuredmps-0.9.0/AzureRM.DeploymentManager/New-AzureRmDeploymentManagerArtifactSource.md +++ b/azuredmps-0.9.0/AzureRM.DeploymentManager/New-AzureRmDeploymentManagerArtifactSource.md @@ -1,194 +1,194 @@ ---- -external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml -Module Name: AzureRM.DeploymentManager -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/new-azurermdeploymentmanagerartifactsource -schema: 2.0.0 ---- - -# New-AzureRmDeploymentManagerArtifactSource - -## SYNOPSIS -Creates an artifact source. - -## SYNTAX - -``` -New-AzureRmDeploymentManagerArtifactSource -ResourceGroupName -Name -Location - -SasUri [-Tag ] [-ArtifactRoot ] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **New-AzureRmDeploymentManagerArtifactSource** cmdlet creates an artifact source. -Specify the *Name*, *ResourceGroupName* and required properties. - -You can modify the returned object locally and then apply the changes to the artifact source by using the Set-AzureRmDeploymentManagerArtifactSource cmdlet. - -The cmdlet returns an ArtifactSource object that has a ResourceId which can be referenced in the New-AzureRmDeloymentManagerServiceTopology cmdlet so that artifacts required for a ServiceUnit resource, the Template and Parameters files, can be referenced from this location. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmDeploymentManagerArtifactSource -ResourceGroupName ContosoResourceGroup -Name ContosoArtifactSource -Location "Central US" -SasUri "https://ContosoStorage.blob.core.windows.net/ContosoArtifacts?sasParameters" -``` - -Creates an artifact source in the ContosoResourceGroup with the name ContosoArtifactSource with Central US as the location of the resource. The SasUri property provides an Azure Storage SAS Uri to the storage container where the artifacts are stored. - -## PARAMETERS - -### -ArtifactRoot -The optional directory offset under the storage container for the artifacts. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -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 -``` - -### -Location -The location of the resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the artifact source. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SasUri -The SAS Uri to the Azure storage container where the artifacts are stored. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -A hash table which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.DeploymentManager.Models.PSArtifactSource - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDeploymentManagerArtifactSource](./Get-AzureRmDeploymentManagerArtifactSource.md) - -[Remove-AzureRmDeploymentManagerArtifactSource](./Remove-AzureRmDeploymentManagerArtifactSource.md) - +--- +external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml +Module Name: AzureRM.DeploymentManager +online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/new-azurermdeploymentmanagerartifactsource +schema: 2.0.0 +--- + +# New-AzureRmDeploymentManagerArtifactSource + +## SYNOPSIS +Creates an artifact source. + +## SYNTAX + +``` +New-AzureRmDeploymentManagerArtifactSource -ResourceGroupName -Name -Location + -SasUri [-Tag ] [-ArtifactRoot ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **New-AzureRmDeploymentManagerArtifactSource** cmdlet creates an artifact source. +Specify the *Name*, *ResourceGroupName* and required properties. + +You can modify the returned object locally and then apply the changes to the artifact source by using the Set-AzureRmDeploymentManagerArtifactSource cmdlet. + +The cmdlet returns an ArtifactSource object that has a ResourceId which can be referenced in the New-AzureRmDeloymentManagerServiceTopology cmdlet so that artifacts required for a ServiceUnit resource, the Template and Parameters files, can be referenced from this location. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-AzureRmDeploymentManagerArtifactSource -ResourceGroupName ContosoResourceGroup -Name ContosoArtifactSource -Location "Central US" -SasUri "https://ContosoStorage.blob.core.windows.net/ContosoArtifacts?sasParameters" +``` + +Creates an artifact source in the ContosoResourceGroup with the name ContosoArtifactSource with Central US as the location of the resource. The SasUri property provides an Azure Storage SAS Uri to the storage container where the artifacts are stored. + +## PARAMETERS + +### -ArtifactRoot +The optional directory offset under the storage container for the artifacts. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +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 +``` + +### -Location +The location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the artifact source. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SasUri +The SAS Uri to the Azure storage container where the artifacts are stored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +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 (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSArtifactSource + +## NOTES + +## RELATED LINKS + +[Get-AzureRmDeploymentManagerArtifactSource](./Get-AzureRmDeploymentManagerArtifactSource.md) + +[Remove-AzureRmDeploymentManagerArtifactSource](./Remove-AzureRmDeploymentManagerArtifactSource.md) + [Set-AzureRmDeploymentManagerArtifactSource](./Set-AzureRmDeploymentManagerArtifactSource.md) \ No newline at end of file diff --git a/azuredmps-0.9.0/AzureRM.DeploymentManager/New-AzureRmDeploymentManagerService.md b/azuredmps-0.9.0/AzureRM.DeploymentManager/New-AzureRmDeploymentManagerService.md index 871458b0f8..87b202d060 100644 --- a/azuredmps-0.9.0/AzureRM.DeploymentManager/New-AzureRmDeploymentManagerService.md +++ b/azuredmps-0.9.0/AzureRM.DeploymentManager/New-AzureRmDeploymentManagerService.md @@ -1,252 +1,252 @@ ---- -external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml -Module Name: AzureRM.DeploymentManager -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/new-azurermdeploymentmanagerservice -schema: 2.0.0 ---- - -# New-AzureRmDeploymentManagerService - -## SYNOPSIS -Creates a service in a service topology. - -## SYNTAX - -### Interactive (Default) -``` -New-AzureRmDeploymentManagerService [-ResourceGroupName] [-ServiceTopologyName] - -Name -Location -TargetLocation -TargetSubscriptionId [-Tag ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ByServiceTopologyObject -``` -New-AzureRmDeploymentManagerService [-ResourceGroupName] -Name -Location - -TargetLocation -TargetSubscriptionId [-ServiceTopology] - [-Tag ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ByServiceTopologyResourceId -``` -New-AzureRmDeploymentManagerService [-ResourceGroupName] -Name -Location - -TargetLocation -TargetSubscriptionId [-ServiceTopologyId] [-Tag ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **New-AzureRmDeploymentManagerService** cmdlet creates 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. - -The cmdlet returns a Service object. You can modify this object locally, and then apply changes to the service by using the Set-AzureRmDeploymentManagerService cmdlet. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmDeploymentManagerService -ResourceGroupName ContosoResourceGroup -ServiceTopologyName ContosoServiceTopology -Name ContosoService1 -Location "Central US" -TargetLocation "East US" -TargetSubscriptionId XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -``` - -Creates a new service with name ContosoService1 under service topology ContosoServiceTopology in Resource Group ContosoResourceGroup, in the location Central US. The TargetLocation property indicates that the service ContosoService1 should be deployed to the East US region in the subscription specified. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -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 -``` - -### -Location -The location of the service resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the service. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceTopology -The service topology object in which the service should be created. - -```yaml -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 -``` - -### -ServiceTopologyId -The service topology resource identifier in which the service should be created. - -```yaml -Type: System.String -Parameter Sets: ByServiceTopologyResourceId -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceTopologyName -The name of the service topology this service belongs to. - -```yaml -Type: System.String -Parameter Sets: Interactive -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -A hash table which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetLocation -Determines the location where resources under the service would be deployed to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetSubscriptionId -Determines the subscription to which resources under the service would be deployed to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDeploymentManagerService](./Get-AzureRmDeploymentManagerService.md) - -[Remove-AzureRmDeploymentManagerService](./Remove-AzureRmDeploymentManagerService.md) - +--- +external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml +Module Name: AzureRM.DeploymentManager +online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/new-azurermdeploymentmanagerservice +schema: 2.0.0 +--- + +# New-AzureRmDeploymentManagerService + +## SYNOPSIS +Creates a service in a service topology. + +## SYNTAX + +### Interactive (Default) +``` +New-AzureRmDeploymentManagerService [-ResourceGroupName] [-ServiceTopologyName] + -Name -Location -TargetLocation -TargetSubscriptionId [-Tag ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByServiceTopologyObject +``` +New-AzureRmDeploymentManagerService [-ResourceGroupName] -Name -Location + -TargetLocation -TargetSubscriptionId [-ServiceTopology] + [-Tag ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByServiceTopologyResourceId +``` +New-AzureRmDeploymentManagerService [-ResourceGroupName] -Name -Location + -TargetLocation -TargetSubscriptionId [-ServiceTopologyId] [-Tag ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **New-AzureRmDeploymentManagerService** cmdlet creates 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. + +The cmdlet returns a Service object. You can modify this object locally, and then apply changes to the service by using the Set-AzureRmDeploymentManagerService cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-AzureRmDeploymentManagerService -ResourceGroupName ContosoResourceGroup -ServiceTopologyName ContosoServiceTopology -Name ContosoService1 -Location "Central US" -TargetLocation "East US" -TargetSubscriptionId XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +``` + +Creates a new service with name ContosoService1 under service topology ContosoServiceTopology in Resource Group ContosoResourceGroup, in the location Central US. The TargetLocation property indicates that the service ContosoService1 should be deployed to the East US region in the subscription specified. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +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 +``` + +### -Location +The location of the service resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopology +The service topology object in which the service should be created. + +```yaml +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 +``` + +### -ServiceTopologyId +The service topology resource identifier in which the service should be created. + +```yaml +Type: System.String +Parameter Sets: ByServiceTopologyResourceId +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopologyName +The name of the service topology this service belongs to. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetLocation +Determines the location where resources under the service would be deployed to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSubscriptionId +Determines the subscription to which resources under the service would be deployed to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +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 (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource + +## NOTES + +## RELATED LINKS + +[Get-AzureRmDeploymentManagerService](./Get-AzureRmDeploymentManagerService.md) + +[Remove-AzureRmDeploymentManagerService](./Remove-AzureRmDeploymentManagerService.md) + [Set-AzureRmDeploymentManagerService](./Set-AzureRmDeploymentManagerService.md) \ No newline at end of file diff --git a/azuredmps-0.9.0/AzureRM.DeploymentManager/New-AzureRmDeploymentManagerServiceTopology.md b/azuredmps-0.9.0/AzureRM.DeploymentManager/New-AzureRmDeploymentManagerServiceTopology.md index 6a9276ab2a..4eb3374adb 100644 --- a/azuredmps-0.9.0/AzureRM.DeploymentManager/New-AzureRmDeploymentManagerServiceTopology.md +++ b/azuredmps-0.9.0/AzureRM.DeploymentManager/New-AzureRmDeploymentManagerServiceTopology.md @@ -1,186 +1,186 @@ ---- -external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml -Module Name: AzureRM.DeploymentManager -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/new-azurermdeploymentmanagerservicetopology -schema: 2.0.0 ---- - -# New-AzureRmDeploymentManagerServiceTopology - -## SYNOPSIS -Creates a new service topology. - -## SYNTAX - -``` -New-AzureRmDeploymentManagerServiceTopology -ResourceGroupName -Name -Location - [-ArtifactSourceId ] [-Tag ] [-DefaultProfile ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The **New-AzureRmDeploymentManagerServiceTopology** cmdlet creates a service topology. - -You can modify the returned ServiceTopology object locally, and then apply changes to the topology by using the Set-AzureRmDeploymentManagerServiceTopology cmdlet. -The returned object - -The returned object has a ResourceId field which can be referenced in a rollout resource to indicate that the services declared in this service topology would be deployed in the rollout. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmDeploymentManagerServiceTopology -ResourceGroupName ContosoResourceGroup -Name ContosoServiceTopology -Location "Central US" -ArtifactSourceId "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/artifactSources/ContosoArtifactSource" -``` - -This cmdlet creates a new service topology in the resource group ContosoResourceGroup with the name ContosoServiceTopology and in location Central US. The artifact source ResourceId indicates that the artifacts required for the service unit definitions in this topology need to be read from the specified artifact source. - -### Example 2 -```powershell -PS C:\> New-AzureRmDeploymentManagerServiceTopology -ResourceGroupName ContosoResourceGroup -Name ContosoServiceTopology -Location "Central US" -``` - -This cmdlet creates a new service topology in the resource group ContosoResourceGroup with the name ContosoServiceTopology and in location Central US. The absence of an artifact source reference indicates that the artifacts required for the service unit definitions in this topology would be provided as absolute SAS URIs in the service unit. - -## PARAMETERS - -### -ArtifactSourceId -The identifier of the artifact source, where the artifacts that make up the topology are stored. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -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 -``` - -### -Location -The location of the topology. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the topology. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -A hash table which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDeploymentManagerServiceTopology](./Get-AzureRmDeploymentManagerServiceTopology.md) - -[Remove-AzureRmDeploymentManagerServiceTopology](./Remove-AzureRmDeploymentManagerServiceTopology.md) - +--- +external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml +Module Name: AzureRM.DeploymentManager +online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/new-azurermdeploymentmanagerservicetopology +schema: 2.0.0 +--- + +# New-AzureRmDeploymentManagerServiceTopology + +## SYNOPSIS +Creates a new service topology. + +## SYNTAX + +``` +New-AzureRmDeploymentManagerServiceTopology -ResourceGroupName -Name -Location + [-ArtifactSourceId ] [-Tag ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +The **New-AzureRmDeploymentManagerServiceTopology** cmdlet creates a service topology. + +You can modify the returned ServiceTopology object locally, and then apply changes to the topology by using the Set-AzureRmDeploymentManagerServiceTopology cmdlet. +The returned object + +The returned object has a ResourceId field which can be referenced in a rollout resource to indicate that the services declared in this service topology would be deployed in the rollout. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-AzureRmDeploymentManagerServiceTopology -ResourceGroupName ContosoResourceGroup -Name ContosoServiceTopology -Location "Central US" -ArtifactSourceId "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/artifactSources/ContosoArtifactSource" +``` + +This cmdlet creates a new service topology in the resource group ContosoResourceGroup with the name ContosoServiceTopology and in location Central US. The artifact source ResourceId indicates that the artifacts required for the service unit definitions in this topology need to be read from the specified artifact source. + +### Example 2 +```powershell +PS C:\> New-AzureRmDeploymentManagerServiceTopology -ResourceGroupName ContosoResourceGroup -Name ContosoServiceTopology -Location "Central US" +``` + +This cmdlet creates a new service topology in the resource group ContosoResourceGroup with the name ContosoServiceTopology and in location Central US. The absence of an artifact source reference indicates that the artifacts required for the service unit definitions in this topology would be provided as absolute SAS URIs in the service unit. + +## PARAMETERS + +### -ArtifactSourceId +The identifier of the artifact source, where the artifacts that make up the topology are stored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +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 +``` + +### -Location +The location of the topology. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the topology. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +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 (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource + +## NOTES + +## RELATED LINKS + +[Get-AzureRmDeploymentManagerServiceTopology](./Get-AzureRmDeploymentManagerServiceTopology.md) + +[Remove-AzureRmDeploymentManagerServiceTopology](./Remove-AzureRmDeploymentManagerServiceTopology.md) + [Set-AzureRmDeploymentManagerServiceTopology](./Set-AzureRmDeploymentManagerServiceTopology.md) \ No newline at end of file diff --git a/azuredmps-0.9.0/AzureRM.DeploymentManager/New-AzureRmDeploymentManagerServiceUnit.md b/azuredmps-0.9.0/AzureRM.DeploymentManager/New-AzureRmDeploymentManagerServiceUnit.md index 9c4f2c016c..0f81c93d13 100644 --- a/azuredmps-0.9.0/AzureRM.DeploymentManager/New-AzureRmDeploymentManagerServiceUnit.md +++ b/azuredmps-0.9.0/AzureRM.DeploymentManager/New-AzureRmDeploymentManagerServiceUnit.md @@ -1,406 +1,406 @@ ---- -external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml -Module Name: AzureRM.DeploymentManager -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/new-azurermdeploymentmanagerserviceunit -schema: 2.0.0 ---- - -# New-AzureRmDeploymentManagerServiceUnit - -## SYNOPSIS -Creates a new service unit under a service in a service topology. - -## SYNTAX - -### ByTopologyAndServiceNames (Default) -``` -New-AzureRmDeploymentManagerServiceUnit [-ResourceGroupName] [-ServiceTopologyName] - [-ServiceName] [-Name] -Location -TargetResourceGroup - -DeploymentMode [-ParametersUri ] [-TemplateUri ] - [-TemplateArtifactSourceRelativePath ] [-ParametersArtifactSourceRelativePath ] - [-Tag ] [-AsJob] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -### ByTopologyObjectAndServiceName -``` -New-AzureRmDeploymentManagerServiceUnit [-ResourceGroupName] [-ServiceName] [-Name] - -Location -TargetResourceGroup -DeploymentMode [-ParametersUri ] - [-TemplateUri ] [-TemplateArtifactSourceRelativePath ] - [-ParametersArtifactSourceRelativePath ] [-Tag ] - [-ServiceTopology] [-AsJob] [-DefaultProfile ] [-WhatIf] - [-Confirm] [] -``` - -### ByTopologyResourceAndServiceName -``` -New-AzureRmDeploymentManagerServiceUnit [-ResourceGroupName] [-ServiceName] [-Name] - -Location -TargetResourceGroup -DeploymentMode [-ParametersUri ] - [-TemplateUri ] [-TemplateArtifactSourceRelativePath ] - [-ParametersArtifactSourceRelativePath ] [-Tag ] [-ServiceTopologyResourceId] - [-AsJob] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ByServiceObject -``` -New-AzureRmDeploymentManagerServiceUnit [-ResourceGroupName] [-Name] -Location - -TargetResourceGroup -DeploymentMode [-ParametersUri ] [-TemplateUri ] - [-TemplateArtifactSourceRelativePath ] [-ParametersArtifactSourceRelativePath ] - [-Tag ] [-Service] [-AsJob] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] -``` - -### ByServiceResourceId -``` -New-AzureRmDeploymentManagerServiceUnit [-ResourceGroupName] [-Name] -Location - -TargetResourceGroup -DeploymentMode [-ParametersUri ] [-TemplateUri ] - [-TemplateArtifactSourceRelativePath ] [-ParametersArtifactSourceRelativePath ] - [-Tag ] [-ServiceResourceId] [-AsJob] [-DefaultProfile ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The **New-AzureRmDeploymentManagerServiceUnit** cmdlet creates a service under a service in a service topology, and returns an object that represents that service unit. -Specify the service unit by its name, service name, service topology it is in and the resource group name. - -The cmdlet returns a ServiceUnit object. You can modify this object locally, and then apply changes to the service by using the Set-AzureRmDeploymentManagerService cmdlet. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmDeploymentManagerServiceUnit -ResourceGroupName ContosoResourceGroup -ServiceTopologyName ContosoServiceTopology -ServiceName ContosoService2 -Name ContosoService2Storage -Location "Central US" -TargetResourceGroup service2ResourceGroup -DeploymentMode Incremental -TemplateArtifactSourceRelativePath "Templates/Service2.Storage.json" -ParametersArtifactSourceRelativePath "Parameters/Service2Storage.Parameters.json" -``` - -This cmdlet creates a new service unit with name ContosoService2Storage in the ContosoResourceGroup under the service ContosoService2 in topology ContosoServiceTopology, in the location Central US. The Template and parameters files are defined as relative paths into the artifact source location referenced in the Service Topology ContosoServiceTopology. The resources defined in this template are to be deployed into the target resource group service2ResourceGroup with the deployment mode set to Incremental. - -### Example 2 -```powershell -PS C:\> New-AzureRmDeploymentManagerServiceUnit -ResourceGroupName ContosoResourceGroup -ServiceTopologyName ContosoServiceTopology1 -ServiceName ContosoService2 -Name ContosoService2Storage -Location "Central US" -TargetResourceGroup service2ResourceGroup -DeploymentMode Complete -TemplateUri "https://ContosoStorage.blob.core.windows.net/ContosoArtifacts/Templates/Service2.Storage.json?sasParameters" -ParametersUri "https://ContosoStorage.blob.core.windows.net/ContosoArtifacts/Parameters/Service2Storage.Parameters.json?sasParameters" -``` - -This cmdlet creates a new service unit with name ContosoService2Storage in the ContosoResourceGroup under the service ContosoService2 in topology ContosoServiceTopology, in the location Central US. The Template and parameters references are provided as SAS Uri's as artifact source ResourceId was not provided in the Service Topology ContosoServiceTopology1. The resources defined in this template are to be deployed into the target resource group service2ResourceGroup with the deployment mode set to Complete. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -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 -``` - -### -DeploymentMode -The deployment mode to use when deploying the resources in the service unit. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Incremental, Complete - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location of the service unit resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the service unit. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParametersArtifactSourceRelativePath -The deployment mode to use when deploying the resources in the service unit. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParametersUri -The deployment mode to use when deploying the resources in the service unit. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Service -The service object in which the service unit should be created. - -```yaml -Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource -Parameter Sets: ByServiceObject -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceName -The name of the service this service unit is a part of. - -```yaml -Type: System.String -Parameter Sets: ByTopologyAndServiceNames, ByTopologyObjectAndServiceName, ByTopologyResourceAndServiceName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceResourceId -The service resource identifier in which the service unit should be created. - -```yaml -Type: System.String -Parameter Sets: ByServiceResourceId -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceTopology -The service topology object in which the service unit should be created. - -```yaml -Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource -Parameter Sets: ByTopologyObjectAndServiceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceTopologyName -The name of the serivce topology this service unit is a part of. - -```yaml -Type: System.String -Parameter Sets: ByTopologyAndServiceNames -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceTopologyResourceId -The service topology resource identifier in which the service unit should be created. - -```yaml -Type: System.String -Parameter Sets: ByTopologyResourceAndServiceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -A hash table which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetResourceGroup -Determines the location where resources under the service unit would be deployed to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateArtifactSourceRelativePath -The deployment mode to use when deploying the resources in the service unit. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateUri -The deployment mode to use when deploying the resources in the service unit. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceUnitResource - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDeploymentManagerServiceUnit](./Get-AzureRmDeploymentManagerServiceUnit.md) - -[Remove-AzureRmDeploymentManagerServiceUnit](./Remove-AzureRmDeploymentManagerServiceUnit.md) - +--- +external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml +Module Name: AzureRM.DeploymentManager +online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/new-azurermdeploymentmanagerserviceunit +schema: 2.0.0 +--- + +# New-AzureRmDeploymentManagerServiceUnit + +## SYNOPSIS +Creates a new service unit under a service in a service topology. + +## SYNTAX + +### ByTopologyAndServiceNames (Default) +``` +New-AzureRmDeploymentManagerServiceUnit [-ResourceGroupName] [-ServiceTopologyName] + [-ServiceName] [-Name] -Location -TargetResourceGroup + -DeploymentMode [-ParametersUri ] [-TemplateUri ] + [-TemplateArtifactSourceRelativePath ] [-ParametersArtifactSourceRelativePath ] + [-Tag ] [-AsJob] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### ByTopologyObjectAndServiceName +``` +New-AzureRmDeploymentManagerServiceUnit [-ResourceGroupName] [-ServiceName] [-Name] + -Location -TargetResourceGroup -DeploymentMode [-ParametersUri ] + [-TemplateUri ] [-TemplateArtifactSourceRelativePath ] + [-ParametersArtifactSourceRelativePath ] [-Tag ] + [-ServiceTopology] [-AsJob] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +### ByTopologyResourceAndServiceName +``` +New-AzureRmDeploymentManagerServiceUnit [-ResourceGroupName] [-ServiceName] [-Name] + -Location -TargetResourceGroup -DeploymentMode [-ParametersUri ] + [-TemplateUri ] [-TemplateArtifactSourceRelativePath ] + [-ParametersArtifactSourceRelativePath ] [-Tag ] [-ServiceTopologyResourceId] + [-AsJob] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByServiceObject +``` +New-AzureRmDeploymentManagerServiceUnit [-ResourceGroupName] [-Name] -Location + -TargetResourceGroup -DeploymentMode [-ParametersUri ] [-TemplateUri ] + [-TemplateArtifactSourceRelativePath ] [-ParametersArtifactSourceRelativePath ] + [-Tag ] [-Service] [-AsJob] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### ByServiceResourceId +``` +New-AzureRmDeploymentManagerServiceUnit [-ResourceGroupName] [-Name] -Location + -TargetResourceGroup -DeploymentMode [-ParametersUri ] [-TemplateUri ] + [-TemplateArtifactSourceRelativePath ] [-ParametersArtifactSourceRelativePath ] + [-Tag ] [-ServiceResourceId] [-AsJob] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +The **New-AzureRmDeploymentManagerServiceUnit** cmdlet creates a service under a service in a service topology, and returns an object that represents that service unit. +Specify the service unit by its name, service name, service topology it is in and the resource group name. + +The cmdlet returns a ServiceUnit object. You can modify this object locally, and then apply changes to the service by using the Set-AzureRmDeploymentManagerService cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-AzureRmDeploymentManagerServiceUnit -ResourceGroupName ContosoResourceGroup -ServiceTopologyName ContosoServiceTopology -ServiceName ContosoService2 -Name ContosoService2Storage -Location "Central US" -TargetResourceGroup service2ResourceGroup -DeploymentMode Incremental -TemplateArtifactSourceRelativePath "Templates/Service2.Storage.json" -ParametersArtifactSourceRelativePath "Parameters/Service2Storage.Parameters.json" +``` + +This cmdlet creates a new service unit with name ContosoService2Storage in the ContosoResourceGroup under the service ContosoService2 in topology ContosoServiceTopology, in the location Central US. The Template and parameters files are defined as relative paths into the artifact source location referenced in the Service Topology ContosoServiceTopology. The resources defined in this template are to be deployed into the target resource group service2ResourceGroup with the deployment mode set to Incremental. + +### Example 2 +```powershell +PS C:\> New-AzureRmDeploymentManagerServiceUnit -ResourceGroupName ContosoResourceGroup -ServiceTopologyName ContosoServiceTopology1 -ServiceName ContosoService2 -Name ContosoService2Storage -Location "Central US" -TargetResourceGroup service2ResourceGroup -DeploymentMode Complete -TemplateUri "https://ContosoStorage.blob.core.windows.net/ContosoArtifacts/Templates/Service2.Storage.json?sasParameters" -ParametersUri "https://ContosoStorage.blob.core.windows.net/ContosoArtifacts/Parameters/Service2Storage.Parameters.json?sasParameters" +``` + +This cmdlet creates a new service unit with name ContosoService2Storage in the ContosoResourceGroup under the service ContosoService2 in topology ContosoServiceTopology, in the location Central US. The Template and parameters references are provided as SAS Uri's as artifact source ResourceId was not provided in the Service Topology ContosoServiceTopology1. The resources defined in this template are to be deployed into the target resource group service2ResourceGroup with the deployment mode set to Complete. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +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 +``` + +### -DeploymentMode +The deployment mode to use when deploying the resources in the service unit. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Incremental, Complete + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the service unit resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the service unit. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParametersArtifactSourceRelativePath +The deployment mode to use when deploying the resources in the service unit. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParametersUri +The deployment mode to use when deploying the resources in the service unit. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Service +The service object in which the service unit should be created. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource +Parameter Sets: ByServiceObject +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the service this service unit is a part of. + +```yaml +Type: System.String +Parameter Sets: ByTopologyAndServiceNames, ByTopologyObjectAndServiceName, ByTopologyResourceAndServiceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceResourceId +The service resource identifier in which the service unit should be created. + +```yaml +Type: System.String +Parameter Sets: ByServiceResourceId +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopology +The service topology object in which the service unit should be created. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource +Parameter Sets: ByTopologyObjectAndServiceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopologyName +The name of the serivce topology this service unit is a part of. + +```yaml +Type: System.String +Parameter Sets: ByTopologyAndServiceNames +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopologyResourceId +The service topology resource identifier in which the service unit should be created. + +```yaml +Type: System.String +Parameter Sets: ByTopologyResourceAndServiceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetResourceGroup +Determines the location where resources under the service unit would be deployed to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateArtifactSourceRelativePath +The deployment mode to use when deploying the resources in the service unit. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateUri +The deployment mode to use when deploying the resources in the service unit. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +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 (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceUnitResource + +## NOTES + +## RELATED LINKS + +[Get-AzureRmDeploymentManagerServiceUnit](./Get-AzureRmDeploymentManagerServiceUnit.md) + +[Remove-AzureRmDeploymentManagerServiceUnit](./Remove-AzureRmDeploymentManagerServiceUnit.md) + [Set-AzureRmDeploymentManagerServiceUnit](./Set-AzureRmDeploymentManagerServiceUnit.md) \ No newline at end of file diff --git a/azuredmps-0.9.0/AzureRM.DeploymentManager/New-AzureRmDeploymentManagerStep.md b/azuredmps-0.9.0/AzureRM.DeploymentManager/New-AzureRmDeploymentManagerStep.md index 84c3cc4ee5..e354db4dee 100644 --- a/azuredmps-0.9.0/AzureRM.DeploymentManager/New-AzureRmDeploymentManagerStep.md +++ b/azuredmps-0.9.0/AzureRM.DeploymentManager/New-AzureRmDeploymentManagerStep.md @@ -1,174 +1,174 @@ ---- -external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml -Module Name: AzureRM.DeploymentManager -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/new-azurermdeploymentmanagerstep -schema: 2.0.0 ---- - -# New-AzureRmDeploymentManagerStep - -## SYNOPSIS -Creates a new deployment step. - -## SYNTAX - -``` -New-AzureRmDeploymentManagerStep -ResourceGroupName -Name -Location - -Duration [-Tag ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **New-AzureRmDeploymentManagerStep** cmdlet creates a deployment step that can be referenced in rollouts. -Specify the *Name*, *ResourceGroupName* and required properties. - -You can modify the returned object locally and then apply the changes to the step by using the Set-AzureRmDeploymentManagerStep cmdlet. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmDeploymentManagerStep -ResourceGroupName ContosoResourceGroup -Name ContosoService1WaitStep -Location "Central US" -Duration PT20M -``` - -Creates a step in the ContosoResourceGroup with the name ContosoService1WaitStep with Central US as the location of the resource. The Duration property provides the duration the rollout will wait before running the next step. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -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 -``` - -### -Duration -The duration to wait in ISO 8601 format. -E.g.: PT30M, PT1H - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location of the resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the step. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -A hash table which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.DeploymentManager.Models.PSStepResource - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml +Module Name: AzureRM.DeploymentManager +online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/new-azurermdeploymentmanagerstep +schema: 2.0.0 +--- + +# New-AzureRmDeploymentManagerStep + +## SYNOPSIS +Creates a new deployment step. + +## SYNTAX + +``` +New-AzureRmDeploymentManagerStep -ResourceGroupName -Name -Location + -Duration [-Tag ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **New-AzureRmDeploymentManagerStep** cmdlet creates a deployment step that can be referenced in rollouts. +Specify the *Name*, *ResourceGroupName* and required properties. + +You can modify the returned object locally and then apply the changes to the step by using the Set-AzureRmDeploymentManagerStep cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-AzureRmDeploymentManagerStep -ResourceGroupName ContosoResourceGroup -Name ContosoService1WaitStep -Location "Central US" -Duration PT20M +``` + +Creates a step in the ContosoResourceGroup with the name ContosoService1WaitStep with Central US as the location of the resource. The Duration property provides the duration the rollout will wait before running the next step. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +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 +``` + +### -Duration +The duration to wait in ISO 8601 format. +E.g.: PT30M, PT1H + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the step. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +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 (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSStepResource + +## NOTES + +## RELATED LINKS diff --git a/azuredmps-0.9.0/AzureRM.DeploymentManager/Remove-AzureRmDeploymentManagerArtifactSource.md b/azuredmps-0.9.0/AzureRM.DeploymentManager/Remove-AzureRmDeploymentManagerArtifactSource.md index e47fcd9989..80459f36ef 100644 --- a/azuredmps-0.9.0/AzureRM.DeploymentManager/Remove-AzureRmDeploymentManagerArtifactSource.md +++ b/azuredmps-0.9.0/AzureRM.DeploymentManager/Remove-AzureRmDeploymentManagerArtifactSource.md @@ -1,217 +1,217 @@ ---- -external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml -Module Name: AzureRM.DeploymentManager -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/remove-azurermdeploymentmanagerartifactsource -schema: 2.0.0 ---- - -# Remove-AzureRmDeploymentManagerArtifactSource - -## SYNOPSIS -Deletes an artifact source. - -## SYNTAX - -### Interactive (Default) -``` -Remove-AzureRmDeploymentManagerArtifactSource [-ResourceGroupName] [-Name] [-Force] - [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ResourceId -``` -Remove-AzureRmDeploymentManagerArtifactSource [-ResourceId] [-Force] [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### InputObject -``` -Remove-AzureRmDeploymentManagerArtifactSource [-ArtifactSource] [-Force] [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmDeploymentManagerArtifactSource** cmdlet deletes an artifact source -Specify the artifact source by its name and resource group name. Alternately, you can provide the ArtifactSource object or the ResourceId. - -## EXAMPLES - -### Example 1: Delete an artifact source -```powershell -PS C:\> Remove-AzureRmDeploymentManagerArtifactSource -ResourceGroupName "ContosoResourceGroup" -Name "ContosoArtifactSource" -``` - -This command deletes an artifact source named ContosoArtifactSource in ContosoResourceGroup. - -### Example 2: Delete an artifact source using the resource identifier -```powershell -PS C:\> Remove-AzureRmDeploymentManagerArtifactSource -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/artifactSources/ContosoArtifactSource" -``` - -This command deletes an artifact source named ContosoArtifactSource in ContosoResourceGroup. - -### Example 3: Delete an artifact source using an object -```powershell -PS C:\> Remove-AzureRmDeploymentManagerArtifactSource -ArtifactSource $artifactSourceObject -``` - -This command deletes an artifact source whose name and ResourceGroup match the Name and ResourceGroupName properties of the $artifactSourceObject, respectively. - -## PARAMETERS - -### -ArtifactSource -The artifact store to be removed. - -```yaml -Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSArtifactSource -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -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 -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the artifact source. - -```yaml -Type: System.String -Parameter Sets: Interactive -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group. - -```yaml -Type: System.String -Parameter Sets: Interactive -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource identifier. - -```yaml -Type: System.String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DeploymentManager.Models.PSArtifactSource - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[New-AzureRmDeploymentManagerArtifactSource](./New-AzureRmDeploymentManagerArtifactSource.md) - -[Get-AzureRmDeploymentManagerArtifactSource](./Get-AzureRmDeploymentManagerArtifactSource.md) - +--- +external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml +Module Name: AzureRM.DeploymentManager +online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/remove-azurermdeploymentmanagerartifactsource +schema: 2.0.0 +--- + +# Remove-AzureRmDeploymentManagerArtifactSource + +## SYNOPSIS +Deletes an artifact source. + +## SYNTAX + +### Interactive (Default) +``` +Remove-AzureRmDeploymentManagerArtifactSource [-ResourceGroupName] [-Name] [-Force] + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ResourceId +``` +Remove-AzureRmDeploymentManagerArtifactSource [-ResourceId] [-Force] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### InputObject +``` +Remove-AzureRmDeploymentManagerArtifactSource [-ArtifactSource] [-Force] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzureRmDeploymentManagerArtifactSource** cmdlet deletes an artifact source +Specify the artifact source by its name and resource group name. Alternately, you can provide the ArtifactSource object or the ResourceId. + +## EXAMPLES + +### Example 1: Delete an artifact source +```powershell +PS C:\> Remove-AzureRmDeploymentManagerArtifactSource -ResourceGroupName "ContosoResourceGroup" -Name "ContosoArtifactSource" +``` + +This command deletes an artifact source named ContosoArtifactSource in ContosoResourceGroup. + +### Example 2: Delete an artifact source using the resource identifier +```powershell +PS C:\> Remove-AzureRmDeploymentManagerArtifactSource -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/artifactSources/ContosoArtifactSource" +``` + +This command deletes an artifact source named ContosoArtifactSource in ContosoResourceGroup. + +### Example 3: Delete an artifact source using an object +```powershell +PS C:\> Remove-AzureRmDeploymentManagerArtifactSource -ArtifactSource $artifactSourceObject +``` + +This command deletes an artifact source whose name and ResourceGroup match the Name and ResourceGroupName properties of the $artifactSourceObject, respectively. + +## PARAMETERS + +### -ArtifactSource +The artifact store to be removed. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSArtifactSource +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +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 +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the artifact source. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +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 (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSArtifactSource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[New-AzureRmDeploymentManagerArtifactSource](./New-AzureRmDeploymentManagerArtifactSource.md) + +[Get-AzureRmDeploymentManagerArtifactSource](./Get-AzureRmDeploymentManagerArtifactSource.md) + [Set-AzureRmDeploymentManagerArtifactSource](./Set-AzureRmDeploymentManagerArtifactSource.md) \ No newline at end of file diff --git a/azuredmps-0.9.0/AzureRM.DeploymentManager/Remove-AzureRmDeploymentManagerRollout.md b/azuredmps-0.9.0/AzureRM.DeploymentManager/Remove-AzureRmDeploymentManagerRollout.md index 92faa9bacb..23b826d38e 100644 --- a/azuredmps-0.9.0/AzureRM.DeploymentManager/Remove-AzureRmDeploymentManagerRollout.md +++ b/azuredmps-0.9.0/AzureRM.DeploymentManager/Remove-AzureRmDeploymentManagerRollout.md @@ -1,217 +1,217 @@ ---- -external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml -Module Name: AzureRM.DeploymentManager -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/remove-azurermdeploymentmanagerrollout -schema: 2.0.0 ---- - -# Remove-AzureRmDeploymentManagerRollout - -## SYNOPSIS -Deletes a rollout. - -## SYNTAX - -### Interactive (Default) -``` -Remove-AzureRmDeploymentManagerRollout [-ResourceGroupName] [-Name] [-Force] [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ResourceId -``` -Remove-AzureRmDeploymentManagerRollout [-ResourceId] [-Force] [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### InputObject -``` -Remove-AzureRmDeploymentManagerRollout [-Rollout] [-Force] [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmDeploymentManagerRollout** cmdlet deletes a rollout in a terminal state. -Specify the rollout by its name and resource group name. Alternately, you can provide the Rollout object or the ResourceId. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-AzureRmDeploymentManagerRollout -ResourceGroupName ContosoResourceGroup -Name ContosoRollout -``` - -This command deletes a rollout named ContosoRollout in the ContosoResourceGroup. - -### Example 2: Delete a rollout using the resource identifier -```powershell -PS C:\> Remove-AzureRmDeploymentManagerRollout -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/rollouts/ContosoRollout" -``` - -This command deletes a rollout named ContosoRollout in the ContosoResourceGroup. - -### Example 3: Delete a rollout using the rollout object. -```powershell -PS C:\> Remove-AzureRmDeploymentManagerRollout -Rollout $rolloutObject -``` - -This command deletes a rollout whose name and ResourceGroup match the Name and ResourceGroupName properties of the $rolloutObject, respectively. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -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 -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the rollout. - -```yaml -Type: System.String -Parameter Sets: Interactive -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group. - -```yaml -Type: System.String -Parameter Sets: Interactive -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource identifier. - -```yaml -Type: System.String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Rollout -The resource to be removed. - -```yaml -Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDeploymentManagerRollout](./Get-AzureRmDeploymentManagerRollout.md) - -[Stop-AzureRmDeploymentManagerRollout](./Stop-AzureRmDeploymentManagerRollout.md) - +--- +external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml +Module Name: AzureRM.DeploymentManager +online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/remove-azurermdeploymentmanagerrollout +schema: 2.0.0 +--- + +# Remove-AzureRmDeploymentManagerRollout + +## SYNOPSIS +Deletes a rollout. + +## SYNTAX + +### Interactive (Default) +``` +Remove-AzureRmDeploymentManagerRollout [-ResourceGroupName] [-Name] [-Force] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ResourceId +``` +Remove-AzureRmDeploymentManagerRollout [-ResourceId] [-Force] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### InputObject +``` +Remove-AzureRmDeploymentManagerRollout [-Rollout] [-Force] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzureRmDeploymentManagerRollout** cmdlet deletes a rollout in a terminal state. +Specify the rollout by its name and resource group name. Alternately, you can provide the Rollout object or the ResourceId. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-AzureRmDeploymentManagerRollout -ResourceGroupName ContosoResourceGroup -Name ContosoRollout +``` + +This command deletes a rollout named ContosoRollout in the ContosoResourceGroup. + +### Example 2: Delete a rollout using the resource identifier +```powershell +PS C:\> Remove-AzureRmDeploymentManagerRollout -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/rollouts/ContosoRollout" +``` + +This command deletes a rollout named ContosoRollout in the ContosoResourceGroup. + +### Example 3: Delete a rollout using the rollout object. +```powershell +PS C:\> Remove-AzureRmDeploymentManagerRollout -Rollout $rolloutObject +``` + +This command deletes a rollout whose name and ResourceGroup match the Name and ResourceGroupName properties of the $rolloutObject, respectively. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +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 +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the rollout. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Rollout +The resource to be removed. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +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 (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzureRmDeploymentManagerRollout](./Get-AzureRmDeploymentManagerRollout.md) + +[Stop-AzureRmDeploymentManagerRollout](./Stop-AzureRmDeploymentManagerRollout.md) + [Restart-AzureRmDeploymentManagerRollout](./Restart-AzureRmDeploymentManagerRollout.md) \ No newline at end of file diff --git a/azuredmps-0.9.0/AzureRM.DeploymentManager/Remove-AzureRmDeploymentManagerService.md b/azuredmps-0.9.0/AzureRM.DeploymentManager/Remove-AzureRmDeploymentManagerService.md index 7fc4d6ac38..7137996ace 100644 --- a/azuredmps-0.9.0/AzureRM.DeploymentManager/Remove-AzureRmDeploymentManagerService.md +++ b/azuredmps-0.9.0/AzureRM.DeploymentManager/Remove-AzureRmDeploymentManagerService.md @@ -1,275 +1,275 @@ ---- -external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml -Module Name: AzureRM.DeploymentManager -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/remove-azurermdeploymentmanagerservice -schema: 2.0.0 ---- - -# Remove-AzureRmDeploymentManagerService - -## SYNOPSIS -Deletes a service in a service topology. - -## SYNTAX - -### Interactive (Default) -``` -Remove-AzureRmDeploymentManagerService [-ResourceGroupName] [-ServiceTopologyName] - [-Name] [-Force] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -### ByServiceTopologyObject -``` -Remove-AzureRmDeploymentManagerService [-Name] [-ServiceTopology] [-Force] - [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ByServiceTopologyResourceId -``` -Remove-AzureRmDeploymentManagerService [-Name] [-ServiceTopologyResourceId] [-Force] - [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ResourceId -``` -Remove-AzureRmDeploymentManagerService [-ResourceId] [-Force] [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### InputObject -``` -Remove-AzureRmDeploymentManagerService [-Service] [-Force] [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmDeploymentManagerService** cmdlet deletes a service under a service topology. -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. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-AzureRmDeploymentManagerService -ResourceGroupName ContosoResourceGroup -ServiceTopologyName ContosoServiceTopology -Name ContosoService1 -``` - -This command deletes a service named ContosoService1 in a service topology named ContosoServiceTopology in the ContosoResourceGroup. - -### Example 2: Delete a service using the resource identifier. -```powershell -PS C:\> Remove-AzureRmDeploymentManagerService -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/serviceTopologies/ContosoServiceTopology/services/ContosoService1" -``` - -This command deletes a service named ContosoService1 in a service topology named ContosoServiceTopology in the ContosoResourceGroup. - -### Example 3: Delete a service using the service object. -```powershell -PS C:\> Remove-AzureRmDeploymentManagerService -Service $serviceObject -``` - -This command deletes 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. - -```yaml -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 -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the service. - -```yaml -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 -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group. - -```yaml -Type: System.String -Parameter Sets: Interactive -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource identifier. - -```yaml -Type: System.String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Service -The resource to be removed. - -```yaml -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. - -```yaml -Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource -Parameter Sets: ByServiceTopologyObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceTopologyName -The name of the service topology the service belongs to. - -```yaml -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. - -```yaml -Type: System.String -Parameter Sets: ByServiceTopologyResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[New-AzureRmDeploymentManagerService](./New-AzureRmDeploymentManagerService.md) - -[Get-AzureRmDeploymentManagerService](./Get-AzureRmDeploymentManagerService.md) - +--- +external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml +Module Name: AzureRM.DeploymentManager +online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/remove-azurermdeploymentmanagerservice +schema: 2.0.0 +--- + +# Remove-AzureRmDeploymentManagerService + +## SYNOPSIS +Deletes a service in a service topology. + +## SYNTAX + +### Interactive (Default) +``` +Remove-AzureRmDeploymentManagerService [-ResourceGroupName] [-ServiceTopologyName] + [-Name] [-Force] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### ByServiceTopologyObject +``` +Remove-AzureRmDeploymentManagerService [-Name] [-ServiceTopology] [-Force] + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByServiceTopologyResourceId +``` +Remove-AzureRmDeploymentManagerService [-Name] [-ServiceTopologyResourceId] [-Force] + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ResourceId +``` +Remove-AzureRmDeploymentManagerService [-ResourceId] [-Force] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### InputObject +``` +Remove-AzureRmDeploymentManagerService [-Service] [-Force] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzureRmDeploymentManagerService** cmdlet deletes a service under a service topology. +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. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-AzureRmDeploymentManagerService -ResourceGroupName ContosoResourceGroup -ServiceTopologyName ContosoServiceTopology -Name ContosoService1 +``` + +This command deletes a service named ContosoService1 in a service topology named ContosoServiceTopology in the ContosoResourceGroup. + +### Example 2: Delete a service using the resource identifier. +```powershell +PS C:\> Remove-AzureRmDeploymentManagerService -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/serviceTopologies/ContosoServiceTopology/services/ContosoService1" +``` + +This command deletes a service named ContosoService1 in a service topology named ContosoServiceTopology in the ContosoResourceGroup. + +### Example 3: Delete a service using the service object. +```powershell +PS C:\> Remove-AzureRmDeploymentManagerService -Service $serviceObject +``` + +This command deletes 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. + +```yaml +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 +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the service. + +```yaml +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 +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Service +The resource to be removed. + +```yaml +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. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource +Parameter Sets: ByServiceTopologyObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopologyName +The name of the service topology the service belongs to. + +```yaml +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. + +```yaml +Type: System.String +Parameter Sets: ByServiceTopologyResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +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 (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[New-AzureRmDeploymentManagerService](./New-AzureRmDeploymentManagerService.md) + +[Get-AzureRmDeploymentManagerService](./Get-AzureRmDeploymentManagerService.md) + [Set-AzureRmDeploymentManagerService](./Set-AzureRmDeploymentManagerService.md) \ No newline at end of file diff --git a/azuredmps-0.9.0/AzureRM.DeploymentManager/Remove-AzureRmDeploymentManagerServiceTopology.md b/azuredmps-0.9.0/AzureRM.DeploymentManager/Remove-AzureRmDeploymentManagerServiceTopology.md index 1a804af1a9..2cd08ba50f 100644 --- a/azuredmps-0.9.0/AzureRM.DeploymentManager/Remove-AzureRmDeploymentManagerServiceTopology.md +++ b/azuredmps-0.9.0/AzureRM.DeploymentManager/Remove-AzureRmDeploymentManagerServiceTopology.md @@ -1,218 +1,218 @@ ---- -external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml -Module Name: AzureRM.DeploymentManager -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/remove-azurermdeploymentmanagerservicetopology -schema: 2.0.0 ---- - -# Remove-AzureRmDeploymentManagerServiceTopology - -## SYNOPSIS -Deletes a service topology and all its resources. - -## SYNTAX - -### Interactive (Default) -``` -Remove-AzureRmDeploymentManagerServiceTopology [-ResourceGroupName] [-Name] [-Force] - [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ResourceId -``` -Remove-AzureRmDeploymentManagerServiceTopology [-ResourceId] [-Force] [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### InputObject -``` -Remove-AzureRmDeploymentManagerServiceTopology [-ServiceTopology] [-Force] - [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmDeploymentManagerServiceTopology** cmdlet deletes a service topology. - -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 -```powershell -PS C:\> Remove-AzureRmDeploymentManagerServiceTopology -ResourceGroupName ContosoResourceGroup -Name ContosoServiceTopology -``` - -This command deletes a service topology named ContosoServiceTopology in the ContosoResourceGroup. - -### Example 2: Delete a service topology using the resource identifier. -```powershell -PS C:\> Remove-AzureRmDeploymentManagerServiceTopology -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/serviceTopologies/ContosoServiceTopology" -``` - -This command deletes a service topology named ContosoServiceTopology in the ContosoResourceGroup. - -### Example 3: Delete a service topology using the service topology object. -```powershell -PS C:\> Remove-AzureRmDeploymentManagerService -ServiceTopology $serviceTopologyObject -``` - -This command deletes 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. - -```yaml -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 -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the service topology. - -```yaml -Type: System.String -Parameter Sets: Interactive -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group. - -```yaml -Type: System.String -Parameter Sets: Interactive -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource identifier. - -```yaml -Type: System.String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceTopology -The resource to be removed. - -```yaml -Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -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 (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[New-AzureRmDeploymentManagerServiceTopology](./New-AzureRmDeploymentManagerServiceTopology.md) - -[Get-AzureRmDeploymentManagerServiceTopology](./Get-AzureRmDeploymentManagerServiceTopology.md) - +--- +external help file: Microsoft.Azure.Commands.DeploymentManager.dll-Help.xml +Module Name: AzureRM.DeploymentManager +online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.deploymentmanager/remove-azurermdeploymentmanagerservicetopology +schema: 2.0.0 +--- + +# Remove-AzureRmDeploymentManagerServiceTopology + +## SYNOPSIS +Deletes a service topology and all its resources. + +## SYNTAX + +### Interactive (Default) +``` +Remove-AzureRmDeploymentManagerServiceTopology [-ResourceGroupName] [-Name] [-Force] + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ResourceId +``` +Remove-AzureRmDeploymentManagerServiceTopology [-ResourceId] [-Force] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### InputObject +``` +Remove-AzureRmDeploymentManagerServiceTopology [-ServiceTopology] [-Force] + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzureRmDeploymentManagerServiceTopology** cmdlet deletes a service topology. + +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 +```powershell +PS C:\> Remove-AzureRmDeploymentManagerServiceTopology -ResourceGroupName ContosoResourceGroup -Name ContosoServiceTopology +``` + +This command deletes a service topology named ContosoServiceTopology in the ContosoResourceGroup. + +### Example 2: Delete a service topology using the resource identifier. +```powershell +PS C:\> Remove-AzureRmDeploymentManagerServiceTopology -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/serviceTopologies/ContosoServiceTopology" +``` + +This command deletes a service topology named ContosoServiceTopology in the ContosoResourceGroup. + +### Example 3: Delete a service topology using the service topology object. +```powershell +PS C:\> Remove-AzureRmDeploymentManagerService -ServiceTopology $serviceTopologyObject +``` + +This command deletes 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. + +```yaml +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 +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the service topology. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceTopology +The resource to be removed. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +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 (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[New-AzureRmDeploymentManagerServiceTopology](./New-AzureRmDeploymentManagerServiceTopology.md) + +[Get-AzureRmDeploymentManagerServiceTopology](./Get-AzureRmDeploymentManagerServiceTopology.md) + [Set-AzureRmDeploymentManagerServiceTopology](./Set-AzureRmDeploymentManagerServiceTopology.md) \ No newline at end of file