| external help file | Module Name | online version | schema |
|---|---|---|---|
Intersight.PowerShell.dll-Help.xml |
Intersight.PowerShell |
2.0.0 |
Fill in the Synopsis
Set-IntersightIamApiKey [-AdditionalProperties< System.Collections.Generic.Dictionary`2[string,object]>][-AdminStatus< IamApiKey.AdminStatusEnum>][-ExpiryDateTime< DateTime>][-HashAlgorithm< IamApiKey.HashAlgorithmEnum>][-IsNeverExpiring< bool>][-KeySpec< PkixKeyGenerationSpec>][[-Moid]< string>][-PrivateKey< string>][-Purpose< string>][-SigningAlgorithm< IamApiKey.SigningAlgorithmEnum>][-Tags< System.Collections.Generic.List`1[MoTag]>][-Json< SwitchParameter>][-WithHttpInfo< SwitchParameter>]
Update a 'IamApiKey' resource.
Type: System.Collections.Generic.Dictionary`2[string,object]
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseUsed to trigger the enable or disable action on the API key. These actions change the status of an API key.\n* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.\n* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.
Type: IamApiKey.AdminStatusEnum
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseThe expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseThe cryptographic hash algorithm to calculate the message digest.\n* SHA256 - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.\n* SHA384 - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.\n* SHA512 - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.\n* SHA512_224 - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.\n* SHA512_256 - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.
Type: IamApiKey.HashAlgorithmEnum
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseUsed to mark the API key as a never-expiring API key.
Type: bool
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseThe key generation specification provides the algorithm and the parameters required for this algorithm to generate a private key, public key pair. Supported key generation schemes include RSA, ECDSA and Edwards-Curve Digital Signature Algorithm (EdDSA).
Note :- Use Initialize-IntersightPkixKeyGenerationSpec to create the object of complex type PkixKeyGenerationSpec
Type: PkixKeyGenerationSpec
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseThe unique identifier of this Managed Object instance.
Type: string
Parameter Sets: (All)
Aliases:
Required: true
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseHolds the private key for the API key.
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseThe purpose of the API Key.
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseThe signing algorithm used by the client to authenticate API requests to Intersight.\nThe signing algorithm must be compatible with the key generation specification.\n* RSASSA-PKCS1-v1_5 - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in RFC 8017.RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.\n* RSASSA-PSS - RSASSA-PSS is a RSA signature scheme specified in RFC 8017.It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.\n* Ed25519 - The Ed25519 signature algorithm, as specified in RFC 8032.Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.\n* Ecdsa - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.\n* EcdsaP1363Format - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.
Type: IamApiKey.SigningAlgorithmEnum
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseNote :- Use Initialize-IntersightMoTag to create the object of complex type MoTag
Type: System.Collections.Generic.List`1[MoTag]
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseReturns the json payload received in response.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: FalseReturns the HTTP response with headers and content.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
PS C:\> Set-IntersightIamApiKey{ Add example description here }
Initialize-IntersightMoVersionContext