Get-AzConfluentOrganizationClusterApiKey

Module:

Az.Confluent Module

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 API key details of a kafka or schema registry cluster

Syntax

Get (Default)

Get-AzConfluentOrganizationClusterApiKey
    -ApiKeyId <String>
    -OrganizationName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityOrganization

Get-AzConfluentOrganizationClusterApiKey
    -ApiKeyId <String>
    -OrganizationInputObject <IConfluentIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity

Get-AzConfluentOrganizationClusterApiKey
    -InputObject <IConfluentIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Get API key details of a kafka or schema registry cluster

Examples

Example 1: Get API key details of a kafka or schema registry cluster

Get-AzConfluentOrganizationClusterApiKey -ApiKeyId EXAMPLEApiKeyId00 -OrganizationName sharedrp-scus-org -ResourceGroupName sharedrp-confluent

Get-AzConfluentOrganizationClusterApiKey_Get: Forbidden Access

This command gets API key details of a kafka or schema registry cluster

Parameters

-ApiKeyId

Confluent API Key id

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

GetViaIdentityOrganization

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-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

-OrganizationInputObject

Identity Parameter

Parameter properties

Type:	Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IConfluentIdentity
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetViaIdentityOrganization

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-OrganizationName

Organization resource name

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

-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

-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

Get

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.

Inputs

Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IConfluentIdentity

Outputs

Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IApiKeyRecord