Update-AzNeonPostgresOrganization
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 .
update a OrganizationResource
Syntax
UpdateExpanded (Default)
Update-AzNeonPostgresOrganization
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-CompanyDetailBusinessPhone <String>]
[-CompanyDetailCompanyName <String>]
[-CompanyDetailCountry <String>]
[-CompanyDetailDomain <String>]
[-CompanyDetailNumberOfEmployee <Int64>]
[-CompanyDetailOfficeAddress <String>]
[-MarketplaceDetailSubscriptionId <String>]
[-MarketplaceDetailSubscriptionStatus <String>]
[-OfferDetailOfferId <String>]
[-OfferDetailPlanId <String>]
[-OfferDetailPlanName <String>]
[-OfferDetailPublisherId <String>]
[-OfferDetailTermId <String>]
[-OfferDetailTermUnit <String>]
[-PartnerOrganizationPropertyOrganizationId <String>]
[-PartnerOrganizationPropertyOrganizationName <String>]
[-ProjectProperty <IProjectPropertiesUpdate>]
[-SingleSignOnPropertyAadDomain <String[]>]
[-SingleSignOnPropertyEnterpriseAppId <String>]
[-SingleSignOnPropertySingleSignOnState <String>]
[-SingleSignOnPropertySingleSignOnUrl <String>]
[-Tag <Hashtable>]
[-UserDetailEmailAddress <String>]
[-UserDetailFirstName <String>]
[-UserDetailLastName <String>]
[-UserDetailPhoneNumber <String>]
[-UserDetailUpn <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaJsonString
Update-AzNeonPostgresOrganization
-Name <String>
-ResourceGroupName <String>
-JsonString <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaJsonFilePath
Update-AzNeonPostgresOrganization
-Name <String>
-ResourceGroupName <String>
-JsonFilePath <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityExpanded
Update-AzNeonPostgresOrganization
-InputObject <INeonPostgresIdentity>
[-CompanyDetailBusinessPhone <String>]
[-CompanyDetailCompanyName <String>]
[-CompanyDetailCountry <String>]
[-CompanyDetailDomain <String>]
[-CompanyDetailNumberOfEmployee <Int64>]
[-CompanyDetailOfficeAddress <String>]
[-MarketplaceDetailSubscriptionId <String>]
[-MarketplaceDetailSubscriptionStatus <String>]
[-OfferDetailOfferId <String>]
[-OfferDetailPlanId <String>]
[-OfferDetailPlanName <String>]
[-OfferDetailPublisherId <String>]
[-OfferDetailTermId <String>]
[-OfferDetailTermUnit <String>]
[-PartnerOrganizationPropertyOrganizationId <String>]
[-PartnerOrganizationPropertyOrganizationName <String>]
[-ProjectProperty <IProjectPropertiesUpdate>]
[-SingleSignOnPropertyAadDomain <String[]>]
[-SingleSignOnPropertyEnterpriseAppId <String>]
[-SingleSignOnPropertySingleSignOnState <String>]
[-SingleSignOnPropertySingleSignOnUrl <String>]
[-Tag <Hashtable>]
[-UserDetailEmailAddress <String>]
[-UserDetailFirstName <String>]
[-UserDetailLastName <String>]
[-UserDetailPhoneNumber <String>]
[-UserDetailUpn <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
update a OrganizationResource
Examples
Example 1: Update a Neon Resource
Update-AzNeonPostgresOrganization -Name "almasTestNeonPS8" -ResourceGroupName "NeonDemoRG" -SubscriptionId "5d9a6cc3-4e60-4b41-be79-d28f0a01074e" `
-CompanyDetailBusinessPhone "+1234567890" `
-CompanyDetailCompanyName "DemoCompany" `
-CompanyDetailCountry "USA" `
-CompanyDetailDomain "demo.com" `
-CompanyDetailNumberOfEmployee 500 `
-CompanyDetailOfficeAddress "1234 Azure Ave" `
-PartnerOrganizationPropertyOrganizationId "org12345" `
-PartnerOrganizationPropertyOrganizationName "PartnerOrg8" `
-SingleSignOnPropertyAadDomain @("partnerorg.com") `
-SingleSignOnPropertyEnterpriseAppId "app12345" `
-SingleSignOnPropertySingleSignOnState "Enable" `
-SingleSignOnPropertySingleSignOnUrl "https://sso.partnerorg.com" `
-Tag @{environment="production"} `
-UserDetailEmailAddress "khanalmas@microsoft.com" `
-UserDetailFirstName "Almas" `
-UserDetailLastName "Khan" `
-UserDetailPhoneNumber "+1234567890" `
-UserDetailUpn "khanalmas_microsoft.com#EXT#@qumulotesttenant2.onmicrosoft.com"
CompanyDetailBusinessPhone : +1234567890
CompanyDetailCompanyName : DemoCompany
CompanyDetailCountry : USA
CompanyDetailDomain : demo.com
CompanyDetailNumberOfEmployee : 500
CompanyDetailOfficeAddress : 1234 Azure Ave
Id : /subscriptions/5d9a6cc3-4e60-4b41-be79-d28f0a01074e/resourceGroups/NeonDe
moRG/providers/Neon.Postgres/organizations/almasTestNeonPS8
Location : centraluseuap
MarketplaceDetailSubscriptionId : 44e2e61d-8456-4c6a-dd0a-acc4edaa729b
MarketplaceDetailSubscriptionStatus : Subscribed
Name : almasTestNeonPS8
OfferDetailOfferId : neon_test
OfferDetailPlanId : neon_test_1
OfferDetailPlanName : Neon Serverless Postgres - Free (Test_Liftr)
OfferDetailPublisherId : neon1722366567200
OfferDetailTermId : gmz7xq9ge3py
OfferDetailTermUnit : P1M
PartnerOrganizationPropertyOrganizationId : org-tiny-silence-85146383
PartnerOrganizationPropertyOrganizationName : PartnerOrg8
ProvisioningState : Succeeded
ResourceGroupName : NeonDemoRG
SingleSignOnPropertyAadDomain : {partnerorg.com}
SingleSignOnPropertyEnterpriseAppId : app12345
SingleSignOnPropertySingleSignOnState : Enable
SingleSignOnPropertySingleSignOnUrl : https://console.neon.tech/azure/sso/org-tiny-silence-85146383
SystemDataCreatedAt : 06-Nov-24 4:49:42 AM
SystemDataCreatedBy : khanalmas@microsoft.com
SystemDataCreatedByType : User
SystemDataLastModifiedAt : 06-Nov-24 4:53:15 AM
SystemDataLastModifiedBy : khanalmas@microsoft.com
SystemDataLastModifiedByType : User
Tag : {
"environment": "production"
}
Type : neon.postgres/organizations
UserDetailEmailAddress : khanalmas@microsoft.com
UserDetailFirstName : Almas
UserDetailLastName : Khan
UserDetailPhoneNumber : +1234567890
UserDetailUpn : khanalmas_microsoft.com#EXT#@qumulotesttenant2.onmicrosoft.com
This command will update a Neon Postgres organization resource
Parameters
-AsJob
Run the command as a job
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CompanyDetailBusinessPhone
Business phone number of the company
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CompanyDetailCompanyName
Company name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CompanyDetailCountry
Country name of the company
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CompanyDetailDomain
Domain of the user
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CompanyDetailNumberOfEmployee
Number of employees in the company
Parameter properties
Type: Int64
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CompanyDetailOfficeAddress
Office address of the company
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False 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
UpdateViaIdentityExpanded
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 Update operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateViaJsonFilePath
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 Update operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-MarketplaceDetailSubscriptionId
SaaS subscription id for the the marketplace offer
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-MarketplaceDetailSubscriptionStatus
Marketplace subscription status
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
Name of the Neon Organizations resource
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: OrganizationName
Parameter sets
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NoWait
Run the command asynchronously
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OfferDetailOfferId
Offer Id for the marketplace offer
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OfferDetailPlanId
Plan Id for the marketplace offer
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OfferDetailPlanName
Plan Name for the marketplace offer
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OfferDetailPublisherId
Publisher Id for the marketplace offer
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OfferDetailTermId
Term Id for the marketplace offer
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OfferDetailTermUnit
Term Name for the marketplace offer
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PartnerOrganizationPropertyOrganizationId
Organization Id in partner's system
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PartnerOrganizationPropertyOrganizationName
Organization name in partner's system
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ProjectProperty
Neon Project Properties
Parameter properties
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
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
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SingleSignOnPropertyAadDomain
List of AAD domains fetched from Microsoft Graph for user.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SingleSignOnPropertyEnterpriseAppId
AAD enterprise application Id used to setup SSO
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SingleSignOnPropertySingleSignOnState
State of the Single Sign On for the organization
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SingleSignOnPropertySingleSignOnUrl
URL for SSO to be used by the partner to redirect the user to their system
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False 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
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaJsonString
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaJsonFilePath
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
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-UserDetailEmailAddress
Email address of the user
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-UserDetailFirstName
First name of the user
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-UserDetailLastName
Last name of the user
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-UserDetailPhoneNumber
User's phone number
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-UserDetailUpn
User's principal name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
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 .
Outputs