Get-AzNginxDeployment

  • Reference
Module:
Az.Nginx

Get the NGINX deployment

Syntax

Get-AzNginxDeployment
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzNginxDeployment
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzNginxDeployment
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzNginxDeployment
   -InputObject <INginxIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get the NGINX deployment

Examples

Example 1: Get a NGINX deployment with name

Get-AzNginxDeployment -Name nginx-test -ResourceGroupName nginx-test-rg

Location      Name
--------      ----
westcentralus nginx-test

This command gets a NGINX deployment in a resource group.

Example 2: List all NGINX deployments in a subscription

Get-AzNginxDeployment

Location      Name
--------      ----
westcentralus nginx-test
westcentralus nginx-test1
eastus2       nginx-test2

This command lists all NGINX deployments in a subscription.

Example 3: List all NGINX deployments in a resource group

Get-AzNginxDeployment -ResourceGroupName nginx-test-rg

Location      Name
--------      ----
westcentralus nginx-test
westcentralus nginx-test1

This command lists all NGINX deployments in a resource group.

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

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:INginxIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

The name of targeted NGINX deployment

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

-ResourceGroupName

The name of the resource group. The name is case insensitive.

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

-SubscriptionId

The ID of the target subscription.

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

Inputs

INginxIdentity

Outputs

INginxDeployment