Test-AzConfluentValidationOrganizationV2
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 .
Organization Validate proxy resource
Syntax
ValidateExpanded (Default)
Test-AzConfluentValidationOrganizationV2
-OrganizationName <String>
-ResourceGroupName <String>
-Location <String>
-OfferDetailId <String>
-OfferDetailPlanId <String>
-OfferDetailPlanName <String>
-OfferDetailPublisherId <String>
-OfferDetailTermUnit <String>
-UserDetailEmailAddress <String>
[-SubscriptionId <String>]
[-LinkOrganizationToken <SecureString>]
[-OfferDetailPrivateOfferId <String>]
[-OfferDetailStatus <String>]
[-OfferDetailTermId <String>]
[-PropertiesOfferDetailPrivateOfferId <String[]>]
[-Tag <Hashtable>]
[-UserDetailAadEmail <String>]
[-UserDetailFirstName <String>]
[-UserDetailLastName <String>]
[-UserDetailUserPrincipalName <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ValidateViaJsonString
Test-AzConfluentValidationOrganizationV2
-OrganizationName <String>
-ResourceGroupName <String>
-JsonString <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ValidateViaJsonFilePath
Test-AzConfluentValidationOrganizationV2
-OrganizationName <String>
-ResourceGroupName <String>
-JsonFilePath <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Validate
Test-AzConfluentValidationOrganizationV2
-OrganizationName <String>
-ResourceGroupName <String>
-Body <IOrganizationResource>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ValidateViaIdentityExpanded
Test-AzConfluentValidationOrganizationV2
-InputObject <IConfluentIdentity>
-Location <String>
-OfferDetailId <String>
-OfferDetailPlanId <String>
-OfferDetailPlanName <String>
-OfferDetailPublisherId <String>
-OfferDetailTermUnit <String>
-UserDetailEmailAddress <String>
[-LinkOrganizationToken <SecureString>]
[-OfferDetailPrivateOfferId <String>]
[-OfferDetailStatus <String>]
[-OfferDetailTermId <String>]
[-PropertiesOfferDetailPrivateOfferId <String[]>]
[-Tag <Hashtable>]
[-UserDetailAadEmail <String>]
[-UserDetailFirstName <String>]
[-UserDetailLastName <String>]
[-UserDetailUserPrincipalName <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ValidateViaIdentity
Test-AzConfluentValidationOrganizationV2
-InputObject <IConfluentIdentity>
-Body <IOrganizationResource>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Organization Validate proxy resource
Examples
Example 1: Organization Validation
Test-AzConfluentValidationOrganizationV2 `
-OrganizationName "sharedrp-scus-org" `
-ResourceGroupName "sharedrp-confluent" `
-Location "centralus" `
-OfferDetailId "confluent-cloud-azure-prod" `
-OfferDetailPlanId "confluent-cloud-azure-payg-prod" `
-OfferDetailPlanName "Confluent Cloud - Pay as you Go" `
-OfferDetailPublisherId "confluentinc" `
-OfferDetailTermUnit "P1M" `
-UserDetailEmailAddress "user4@example.com" `
-UserDetailFirstName "Prem" `
-UserDetailLastName "Gnanashekar" `
-UserDetailUserPrincipalName "user4@example.com"
Test-AzConfluentValidationOrganizationV2_ValidateExpanded: SaaS Purchase Payment Check Failed as validationResponse was {"isEligible":false,"errorMessage":"Test header retention date cannot be in the past. {\"contact\":\"testaccounts@example.com\",\"scenarios\":\"BAMI,CSZ,Inv-v7,crs-vnext\",\"retention\":\"2099-01-01T00:00:00.000Z\"}"} Cannot complete signup. Reason: Email already exists. For more details: https://docs.confluent.io/cloud/current/billing/ccloud-azure-payg.html#prerequisites.ErrorCode:40025CorrelationID:00000000-0000-0000-0000-000000000003 Organization resource already exists with resource id: /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/sharedrp-confluent/providers/Microsoft.Confluent/organizations/sharedrp-scus-org.
This command validates organization resource
Parameters
-Body
Organization resource.
Parameter properties
Type: Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IOrganizationResource
Default value: None Supports wildcards: False DontShow: False
Parameter sets
Validate
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False 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
Identity Parameter
Type: Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IConfluentIdentity
Default value: None Supports wildcards: False DontShow: False
ValidateViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-JsonFilePath
Path of Json file supplied to the Validate operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JsonString
Json string supplied to the Validate operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-LinkOrganizationToken
User auth token
Parameter properties
Type: SecureString
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Location
The geo-location where the resource lives
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OfferDetailId
Offer Id
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OfferDetailPlanId
Offer Plan Id
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OfferDetailPlanName
Offer Plan Name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OfferDetailPrivateOfferId
Private Offer Id
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OfferDetailPublisherId
Publisher Id
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OfferDetailStatus
SaaS Offer Status
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OfferDetailTermId
Offer Plan Term Id
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OfferDetailTermUnit
Offer Plan Term unit
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: False 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
ValidateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Validate
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PropertiesOfferDetailPrivateOfferId
Array of Private Offer Ids
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: False 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
ValidateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Validate
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
ValidateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaJsonString
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaJsonFilePath
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Validate
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Tag
Resource tags.
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-UserDetailAadEmail
AAD email address
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-UserDetailEmailAddress
Email address
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-UserDetailFirstName
First name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-UserDetailLastName
Last name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-UserDetailUserPrincipalName
User principal name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
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 .
Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IConfluentIdentity
Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IOrganizationResource
Outputs
Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IValidationResponse
