Show / Hide Table of Contents

Set-OCIClientSession

SYNOPSIS

Sets the OCI Cmdlet parameter preference for this session.

SYNTAX

Set-OCIClientSession [-RegionId <String>] [-Profile <String>] [-Config <String>] [-AuthType <AuthenticationType>] [-TimeOutInMillis <Int32>] [-NoRetry] [<CommonParameters>]

DESCRIPTION

This cmdlet sets a preferred OCI Region(-Id), Config Profile name, path to the Config file, Authentication type, Timeout and NoRetry to be used by OCI Cmdlets for making API calls in the current PowerShell session.

PARAMETERS

-AuthType

Type of authentication to use for making API requests in this session.

Type: AuthenticationType
Parameter Sets: (All)
Aliases: None
Accepted values: ApiKey, InstancePrincipal, SessionToken

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Config

Path to the config file to be used for this session.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-NoRetry

Disable retry logic for calls to services in this session.

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

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Profile

The profile in the config file to load for this session.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-RegionId

The region to make calls against for this session.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimeOutInMillis

Max wait time in milliseconds for the API request to complete in this session. Default is 100000 millis(100 secs).

Type: Int32
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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.

OUTPUTS

  • Oci.PSModules.Common.Cmdlets.ClientManagement.OCIClientSession

RELATED LINKS

  • OCIModulesDocs
  • Examples
Back to top Generated by DocFX