Update-AzEventGridClient
update a client with the specified parameters.
Syntax
UpdateExpanded (Default)
Update-AzEventGridClient
-Name <String>
-NamespaceName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-Attribute <Hashtable>]
[-AuthenticationName <String>]
[-CertificateSubjectCommonName <String>]
[-CertificateSubjectCountryCode <String>]
[-CertificateSubjectOrganization <String>]
[-CertificateSubjectOrganizationUnit <String>]
[-CertificateThumbprintPrimary <String>]
[-CertificateThumbprintSecondary <String>]
[-ClientCertificateAuthenticationAllowedThumbprint <String[]>]
[-ClientCertificateAuthenticationValidationScheme <String>]
[-Description <String>]
[-State <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityNamespaceExpanded
Update-AzEventGridClient
-Name <String>
-NamespaceInputObject <IEventGridIdentity>
[-Attribute <Hashtable>]
[-AuthenticationName <String>]
[-CertificateSubjectCommonName <String>]
[-CertificateSubjectCountryCode <String>]
[-CertificateSubjectOrganization <String>]
[-CertificateSubjectOrganizationUnit <String>]
[-CertificateThumbprintPrimary <String>]
[-CertificateThumbprintSecondary <String>]
[-ClientCertificateAuthenticationAllowedThumbprint <String[]>]
[-ClientCertificateAuthenticationValidationScheme <String>]
[-Description <String>]
[-State <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityExpanded
Update-AzEventGridClient
-InputObject <IEventGridIdentity>
[-Attribute <Hashtable>]
[-AuthenticationName <String>]
[-CertificateSubjectCommonName <String>]
[-CertificateSubjectCountryCode <String>]
[-CertificateSubjectOrganization <String>]
[-CertificateSubjectOrganizationUnit <String>]
[-CertificateThumbprintPrimary <String>]
[-CertificateThumbprintSecondary <String>]
[-ClientCertificateAuthenticationAllowedThumbprint <String[]>]
[-ClientCertificateAuthenticationValidationScheme <String>]
[-Description <String>]
[-State <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
update a client with the specified parameters.
Examples
Example 1: Create a client with the specified parameters.
$attribute = @{"room"="345";"floor"="3";"deviceTypes"="AC"}
Update-AzEventGridClient -Name azps-client -NamespaceName azps-eventgridnamespace -ResourceGroupName azps_test_group_eventgrid -Attribute $attribute -Description "This is a test client"
Name ResourceGroupName
---- -----------------
azps-client azps_test_group_eventgrid
Create a client with the specified parameters.
Example 2: Create a client with the specified parameters.
$attribute = @{"room"="345";"floor"="3";"deviceTypes"="AC"}
$client = Get-AzEventGridClient -Name azps-client -NamespaceName azps-eventgridnamespace -ResourceGroupName azps_test_group_eventgrid
Update-AzEventGridClient -InputObject $client -Attribute $attribute -Description "This is a test client"
Name ResourceGroupName
---- -----------------
azps-client azps_test_group_eventgrid
Create a client with the specified parameters.
Example 3: Create a client with the specified parameters.
$attribute = @{"room"="345";"floor"="3";"deviceTypes"="AC"}
$namespace = Get-AzEventGridNamespace -ResourceGroupName azps_test_group_eventgrid -Name azps-eventgridnamespace
Update-AzEventGridClient -Name azps-client -NamespaceInputObject $namespace -Attribute $attribute -Description "This is a test client"
Name ResourceGroupName
---- -----------------
azps-client azps_test_group_eventgrid
Create a client with the specified parameters.
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
-Attribute
Attributes for the client.
Supported values are int, bool, string, string[].Example:"attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }
Parameter properties
Type: Hashtable
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
-AuthenticationName
The name presented by the client for authentication.
The default value is the name of the resource.
Parameter properties
Type: String
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
-CertificateSubjectCommonName
The common name field in the subject name.
The allowed limit is 64 characters and it should be specified.
Parameter properties
Type: String
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
-CertificateSubjectCountryCode
The country code field in the subject name.
If present, the country code should be represented by two-letter code defined in ISO 2166-1 (alpha-2).
For example: 'US'.
Parameter properties
Type: String
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
-CertificateSubjectOrganization
The organization field in the subject name.
If present, the allowed limit is 64 characters.
Parameter properties
Type: String
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
-CertificateSubjectOrganizationUnit
The organization unit field in the subject name.
If present, the allowed limit is 32 characters.
Parameter properties
Type: String
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
-CertificateThumbprintPrimary
The primary thumbprint used for validation.
Parameter properties
Type: String
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
-CertificateThumbprintSecondary
The secondary thumbprint used for validation.
Parameter properties
Type: String
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
-ClientCertificateAuthenticationAllowedThumbprint
The list of thumbprints that are allowed during client authentication.
This property is required only if the validationScheme is 'ThumbprintMatch'.
Parameter properties
Type: String [ ]
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
-ClientCertificateAuthenticationValidationScheme
The validation scheme used to authenticate the client.
Default value is SubjectMatchesAuthenticationName.
Parameter properties
Type: String
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
-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
-Description
Description for the Client resource.
Parameter properties
Type: String
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
Identity Parameter
UpdateViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Name
The client name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: ClientName
Parameter sets
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityNamespaceExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
UpdateViaIdentityNamespaceExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-NamespaceName
Name of the namespace.
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
-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
-ResourceGroupName
The name of the resource group within the user's subscription.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: ResourceGroup
Parameter sets
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-State
Indicates if the client is enabled or not.
Default value is Enabled.
Parameter properties
Type: String
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
-SubscriptionId
Subscription credentials that uniquely identify a Microsoft Azure subscription.
The subscription ID forms part of the URI for every service call.
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
-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
