Invoke ADCUpdateAuthenticationazurekeyvault - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCUpdateAuthenticationazurekeyvault

SYNOPSIS

Update Authentication configuration Object.

SYNTAX

Invoke-ADCUpdateAuthenticationazurekeyvault [-Name] <String> [[-Vaultname] <String>] [[-Clientid] <String>]
 [[-Clientsecret] <String>] [[-Servicekeyname] <String>] [[-Signaturealg] <String>] [[-Tokenendpoint] <String>]
 [[-Pushservice] <String>] [[-Defaultauthenticationgroup] <String>] [[-Refreshinterval] <Double>]
 [[-Tenantid] <String>] [[-Authentication] <String>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for Azure Key Vault entity resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCUpdateAuthenticationazurekeyvault -name <string>

An example how to update authenticationazurekeyvault configuration Object(s).

PARAMETERS

-Name

Name for the new Azure Key Vault profile. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after an action is created.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Vaultname

Name of the Azure vault account as configured in azure portal.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Clientid

Unique identity of the relying party requesting for authentication.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Clientsecret

Unique secret string to authorize relying party at authorization server.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Servicekeyname

Friendly name of the Key to be used to compute signature.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Signaturealg

Algorithm to be used to sign/verify transactions. Possible values = RS256

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Tokenendpoint

URL endpoint on relying party to which the OAuth token is to be sent.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Pushservice

Name of the service used to send push notifications.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Defaultauthenticationgroup

This is the group that is added to user sessions that match current IdP policy. It can be used in policies to identify relying party trust.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Refreshinterval

Interval at which access token in obtained.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Tenantid

TenantID of the application. This is usually specific to providers such as Microsoft and usually refers to the deployment identifier.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Authentication

If authentication is disabled, otp checks are not performed after azure vault keys are obtained. This is useful to distinguish whether user has registered devices. . Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

Return details about the created authenticationazurekeyvault item.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 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
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

File Name : Invoke-ADCUpdateAuthenticationazurekeyvault Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/authentication/authenticationazurekeyvault/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.

RELATED LINKS

https://blog.j81.nl

⚠️ **GitHub.com Fallback** ⚠️