Get-AzConfluentOrganization
This cmdlet is part of a Preview module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus.
Get the properties of a specific Organization resource.
Syntax
List (Default)
Get-AzConfluentOrganization
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get
Get-AzConfluentOrganization
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
List1
Get-AzConfluentOrganization
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentity
Get-AzConfluentOrganization
-InputObject <IConfluentIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Get the properties of a specific Organization resource.
Examples
Example 1: List all confluent organizations under a subscription
Get-AzConfluentOrganization
Location Name Type
-------- ---- ----
westus2 RegionTestWestUS2 Microsoft.Confluent/organizations
westus2 RohitWUS2 Microsoft.Confluent/organizations
westus2 Rohit-Secret Microsoft.Confluent/organizations
westus2 Rohit-Secret-2 Microsoft.Confluent/organizations
westus2 Rohit-Secret-WUS2-0 Microsoft.Confluent/organizations
westus2 RohitWus200 Microsoft.Confluent/organizations
westus2 RohitWUS300 Microsoft.Confluent/organizations
westus2 WestUS2-SSOTest Microsoft.Confluent/organizations
westus2 dri-01-02-postman-stable Microsoft.Confluent/organizations
westus2 dri-02-02 Microsoft.Confluent/organizations
westcentralus RohitWCUS88 Microsoft.Confluent/organizations
This command lists all confluent organizations under a subscription.
Example 2: List all confluent organizations under a resource group
Get-AzConfluentOrganization -ResourceGroupName azure-rg-test
Location Name Type
-------- ---- ----
eastus2euap ppe-metrics-2 Microsoft.Confluent/organizations
This command lists all confluent organizations under a resource group.
Example 3: Get a confluent organization by name
Get-AzConfluentOrganization -ResourceGroupName azure-rg-test -Name confluentorg-01-portal
Location Name Type
-------- ---- ----
eastus confluentorg-01-portal Microsoft.Confluent/organizations
This command gets a confluent organization by name.
Example 4: Get a confluent organization by pipeline
New-AzConfluentOrganization -ResourceGroupName azure-rg-test -Name confluentorg-02-pwsh -Location eastus -OfferDetailId "confluent-cloud-azure-prod" -OfferDetailPlanId "confluent-cloud-azure-payg-prod" -OfferDetailPlanName "Confluent Cloud - Pay as you Go" -OfferDetailPublisherId "confluentinc" -OfferDetailTermUnit "P1M" | Get-AzConfluentOrganization
Location Name Type
-------- ---- ----
eastus confluentorg-02-pwsh Microsoft.Confluent/organizations
This command gets a confluent organization by pipeline.
Parameters
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
| Type: | PSObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzureRMContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Identity Parameter
Parameter properties
| Type: | Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IConfluentIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetViaIdentity
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Organization resource name
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | OrganizationName |
Parameter sets
Get
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Get
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
List1
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SubscriptionId
The ID of the target subscription. The value must be an UUID.
Parameter properties
| Type: | String[] |
| Default value: | (Get-AzContext).Subscription.Id |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
List
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
Get
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
List1
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
