Update-AzEventGridClient
Update a client with the specified parameters.
Syntax
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>] 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>] 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_eventgridCreate 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_eventgridCreate 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_eventgridCreate a client with the specified parameters.
Parameters
-AsJob
Run the command as a job
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Attribute
Attributes for the client. Supported values are int, bool, string, string[].Example:"attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AuthenticationName
The name presented by the client for authentication. The default value is the name of the resource.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CertificateSubjectCommonName
The common name field in the subject name. The allowed limit is 64 characters and it should be specified.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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'.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CertificateSubjectOrganization
The organization field in the subject name. If present, the allowed limit is 64 characters.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CertificateSubjectOrganizationUnit
The organization unit field in the subject name. If present, the allowed limit is 32 characters.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CertificateThumbprintPrimary
The primary thumbprint used for validation.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CertificateThumbprintSecondary
The secondary thumbprint used for validation.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ClientCertificateAuthenticationAllowedThumbprint
The list of thumbprints that are allowed during client authentication. This property is required only if the validationScheme is 'ThumbprintMatch'.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ClientCertificateAuthenticationValidationScheme
The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
Description for the Client resource.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter
| Type: | IEventGridIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
The client name.
| Type: | String |
| Aliases: | ClientName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NamespaceInputObject
Identity Parameter
| Type: | IEventGridIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-NamespaceName
Name of the namespace.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NoWait
Run the command asynchronously
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group within the user's subscription.
| Type: | String |
| Aliases: | ResourceGroup |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-State
Indicates if the client is enabled or not. Default value is Enabled.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
| Type: | String |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Outputs
Azure PowerShell
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for