Edit

Share via

Get-AzSpringCloud

  • Reference
Module:
Az.SpringCloud

Get a Service and its properties.

Syntax

Get-AzSpringCloud
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzSpringCloud
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzSpringCloud
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzSpringCloud
   -InputObject <ISpringCloudIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get a Service and its properties.

Examples

Example 1: Get Spring Cloud Service by name

Get-AzSpringCloud -ResourceGroupName springcloudrg -Name spring-portal02

Location Name            SystemDataCreatedAt  SystemDataCreatedBy  SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName
-------- ----            -------------------  -------------------  ----------------------- ------------------------ ------------------------ ---------------------------- -----------------
eastus   spring-portal02 7/21/2022 3:02:40 AM v-diya@microsoft.com User                    7/21/2022 3:02:40 AM     v-diya@microsoft.com     User                         springcloudrg                                  : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.Error

Get Spring Cloud Service by name.

Example 2: List all the spring cloud service under the resource group

Get-AzSpringCloud -ResourceGroupName spring-cloud-rg

Location Name                Type
-------- ----                ----
eastus   spring-cloud-rg Microsoft.AppPlatform/Spring

List all the spring cloud service under the resource group.

Example 3: List all the spring cloud service under the subscription

Get-AzSpringCloud

Location Name                Type
-------- ----                ----
eastus   spring-cloud-rg Microsoft.AppPlatform/Spring

List all the spring cloud service under the subscription.

Example 4: Get Spring Cloud Service by pipeline

New-AzSpringCloud -ResourceGroupName springcloudrg -Name spring-pwsh01 -Location eastus | Get-AzSpringCloud

Location Name                Type
-------- ----                ----
eastus   spring-cloud-rg Microsoft.AppPlatform/Spring

Get Spring Cloud Service by pipeline.

Parameters

-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 Service resource.

Type:String
Aliases:ServiceName
Position:Named
Default value:None
Required:True
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

-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

Inputs

ISpringCloudIdentity

Outputs

IServiceResource

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.