Remove-AzSpringCloudAppDeployment

Module:

Az.SpringCloud

Operation to delete a Deployment.

Syntax

Remove-AzSpringCloudAppDeployment
      -AppName <String>
      -Name <String>
      -ResourceGroupName <String>
      -ServiceName <String>
      [-SubscriptionId <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzSpringCloudAppDeployment
      -InputObject <ISpringCloudIdentity>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Operation to delete a Deployment.

Examples

Example 1: Remove Spring Cloud Deployment by name

Remove-AzSpringCloudAppDeployment -ResourceGroupName spring-cloud-rg -ServiceName spring-cloud-service -AppName gateway -DeploymentName default

Remove Spring Cloud Deployment by name.

Example 2: Remove Spring Cloud Deployment by pipeline

Get-AzSpringCloudAppDeployment -ResourceGroupName spring-cloud-rg -ServiceName spring-cloud-service -AppName gateway -DeploymentName default | Remove-AzSpringCloudAppDeployment

Remove Spring Cloud Deployment by pipeline.

Parameters

-AppName

The name of the App resource.

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

-AsJob

Run the command as a job

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

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

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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

-Name

The name of the Deployment resource.

Type:	String
Aliases:	DeploymentName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NoWait

Run the command asynchronously

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

-PassThru

Returns true when the command succeeds

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

-ResourceGroupName

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

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

-ServiceName

The name of the Service resource.

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

-SubscriptionId

Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

ISpringCloudIdentity

Outputs

Boolean

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <ISpringCloudIdentity>: Identity Parameter

• [AgentPoolName <String>]: The name of the build service agent pool resource.
• [AppName <String>]: The name of the App resource.
• [BindingName <String>]: The name of the Binding resource.
• [BuildName <String>]: The name of the build resource.
• [BuildResultName <String>]: The name of the build result resource.
• [BuildServiceName <String>]: The name of the build service resource.
• [BuilderName <String>]: The name of the builder resource.
• [BuildpackBindingName <String>]: The name of the Buildpack Binding Name
• [BuildpackName <String>]: The name of the buildpack resource.
• [CertificateName <String>]: The name of the certificate resource.
• [ConfigurationServiceName <String>]: The name of Application Configuration Service.
• [DeploymentName <String>]: The name of the Deployment resource.
• [DomainName <String>]: The name of the custom domain resource.
• [Id <String>]: Resource identity path
• [Location <String>]: the region
• [ResourceGroupName <String>]: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
• [ServiceName <String>]: The name of the Service resource.
• [ServiceRegistryName <String>]: The name of Service Registry.
• [StackName <String>]: The name of the stack resource.
• [SubscriptionId <String>]: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.