Remove-OCINetworkloadbalancerBackend
SYNOPSIS
Invokes NetworkLoadBalancer service - DeleteBackend operation.
SYNTAX
Remove-OCINetworkloadbalancerBackend -NetworkLoadBalancerId <String> -BackendSetName <String> -BackendName <String> [-OpcRequestId <String>] [-IfMatch <String>] [-Force] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Removes a backend server from a given network load balancer and backend set.
PARAMETERS
-AuthType
Type of authentication to use for making API requests. Default is Key based Authentication.
Type: AuthenticationType
Parameter Sets: (All)
Aliases: None
Accepted values: ApiKey, InstancePrincipal, SessionToken
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BackendName
The name of the backend server to remove. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as <ipAddress>:<port>. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as <targetId>:<port>.
Example: `10.0.0.3:8080` or `ocid1.privateip..oc1.<var><unique_ID></var>:8080`
Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-BackendSetName
The name of the backend set associated with the backend server.
Example: `example_backend_set`
Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ConfigFile
The path to the config file.
Type: String
Parameter Sets: (All)
Aliases: None
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
-Endpoint
The value to use as the service endpoint, including any required API version path.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Force
Ignore confirmation and force the Cmdlet to complete action.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-FullResponse
Output the complete response returned by the API Operation. Using this switch will make this Cmdlet output an object containing response headers in-addition to an optional response body.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-IfMatch
For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-NetworkLoadBalancerId
The OCID of the network load balancer to update.
Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-NoRetry
Disable retry logic for calls to services.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OpcRequestId
The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
Type: String
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.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Region
Region-id of the region to make calls against. eg) us-phoenix-1, ap-singapore-1
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. Default is 100000 millis(100 secs).
Type: Int32
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
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
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.WorkRequest
- Oci.NetworkloadbalancerService.Responses.DeleteBackendResponse