Class VirtualNetworkClient
Service client instance for VirtualNetwork.
Implements
Inherited Members
Namespace: Oci.CoreService
Assembly: OCI.DotNetSDK.Core.dll
Syntax
public class VirtualNetworkClient : RegionalClientBase, IDisposable
Constructors
VirtualNetworkClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public VirtualNetworkClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public VirtualNetworkPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
VirtualNetworkPaginators |
Waiters
Declaration
public VirtualNetworkWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
VirtualNetworkWaiters |
Methods
AddDrgRouteDistributionStatements(AddDrgRouteDistributionStatementsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Adds one or more route distribution statements to the specified route distribution.
Declaration
public Task<AddDrgRouteDistributionStatementsResponse> AddDrgRouteDistributionStatements(AddDrgRouteDistributionStatementsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddDrgRouteDistributionStatementsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddDrgRouteDistributionStatementsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddDrgRouteDistributionStatements API.
AddDrgRouteRules(AddDrgRouteRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Adds one or more static route rules to the specified DRG route table.
Declaration
public Task<AddDrgRouteRulesResponse> AddDrgRouteRules(AddDrgRouteRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddDrgRouteRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddDrgRouteRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddDrgRouteRules API.
AddIpv6SubnetCidr(AddIpv6SubnetCidrRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Add an IPv6 prefix to a subnet.
Declaration
public Task<AddIpv6SubnetCidrResponse> AddIpv6SubnetCidr(AddIpv6SubnetCidrRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddIpv6SubnetCidrRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddIpv6SubnetCidrResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddIpv6SubnetCidr API.
AddIpv6VcnCidr(AddIpv6VcnCidrRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Add an IPv6 prefix to a VCN. The VCN size is always /56 and assigned by Oracle. Once added the IPv6 prefix cannot be removed or modified.
Declaration
public Task<AddIpv6VcnCidrResponse> AddIpv6VcnCidr(AddIpv6VcnCidrRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddIpv6VcnCidrRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddIpv6VcnCidrResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddIpv6VcnCidr API.
AddNetworkSecurityGroupSecurityRules(AddNetworkSecurityGroupSecurityRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Adds up to 25 security rules to the specified network security group. Adding more than 25 rules requires multiple operations.
Declaration
public Task<AddNetworkSecurityGroupSecurityRulesResponse> AddNetworkSecurityGroupSecurityRules(AddNetworkSecurityGroupSecurityRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddNetworkSecurityGroupSecurityRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddNetworkSecurityGroupSecurityRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddNetworkSecurityGroupSecurityRules API.
AddPublicIpPoolCapacity(AddPublicIpPoolCapacityRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Adds some or all of a CIDR block to a public IP pool. <br/> The CIDR block (or subrange) must not overlap with any other CIDR block already added to this or any other public IP pool.
Declaration
public Task<AddPublicIpPoolCapacityResponse> AddPublicIpPoolCapacity(AddPublicIpPoolCapacityRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddPublicIpPoolCapacityRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddPublicIpPoolCapacityResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddPublicIpPoolCapacity API.
AddVcnCidr(AddVcnCidrRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Adds a CIDR block to a VCN. The CIDR block you add: <br/>
- Must be valid.
- Must not overlap with another CIDR block in the VCN, a CIDR block of a peered VCN, or the on-premises network CIDR block.
- Must not exceed the limit of CIDR blocks allowed per VCN.
<br/>
Note: Adding a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can take a few minutes. You can use the
GetWorkRequest
operation to check the status of the update.
Declaration
public Task<AddVcnCidrResponse> AddVcnCidr(AddVcnCidrRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddVcnCidrRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddVcnCidrResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddVcnCidr API.
AdvertiseByoipRange(AdvertiseByoipRangeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Begins BGP route advertisements for the BYOIP CIDR block you imported to the Oracle Cloud.
The ByoipRange
resource must be in the PROVISIONED state before the BYOIP CIDR block routes can be advertised with BGP.
Declaration
public Task<AdvertiseByoipRangeResponse> AdvertiseByoipRange(AdvertiseByoipRangeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AdvertiseByoipRangeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AdvertiseByoipRangeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AdvertiseByoipRange API.
AttachServiceId(AttachServiceIdRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Adds the specified {@link Service} to the list of enabled
Service
objects for the specified gateway. You must also set up a route rule with the
cidrBlock
of the Service
as the rule's destination and the service gateway as the rule's
target. See {@link RouteTable}.
<br/>
Note: The AttachServiceId
operation is an easy way to add an individual Service
to
the service gateway. Compare it with
{@link #updateServiceGateway(UpdateServiceGatewayRequest) updateServiceGateway}, which replaces
the entire existing list of enabled Service
objects with the list that you provide in the
Update
call.
Declaration
public Task<AttachServiceIdResponse> AttachServiceId(AttachServiceIdRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AttachServiceIdRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AttachServiceIdResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AttachServiceId API.
BulkAddVirtualCircuitPublicPrefixes(BulkAddVirtualCircuitPublicPrefixesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Adds one or more customer public IP prefixes to the specified public virtual circuit. Use this operation (and not {@link #updateVirtualCircuit(UpdateVirtualCircuitRequest) updateVirtualCircuit}) to add prefixes to the virtual circuit. Oracle must verify the customer's ownership of each prefix before traffic for that prefix will flow across the virtual circuit.
Declaration
public Task<BulkAddVirtualCircuitPublicPrefixesResponse> BulkAddVirtualCircuitPublicPrefixes(BulkAddVirtualCircuitPublicPrefixesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BulkAddVirtualCircuitPublicPrefixesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<BulkAddVirtualCircuitPublicPrefixesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BulkAddVirtualCircuitPublicPrefixes API.
BulkDeleteVirtualCircuitPublicPrefixes(BulkDeleteVirtualCircuitPublicPrefixesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes one or more customer public IP prefixes from the specified public virtual circuit. Use this operation (and not {@link #updateVirtualCircuit(UpdateVirtualCircuitRequest) updateVirtualCircuit}) to remove prefixes from the virtual circuit. When the virtual circuit's state switches back to PROVISIONED, Oracle stops advertising the specified prefixes across the connection.
Declaration
public Task<BulkDeleteVirtualCircuitPublicPrefixesResponse> BulkDeleteVirtualCircuitPublicPrefixes(BulkDeleteVirtualCircuitPublicPrefixesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BulkDeleteVirtualCircuitPublicPrefixesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<BulkDeleteVirtualCircuitPublicPrefixesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BulkDeleteVirtualCircuitPublicPrefixes API.
ChangeByoipRangeCompartment(ChangeByoipRangeCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a BYOIP CIDR block to a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeByoipRangeCompartmentResponse> ChangeByoipRangeCompartment(ChangeByoipRangeCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeByoipRangeCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeByoipRangeCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeByoipRangeCompartment API.
ChangeCaptureFilterCompartment(ChangeCaptureFilterCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a capture filter to a new compartment in the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeCaptureFilterCompartmentResponse> ChangeCaptureFilterCompartment(ChangeCaptureFilterCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeCaptureFilterCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeCaptureFilterCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeCaptureFilterCompartment API.
ChangeCpeCompartment(ChangeCpeCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a CPE object into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeCpeCompartmentResponse> ChangeCpeCompartment(ChangeCpeCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeCpeCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeCpeCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeCpeCompartment API.
ChangeCrossConnectCompartment(ChangeCrossConnectCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a cross-connect into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeCrossConnectCompartmentResponse> ChangeCrossConnectCompartment(ChangeCrossConnectCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeCrossConnectCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeCrossConnectCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeCrossConnectCompartment API.
ChangeCrossConnectGroupCompartment(ChangeCrossConnectGroupCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a cross-connect group into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeCrossConnectGroupCompartmentResponse> ChangeCrossConnectGroupCompartment(ChangeCrossConnectGroupCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeCrossConnectGroupCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeCrossConnectGroupCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeCrossConnectGroupCompartment API.
ChangeDhcpOptionsCompartment(ChangeDhcpOptionsCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a set of DHCP options into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeDhcpOptionsCompartmentResponse> ChangeDhcpOptionsCompartment(ChangeDhcpOptionsCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeDhcpOptionsCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeDhcpOptionsCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeDhcpOptionsCompartment API.
ChangeDrgCompartment(ChangeDrgCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a DRG into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeDrgCompartmentResponse> ChangeDrgCompartment(ChangeDrgCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeDrgCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeDrgCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeDrgCompartment API.
ChangeIPSecConnectionCompartment(ChangeIPSecConnectionCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves an IPSec connection into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeIPSecConnectionCompartmentResponse> ChangeIPSecConnectionCompartment(ChangeIPSecConnectionCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeIPSecConnectionCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeIPSecConnectionCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeIPSecConnectionCompartment API.
ChangeInternetGatewayCompartment(ChangeInternetGatewayCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves an internet gateway into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeInternetGatewayCompartmentResponse> ChangeInternetGatewayCompartment(ChangeInternetGatewayCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeInternetGatewayCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeInternetGatewayCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeInternetGatewayCompartment API.
ChangeLocalPeeringGatewayCompartment(ChangeLocalPeeringGatewayCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a local peering gateway into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeLocalPeeringGatewayCompartmentResponse> ChangeLocalPeeringGatewayCompartment(ChangeLocalPeeringGatewayCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeLocalPeeringGatewayCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeLocalPeeringGatewayCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeLocalPeeringGatewayCompartment API.
ChangeNatGatewayCompartment(ChangeNatGatewayCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a NAT gateway into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeNatGatewayCompartmentResponse> ChangeNatGatewayCompartment(ChangeNatGatewayCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeNatGatewayCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeNatGatewayCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeNatGatewayCompartment API.
ChangeNetworkSecurityGroupCompartment(ChangeNetworkSecurityGroupCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a network security group into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeNetworkSecurityGroupCompartmentResponse> ChangeNetworkSecurityGroupCompartment(ChangeNetworkSecurityGroupCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeNetworkSecurityGroupCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeNetworkSecurityGroupCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeNetworkSecurityGroupCompartment API.
ChangePublicIpCompartment(ChangePublicIpCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a public IP into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment. <br/> This operation applies only to reserved public IPs. Ephemeral public IPs always belong to the same compartment as their VNIC and move accordingly.
Declaration
public Task<ChangePublicIpCompartmentResponse> ChangePublicIpCompartment(ChangePublicIpCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangePublicIpCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangePublicIpCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangePublicIpCompartment API.
ChangePublicIpPoolCompartment(ChangePublicIpPoolCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a public IP pool to a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangePublicIpPoolCompartmentResponse> ChangePublicIpPoolCompartment(ChangePublicIpPoolCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangePublicIpPoolCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangePublicIpPoolCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangePublicIpPoolCompartment API.
ChangeRemotePeeringConnectionCompartment(ChangeRemotePeeringConnectionCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a remote peering connection (RPC) into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeRemotePeeringConnectionCompartmentResponse> ChangeRemotePeeringConnectionCompartment(ChangeRemotePeeringConnectionCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeRemotePeeringConnectionCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeRemotePeeringConnectionCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeRemotePeeringConnectionCompartment API.
ChangeRouteTableCompartment(ChangeRouteTableCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a route table into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeRouteTableCompartmentResponse> ChangeRouteTableCompartment(ChangeRouteTableCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeRouteTableCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeRouteTableCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeRouteTableCompartment API.
ChangeSecurityListCompartment(ChangeSecurityListCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a security list into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeSecurityListCompartmentResponse> ChangeSecurityListCompartment(ChangeSecurityListCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeSecurityListCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeSecurityListCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeSecurityListCompartment API.
ChangeServiceGatewayCompartment(ChangeServiceGatewayCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a service gateway into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeServiceGatewayCompartmentResponse> ChangeServiceGatewayCompartment(ChangeServiceGatewayCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeServiceGatewayCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeServiceGatewayCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeServiceGatewayCompartment API.
ChangeSubnetCompartment(ChangeSubnetCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a subnet into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeSubnetCompartmentResponse> ChangeSubnetCompartment(ChangeSubnetCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeSubnetCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeSubnetCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeSubnetCompartment API.
ChangeVcnCompartment(ChangeVcnCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a VCN into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeVcnCompartmentResponse> ChangeVcnCompartment(ChangeVcnCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeVcnCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeVcnCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeVcnCompartment API.
ChangeVirtualCircuitCompartment(ChangeVirtualCircuitCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a virtual circuit into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeVirtualCircuitCompartmentResponse> ChangeVirtualCircuitCompartment(ChangeVirtualCircuitCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeVirtualCircuitCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeVirtualCircuitCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeVirtualCircuitCompartment API.
ChangeVlanCompartment(ChangeVlanCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a VLAN into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeVlanCompartmentResponse> ChangeVlanCompartment(ChangeVlanCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeVlanCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeVlanCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeVlanCompartment API.
ChangeVtapCompartment(ChangeVtapCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a VTAP to a new compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeVtapCompartmentResponse> ChangeVtapCompartment(ChangeVtapCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeVtapCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeVtapCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeVtapCompartment API.
ConnectLocalPeeringGateways(ConnectLocalPeeringGatewaysRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Connects this local peering gateway (LPG) to another one in the same region. <br/> This operation must be called by the VCN administrator who is designated as the requestor in the peering relationship. The acceptor must implement an Identity and Access Management (IAM) policy that gives the requestor permission to connect to LPGs in the acceptor's compartment. Without that permission, this operation will fail. For more information, see VCN Peering.
Declaration
public Task<ConnectLocalPeeringGatewaysResponse> ConnectLocalPeeringGateways(ConnectLocalPeeringGatewaysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ConnectLocalPeeringGatewaysRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ConnectLocalPeeringGatewaysResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ConnectLocalPeeringGateways API.
ConnectRemotePeeringConnections(ConnectRemotePeeringConnectionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Connects this RPC to another one in a different region. <br/> This operation must be called by the VCN administrator who is designated as the requestor in the peering relationship. The acceptor must implement an Identity and Access Management (IAM) policy that gives the requestor permission to connect to RPCs in the acceptor's compartment. Without that permission, this operation will fail. For more information, see VCN Peering.
Declaration
public Task<ConnectRemotePeeringConnectionsResponse> ConnectRemotePeeringConnections(ConnectRemotePeeringConnectionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ConnectRemotePeeringConnectionsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ConnectRemotePeeringConnectionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ConnectRemotePeeringConnections API.
CreateByoipRange(CreateByoipRangeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a subrange of the BYOIP CIDR block.
Declaration
public Task<CreateByoipRangeResponse> CreateByoipRange(CreateByoipRangeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateByoipRangeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateByoipRangeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateByoipRange API.
CreateCaptureFilter(CreateCaptureFilterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a virtual test access point (VTAP) capture filter in the specified compartment. <br/> For the purposes of access control, you must provide the OCID of the compartment that contains the VTAP. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers. <br/> You may optionally specify a display name for the VTAP, otherwise a default is provided. It does not have to be unique, and you can change it.
Declaration
public Task<CreateCaptureFilterResponse> CreateCaptureFilter(CreateCaptureFilterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateCaptureFilterRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateCaptureFilterResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateCaptureFilter API.
CreateCpe(CreateCpeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new virtual customer-premises equipment (CPE) object in the specified compartment. For more information, see Site-to-Site VPN Overview. <br/> For the purposes of access control, you must provide the OCID of the compartment where you want the CPE to reside. Notice that the CPE doesn't have to be in the same compartment as the IPSec connection or other Networking Service components. If you're not sure which compartment to use, put the CPE in the same compartment as the DRG. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers. <br/> You must provide the public IP address of your on-premises router. See CPE Configuration. <br/> You may optionally specify a display name for the CPE, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.
Declaration
public Task<CreateCpeResponse> CreateCpe(CreateCpeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateCpeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateCpeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateCpe API.
CreateCrossConnect(CreateCrossConnectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new cross-connect. Oracle recommends you create each cross-connect in a
{@link CrossConnectGroup} so you can use link aggregation
with the connection.
<br/>
After creating the CrossConnect
object, you need to go the FastConnect location
and request to have the physical cable installed. For more information, see
FastConnect Overview.
<br/>
For the purposes of access control, you must provide the OCID of the
compartment where you want the cross-connect to reside. If you're
not sure which compartment to use, put the cross-connect in the
same compartment with your VCN. For more information about
compartments and access control, see
Overview of the IAM Service.
For information about OCIDs, see
Resource Identifiers.
<br/>
You may optionally specify a display name for the cross-connect.
It does not have to be unique, and you can change it. Avoid entering confidential information.
Declaration
public Task<CreateCrossConnectResponse> CreateCrossConnect(CreateCrossConnectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateCrossConnectRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateCrossConnectResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateCrossConnect API.
CreateCrossConnectGroup(CreateCrossConnectGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new cross-connect group to use with Oracle Cloud Infrastructure FastConnect. For more information, see FastConnect Overview. <br/> For the purposes of access control, you must provide the OCID of the compartment where you want the cross-connect group to reside. If you're not sure which compartment to use, put the cross-connect group in the same compartment with your VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers. <br/> You may optionally specify a display name for the cross-connect group. It does not have to be unique, and you can change it. Avoid entering confidential information.
Declaration
public Task<CreateCrossConnectGroupResponse> CreateCrossConnectGroup(CreateCrossConnectGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateCrossConnectGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateCrossConnectGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateCrossConnectGroup API.
CreateDhcpOptions(CreateDhcpOptionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new set of DHCP options for the specified VCN. For more information, see {@link DhcpOptions}. <br/> For the purposes of access control, you must provide the OCID of the compartment where you want the set of DHCP options to reside. Notice that the set of options doesn't have to be in the same compartment as the VCN, subnets, or other Networking Service components. If you're not sure which compartment to use, put the set of DHCP options in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers. <br/> You may optionally specify a display name for the set of DHCP options, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.
Declaration
public Task<CreateDhcpOptionsResponse> CreateDhcpOptions(CreateDhcpOptionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDhcpOptionsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateDhcpOptionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDhcpOptions API.
CreateDrg(CreateDrgRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new dynamic routing gateway (DRG) in the specified compartment. For more information, see Dynamic Routing Gateways (DRGs). <br/> For the purposes of access control, you must provide the OCID of the compartment where you want the DRG to reside. Notice that the DRG doesn't have to be in the same compartment as the VCN, the DRG attachment, or other Networking Service components. If you're not sure which compartment to use, put the DRG in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers. <br/> You may optionally specify a display name for the DRG, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.
Declaration
public Task<CreateDrgResponse> CreateDrg(CreateDrgRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDrgRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateDrgResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDrg API.
CreateDrgAttachment(CreateDrgAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Attaches the specified DRG to the specified network resource. A VCN can be attached to only one DRG
at a time, but a DRG can be attached to more than one VCN. The response includes a DrgAttachment
object with its own OCID. For more information about DRGs, see
Dynamic Routing Gateways (DRGs).
<br/>
You may optionally specify a display name for the attachment, otherwise a default is provided.
It does not have to be unique, and you can change it. Avoid entering confidential information.
<br/>
For the purposes of access control, the DRG attachment is automatically placed into the currently selected compartment.
For more information about compartments and access control, see
Overview of the IAM Service.
Declaration
public Task<CreateDrgAttachmentResponse> CreateDrgAttachment(CreateDrgAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDrgAttachmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateDrgAttachmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDrgAttachment API.
CreateDrgRouteDistribution(CreateDrgRouteDistributionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new route distribution for the specified DRG.
Assign the route distribution as an import distribution to a DRG route table using the UpdateDrgRouteTable
or CreateDrgRouteTable
operations.
Assign the route distribution as an export distribution to a DRG attachment
using the UpdateDrgAttachment
or CreateDrgAttachment
operations.
Declaration
public Task<CreateDrgRouteDistributionResponse> CreateDrgRouteDistribution(CreateDrgRouteDistributionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDrgRouteDistributionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateDrgRouteDistributionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDrgRouteDistribution API.
CreateDrgRouteTable(CreateDrgRouteTableRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new DRG route table for the specified DRG. Assign the DRG route table to a DRG attachment
using the UpdateDrgAttachment
or CreateDrgAttachment
operations.
Declaration
public Task<CreateDrgRouteTableResponse> CreateDrgRouteTable(CreateDrgRouteTableRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDrgRouteTableRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateDrgRouteTableResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDrgRouteTable API.
CreateIPSecConnection(CreateIPSecConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new IPSec connection between the specified DRG and CPE. For more information, see Site-to-Site VPN Overview. <br/> If you configure at least one tunnel to use static routing, then in the request you must provide at least one valid static route (you're allowed a maximum of 10). For example: 10.0.0.0/16. If you configure both tunnels to use BGP dynamic routing, you can provide an empty list for the static routes. For more information, see the important note in {@link IPSecConnection}. <br/> For the purposes of access control, you must provide the OCID of the compartment where you want the IPSec connection to reside. Notice that the IPSec connection doesn't have to be in the same compartment as the DRG, CPE, or other Networking Service components. If you're not sure which compartment to use, put the IPSec connection in the same compartment as the DRG. For more information about compartments and access control, see Overview of the IAM Service. <br/> You may optionally specify a display name for the IPSec connection, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. <br/> After creating the IPSec connection, you need to configure your on-premises router with tunnel-specific information. For tunnel status and the required configuration information, see: <br/>
- {@link IPSecConnectionTunnel}
- {@link IPSecConnectionTunnelSharedSecret} <br/> For each tunnel, you need the IP address of Oracle's VPN headend and the shared secret (that is, the pre-shared key). For more information, see CPE Configuration.
Declaration
public Task<CreateIPSecConnectionResponse> CreateIPSecConnection(CreateIPSecConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateIPSecConnectionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateIPSecConnectionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateIPSecConnection API.
CreateInternetGateway(CreateInternetGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new internet gateway for the specified VCN. For more information, see Access to the Internet. <br/> For the purposes of access control, you must provide the OCID of the compartment where you want the Internet Gateway to reside. Notice that the internet gateway doesn't have to be in the same compartment as the VCN or other Networking Service components. If you're not sure which compartment to use, put the Internet Gateway in the same compartment with the VCN. For more information about compartments and access control, see Overview of the IAM Service. <br/> You may optionally specify a display name for the internet gateway, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. <br/> For traffic to flow between a subnet and an internet gateway, you must create a route rule accordingly in the subnet's route table (for example, 0.0.0.0/0 > internet gateway). See {@link #updateRouteTable(UpdateRouteTableRequest) updateRouteTable}. <br/> You must specify whether the internet gateway is enabled when you create it. If it's disabled, that means no traffic will flow to/from the internet even if there's a route rule that enables that traffic. You can later use {@link #updateInternetGateway(UpdateInternetGatewayRequest) updateInternetGateway} to easily disable/enable the gateway without changing the route rule.
Declaration
public Task<CreateInternetGatewayResponse> CreateInternetGateway(CreateInternetGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateInternetGatewayRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateInternetGatewayResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateInternetGateway API.
CreateIpv6(CreateIpv6Request, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates an IPv6 for the specified VNIC.
Declaration
public Task<CreateIpv6Response> CreateIpv6(CreateIpv6Request request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateIpv6Request | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateIpv6Response> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateIpv6 API.
CreateLocalPeeringGateway(CreateLocalPeeringGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new local peering gateway (LPG) for the specified VCN.
Declaration
public Task<CreateLocalPeeringGatewayResponse> CreateLocalPeeringGateway(CreateLocalPeeringGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateLocalPeeringGatewayRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateLocalPeeringGatewayResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateLocalPeeringGateway API.
CreateNatGateway(CreateNatGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new NAT gateway for the specified VCN. You must also set up a route rule with the NAT gateway as the rule's target. See {@link RouteTable}.
Declaration
public Task<CreateNatGatewayResponse> CreateNatGateway(CreateNatGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateNatGatewayRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateNatGatewayResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateNatGateway API.
CreateNetworkSecurityGroup(CreateNetworkSecurityGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new network security group for the specified VCN.
Declaration
public Task<CreateNetworkSecurityGroupResponse> CreateNetworkSecurityGroup(CreateNetworkSecurityGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateNetworkSecurityGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateNetworkSecurityGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateNetworkSecurityGroup API.
CreatePrivateIp(CreatePrivateIpRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a secondary private IP for the specified VNIC. For more information about secondary private IPs, see IP Addresses.
Declaration
public Task<CreatePrivateIpResponse> CreatePrivateIp(CreatePrivateIpRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreatePrivateIpRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreatePrivateIpResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreatePrivateIp API.
CreatePublicIp(CreatePublicIpRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a public IP. Use the lifetime
property to specify whether it's an ephemeral or
reserved public IP. For information about limits on how many you can create, see
Public IP Addresses.
<br/>
- For an ephemeral public IP assigned to a private IP: You must also specify a
privateIpId
with the OCID of the primary private IP you want to assign the public IP to. The public IP is created in the same availability domain as the private IP. An ephemeral public IP must always be assigned to a private IP, and only to the primary private IP on a VNIC, not a secondary private IP. Exception: If you create a {@link NatGateway}, Oracle automatically assigns the NAT gateway a regional ephemeral public IP that you cannot remove. <br/> - For a reserved public IP: You may also optionally assign the public IP to a private
IP by specifying
privateIpId
. Or you can later assign the public IP with {@link #updatePublicIp(UpdatePublicIpRequest) updatePublicIp}. <br/> Note: When assigning a public IP to a private IP, the private IP must not already have a public IP withlifecycleState
= ASSIGNING or ASSIGNED. If it does, an error is returned. <br/> Also, for reserved public IPs, the optional assignment part of this operation is asynchronous. Poll the public IP'slifecycleState
to determine if the assignment succeeded.
Declaration
public Task<CreatePublicIpResponse> CreatePublicIp(CreatePublicIpRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreatePublicIpRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreatePublicIpResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreatePublicIp API.
CreatePublicIpPool(CreatePublicIpPoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a public IP pool.
Declaration
public Task<CreatePublicIpPoolResponse> CreatePublicIpPool(CreatePublicIpPoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreatePublicIpPoolRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreatePublicIpPoolResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreatePublicIpPool API.
CreateRemotePeeringConnection(CreateRemotePeeringConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new remote peering connection (RPC) for the specified DRG.
Declaration
public Task<CreateRemotePeeringConnectionResponse> CreateRemotePeeringConnection(CreateRemotePeeringConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateRemotePeeringConnectionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateRemotePeeringConnectionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateRemotePeeringConnection API.
CreateRouteTable(CreateRouteTableRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new route table for the specified VCN. In the request you must also include at least one route rule for the new route table. For information on the number of rules you can have in a route table, see Service Limits. For general information about route tables in your VCN and the types of targets you can use in route rules, see Route Tables. <br/> For the purposes of access control, you must provide the OCID of the compartment where you want the route table to reside. Notice that the route table doesn't have to be in the same compartment as the VCN, subnets, or other Networking Service components. If you're not sure which compartment to use, put the route table in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers. <br/> You may optionally specify a display name for the route table, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.
Declaration
public Task<CreateRouteTableResponse> CreateRouteTable(CreateRouteTableRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateRouteTableRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateRouteTableResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateRouteTable API.
CreateSecurityList(CreateSecurityListRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new security list for the specified VCN. For more information about security lists, see Security Lists. For information on the number of rules you can have in a security list, see Service Limits. <br/> For the purposes of access control, you must provide the OCID of the compartment where you want the security list to reside. Notice that the security list doesn't have to be in the same compartment as the VCN, subnets, or other Networking Service components. If you're not sure which compartment to use, put the security list in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers. <br/> You may optionally specify a display name for the security list, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.
Declaration
public Task<CreateSecurityListResponse> CreateSecurityList(CreateSecurityListRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateSecurityListRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateSecurityListResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateSecurityList API.
CreateServiceGateway(CreateServiceGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new service gateway in the specified compartment. <br/> For the purposes of access control, you must provide the OCID of the compartment where you want the service gateway to reside. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers. <br/> You may optionally specify a display name for the service gateway, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. <br/> Use the {@link #listServices(ListServicesRequest) listServices} operation to find service CIDR labels available in the region.
Declaration
public Task<CreateServiceGatewayResponse> CreateServiceGateway(CreateServiceGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateServiceGatewayRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateServiceGatewayResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateServiceGateway API.
CreateSubnet(CreateSubnetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new subnet in the specified VCN. You can't change the size of the subnet after creation, so it's important to think about the size of subnets you need before creating them. For more information, see VCNs and Subnets. For information on the number of subnets you can have in a VCN, see Service Limits. <br/> For the purposes of access control, you must provide the OCID of the compartment where you want the subnet to reside. Notice that the subnet doesn't have to be in the same compartment as the VCN, route tables, or other Networking Service components. If you're not sure which compartment to use, put the subnet in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers. <br/> You may optionally associate a route table with the subnet. If you don't, the subnet will use the VCN's default route table. For more information about route tables, see Route Tables. <br/> You may optionally associate a security list with the subnet. If you don't, the subnet will use the VCN's default security list. For more information about security lists, see Security Lists. <br/> You may optionally associate a set of DHCP options with the subnet. If you don't, the subnet will use the VCN's default set. For more information about DHCP options, see DHCP Options. <br/> You may optionally specify a display name for the subnet, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. <br/> You can also add a DNS label for the subnet, which is required if you want the Internet and VCN Resolver to resolve hostnames for instances in the subnet. For more information, see DNS in Your Virtual Cloud Network.
Declaration
public Task<CreateSubnetResponse> CreateSubnet(CreateSubnetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateSubnetRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateSubnetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateSubnet API.
CreateVcn(CreateVcnRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new virtual cloud network (VCN). For more information, see VCNs and Subnets. <br/> For the VCN, you specify a list of one or more IPv4 CIDR blocks that meet the following criteria: <br/>
- The CIDR blocks must be valid.
- They must not overlap with each other or with the on-premises network CIDR block.
- The number of CIDR blocks does not exceed the limit of CIDR blocks allowed per VCN. <br/> For a CIDR block, Oracle recommends that you use one of the private IP address ranges specified in RFC 1918 (10.0.0.0/8, 172.16/12, and 192.168/16). Example: 172.16.0.0/16. The CIDR blocks can range from /16 to /30. <br/> For the purposes of access control, you must provide the OCID of the compartment where you want the VCN to reside. Consult an Oracle Cloud Infrastructure administrator in your organization if you're not sure which compartment to use. Notice that the VCN doesn't have to be in the same compartment as the subnets or other Networking Service components. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers. <br/> You may optionally specify a display name for the VCN, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. <br/> You can also add a DNS label for the VCN, which is required if you want the instances to use the Interent and VCN Resolver option for DNS in the VCN. For more information, see DNS in Your Virtual Cloud Network. <br/> The VCN automatically comes with a default route table, default security list, and default set of DHCP options. The OCID for each is returned in the response. You can't delete these default objects, but you can change their contents (that is, change the route rules, security list rules, and so on). <br/> The VCN and subnets you create are not accessible until you attach an internet gateway or set up a Site-to-Site VPN or FastConnect. For more information, see Overview of the Networking Service.
Declaration
public Task<CreateVcnResponse> CreateVcn(CreateVcnRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateVcnRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateVcnResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateVcn API.
CreateVirtualCircuit(CreateVirtualCircuitRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new virtual circuit to use with Oracle Cloud Infrastructure FastConnect. For more information, see FastConnect Overview. <br/> For the purposes of access control, you must provide the OCID of the compartment where you want the virtual circuit to reside. If you're not sure which compartment to use, put the virtual circuit in the same compartment with the DRG it's using. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers. <br/> You may optionally specify a display name for the virtual circuit. It does not have to be unique, and you can change it. Avoid entering confidential information. <br/> Important: When creating a virtual circuit, you specify a DRG for the traffic to flow through. Make sure you attach the DRG to your VCN and confirm the VCN's routing sends traffic to the DRG. Otherwise traffic will not flow. For more information, see Route Tables.
Declaration
public Task<CreateVirtualCircuitResponse> CreateVirtualCircuit(CreateVirtualCircuitRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateVirtualCircuitRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateVirtualCircuitResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateVirtualCircuit API.
CreateVlan(CreateVlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a VLAN in the specified VCN and the specified compartment.
Declaration
public Task<CreateVlanResponse> CreateVlan(CreateVlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateVlanRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateVlanResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateVlan API.
CreateVtap(CreateVtapRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a virtual test access point (VTAP) in the specified compartment. <br/> For the purposes of access control, you must provide the OCID of the compartment that contains the VTAP. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers. <br/> You may optionally specify a display name for the VTAP, otherwise a default is provided. It does not have to be unique, and you can change it.
Declaration
public Task<CreateVtapResponse> CreateVtap(CreateVtapRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateVtapRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateVtapResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateVtap API.
DeleteByoipRange(DeleteByoipRangeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified ByoipRange
resource.
The resource must be in one of the following states: CREATING, PROVISIONED, ACTIVE, or FAILED.
It must not have any subranges currently allocated to a PublicIpPool object or the deletion will fail.
You must specify the OCID.
If the ByoipRange
resource is currently in the PROVISIONED or ACTIVE state, it will be de-provisioned and then deleted.
Declaration
public Task<DeleteByoipRangeResponse> DeleteByoipRange(DeleteByoipRangeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteByoipRangeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteByoipRangeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteByoipRange API.
DeleteCaptureFilter(DeleteCaptureFilterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified VTAP capture filter. This is an asynchronous operation. The VTAP capture filter's lifecycleState
will
change to TERMINATING temporarily until the VTAP capture filter is completely removed.
Declaration
public Task<DeleteCaptureFilterResponse> DeleteCaptureFilter(DeleteCaptureFilterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteCaptureFilterRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteCaptureFilterResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteCaptureFilter API.
DeleteCpe(DeleteCpeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified CPE object. The CPE must not be connected to a DRG. This is an asynchronous
operation. The CPE's lifecycleState
will change to TERMINATING temporarily until the CPE is completely
removed.
Declaration
public Task<DeleteCpeResponse> DeleteCpe(DeleteCpeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteCpeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteCpeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteCpe API.
DeleteCrossConnect(DeleteCrossConnectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified cross-connect. It must not be mapped to a {@link VirtualCircuit}.
Declaration
public Task<DeleteCrossConnectResponse> DeleteCrossConnect(DeleteCrossConnectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteCrossConnectRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteCrossConnectResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteCrossConnect API.
DeleteCrossConnectGroup(DeleteCrossConnectGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified cross-connect group. It must not contain any cross-connects, and it cannot be mapped to a {@link VirtualCircuit}.
Declaration
public Task<DeleteCrossConnectGroupResponse> DeleteCrossConnectGroup(DeleteCrossConnectGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteCrossConnectGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteCrossConnectGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteCrossConnectGroup API.
DeleteDhcpOptions(DeleteDhcpOptionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified set of DHCP options, but only if it's not associated with a subnet. You can't delete a VCN's default set of DHCP options. <br/> This is an asynchronous operation. The state of the set of options will switch to TERMINATING temporarily until the set is completely removed.
Declaration
public Task<DeleteDhcpOptionsResponse> DeleteDhcpOptions(DeleteDhcpOptionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDhcpOptionsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteDhcpOptionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDhcpOptions API.
DeleteDrg(DeleteDrgRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified DRG. The DRG must not be attached to a VCN or be connected to your on-premise
network. Also, there must not be a route table that lists the DRG as a target. This is an asynchronous
operation. The DRG's lifecycleState
will change to TERMINATING temporarily until the DRG is completely
removed.
Declaration
public Task<DeleteDrgResponse> DeleteDrg(DeleteDrgRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDrgRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteDrgResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDrg API.
DeleteDrgAttachment(DeleteDrgAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Detaches a DRG from a network resource by deleting the corresponding DrgAttachment
resource. This is an asynchronous
operation. The attachment's lifecycleState
will temporarily change to DETACHING until the attachment
is completely removed.
Declaration
public Task<DeleteDrgAttachmentResponse> DeleteDrgAttachment(DeleteDrgAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDrgAttachmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteDrgAttachmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDrgAttachment API.
DeleteDrgRouteDistribution(DeleteDrgRouteDistributionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified route distribution. You can't delete a route distribution currently in use by a DRG attachment or DRG route table. <br/> Remove the DRG route distribution from a DRG attachment or DRG route table by using the "RemoveExportDrgRouteDistribution" or "RemoveImportDrgRouteDistribution' operations.
Declaration
public Task<DeleteDrgRouteDistributionResponse> DeleteDrgRouteDistribution(DeleteDrgRouteDistributionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDrgRouteDistributionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteDrgRouteDistributionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDrgRouteDistribution API.
DeleteDrgRouteTable(DeleteDrgRouteTableRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified DRG route table. There must not be any DRG attachments assigned.
Declaration
public Task<DeleteDrgRouteTableResponse> DeleteDrgRouteTable(DeleteDrgRouteTableRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDrgRouteTableRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteDrgRouteTableResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDrgRouteTable API.
DeleteIPSecConnection(DeleteIPSecConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified IPSec connection. If your goal is to disable the Site-to-Site VPN between your VCN and
on-premises network, it's easiest to simply detach the DRG but keep all the Site-to-Site VPN components intact.
If you were to delete all the components and then later need to create an Site-to-Site VPN again, you would
need to configure your on-premises router again with the new information returned from
{@link #createIPSecConnection(CreateIPSecConnectionRequest) createIPSecConnection}.
<br/>
This is an asynchronous operation. The connection's lifecycleState
will change to TERMINATING temporarily
until the connection is completely removed.
Declaration
public Task<DeleteIPSecConnectionResponse> DeleteIPSecConnection(DeleteIPSecConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteIPSecConnectionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteIPSecConnectionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteIPSecConnection API.
DeleteInternetGateway(DeleteInternetGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified internet gateway. The internet gateway does not have to be disabled, but
there must not be a route table that lists it as a target.
<br/>
This is an asynchronous operation. The gateway's lifecycleState
will change to TERMINATING temporarily
until the gateway is completely removed.
Declaration
public Task<DeleteInternetGatewayResponse> DeleteInternetGateway(DeleteInternetGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteInternetGatewayRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteInternetGatewayResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteInternetGateway API.
DeleteIpv6(DeleteIpv6Request, RetryConfiguration, CancellationToken, HttpCompletionOption)
Unassigns and deletes the specified IPv6. You must specify the object's OCID. The IPv6 address is returned to the subnet's pool of available addresses.
Declaration
public Task<DeleteIpv6Response> DeleteIpv6(DeleteIpv6Request request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteIpv6Request | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteIpv6Response> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteIpv6 API.
DeleteLocalPeeringGateway(DeleteLocalPeeringGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified local peering gateway (LPG).
<br/>
This is an asynchronous operation; the local peering gateway's lifecycleState
changes to TERMINATING temporarily
until the local peering gateway is completely removed.
Declaration
public Task<DeleteLocalPeeringGatewayResponse> DeleteLocalPeeringGateway(DeleteLocalPeeringGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteLocalPeeringGatewayRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteLocalPeeringGatewayResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteLocalPeeringGateway API.
DeleteNatGateway(DeleteNatGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified NAT gateway. The NAT gateway does not have to be disabled, but there
must not be a route rule that lists the NAT gateway as a target.
<br/>
This is an asynchronous operation. The NAT gateway's lifecycleState
will change to
TERMINATING temporarily until the NAT gateway is completely removed.
Declaration
public Task<DeleteNatGatewayResponse> DeleteNatGateway(DeleteNatGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteNatGatewayRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteNatGatewayResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteNatGateway API.
DeleteNetworkSecurityGroup(DeleteNetworkSecurityGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified network security group. The group must not contain any VNICs. <br/> To get a list of the VNICs in a network security group, use {@link #listNetworkSecurityGroupVnics(ListNetworkSecurityGroupVnicsRequest) listNetworkSecurityGroupVnics}. Each returned {@link NetworkSecurityGroupVnic} object contains both the OCID of the VNIC and the OCID of the VNIC's parent resource (for example, the Compute instance that the VNIC is attached to).
Declaration
public Task<DeleteNetworkSecurityGroupResponse> DeleteNetworkSecurityGroup(DeleteNetworkSecurityGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteNetworkSecurityGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteNetworkSecurityGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteNetworkSecurityGroup API.
DeletePrivateIp(DeletePrivateIpRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Unassigns and deletes the specified private IP. You must specify the object's OCID. The private IP address is returned to the subnet's pool of available addresses. <br/> This operation cannot be used with primary private IPs, which are automatically unassigned and deleted when the VNIC is terminated. <br/> Important: If a secondary private IP is the target of a route rule, unassigning it from the VNIC causes that route rule to blackhole and the traffic will be dropped.
Declaration
public Task<DeletePrivateIpResponse> DeletePrivateIp(DeletePrivateIpRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeletePrivateIpRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeletePrivateIpResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeletePrivateIp API.
DeletePublicIp(DeletePublicIpRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Unassigns and deletes the specified public IP (either ephemeral or reserved).
You must specify the object's OCID. The public IP address is returned to the
Oracle Cloud Infrastructure public IP pool.
<br/>
Note: You cannot update, unassign, or delete the public IP that Oracle automatically
assigned to an entity for you (such as a load balancer or NAT gateway). The public IP is
automatically deleted if the assigned entity is terminated.
<br/>
For an assigned reserved public IP, the initial unassignment portion of this operation
is asynchronous. Poll the public IP's lifecycleState
to determine
if the operation succeeded.
<br/>
If you want to simply unassign a reserved public IP and return it to your pool
of reserved public IPs, instead use
{@link #updatePublicIp(UpdatePublicIpRequest) updatePublicIp}.
Declaration
public Task<DeletePublicIpResponse> DeletePublicIp(DeletePublicIpRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeletePublicIpRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeletePublicIpResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeletePublicIp API.
DeletePublicIpPool(DeletePublicIpPoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified public IP pool. To delete a public IP pool it must not have any active IP address allocations. You must specify the object's OCID when deleting an IP pool.
Declaration
public Task<DeletePublicIpPoolResponse> DeletePublicIpPool(DeletePublicIpPoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeletePublicIpPoolRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeletePublicIpPoolResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeletePublicIpPool API.
DeleteRemotePeeringConnection(DeleteRemotePeeringConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the remote peering connection (RPC).
<br/>
This is an asynchronous operation; the RPC's lifecycleState
changes to TERMINATING temporarily
until the RPC is completely removed.
Declaration
public Task<DeleteRemotePeeringConnectionResponse> DeleteRemotePeeringConnection(DeleteRemotePeeringConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteRemotePeeringConnectionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteRemotePeeringConnectionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteRemotePeeringConnection API.
DeleteRouteTable(DeleteRouteTableRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified route table, but only if it's not associated with a subnet. You can't delete a
VCN's default route table.
<br/>
This is an asynchronous operation. The route table's lifecycleState
will change to TERMINATING temporarily
until the route table is completely removed.
Declaration
public Task<DeleteRouteTableResponse> DeleteRouteTable(DeleteRouteTableRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteRouteTableRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteRouteTableResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteRouteTable API.
DeleteSecurityList(DeleteSecurityListRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified security list, but only if it's not associated with a subnet. You can't delete
a VCN's default security list.
<br/>
This is an asynchronous operation. The security list's lifecycleState
will change to TERMINATING temporarily
until the security list is completely removed.
Declaration
public Task<DeleteSecurityListResponse> DeleteSecurityList(DeleteSecurityListRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteSecurityListRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteSecurityListResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteSecurityList API.
DeleteServiceGateway(DeleteServiceGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified service gateway. There must not be a route table that lists the service gateway as a target.
Declaration
public Task<DeleteServiceGatewayResponse> DeleteServiceGateway(DeleteServiceGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteServiceGatewayRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteServiceGatewayResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteServiceGateway API.
DeleteSubnet(DeleteSubnetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified subnet, but only if there are no instances in the subnet. This is an asynchronous
operation. The subnet's lifecycleState
will change to TERMINATING temporarily. If there are any
instances in the subnet, the state will instead change back to AVAILABLE.
Declaration
public Task<DeleteSubnetResponse> DeleteSubnet(DeleteSubnetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteSubnetRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteSubnetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteSubnet API.
DeleteVcn(DeleteVcnRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified VCN. The VCN must be completely empty and have no attached gateways. This is an asynchronous
operation.
<br/>
A deleted VCN's lifecycleState
changes to TERMINATING and then TERMINATED temporarily until the VCN is completely
removed. A completely removed VCN does not appear in the results of a ListVcns
operation and can't be used in a
GetVcn
operation.
Declaration
public Task<DeleteVcnResponse> DeleteVcn(DeleteVcnRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteVcnRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteVcnResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteVcn API.
DeleteVirtualCircuit(DeleteVirtualCircuitRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified virtual circuit. <br/> Important: If you're using FastConnect via a provider, make sure to also terminate the connection with the provider, or else the provider may continue to bill you.
Declaration
public Task<DeleteVirtualCircuitResponse> DeleteVirtualCircuit(DeleteVirtualCircuitRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteVirtualCircuitRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteVirtualCircuitResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteVirtualCircuit API.
DeleteVlan(DeleteVlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified VLAN, but only if there are no VNICs in the VLAN.
Declaration
public Task<DeleteVlanResponse> DeleteVlan(DeleteVlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteVlanRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteVlanResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteVlan API.
DeleteVtap(DeleteVtapRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified VTAP. This is an asynchronous operation. The VTAP's lifecycleState
will change to
TERMINATING temporarily until the VTAP is completely removed.
Declaration
public Task<DeleteVtapResponse> DeleteVtap(DeleteVtapRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteVtapRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteVtapResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteVtap API.
DetachServiceId(DetachServiceIdRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes the specified {@link Service} from the list of enabled
Service
objects for the specified gateway. You do not need to remove any route
rules that specify this Service
object's cidrBlock
as the destination CIDR. However, consider
removing the rules if your intent is to permanently disable use of the Service
through this
service gateway.
<br/>
Note: The DetachServiceId
operation is an easy way to remove an individual Service
from
the service gateway. Compare it with
{@link #updateServiceGateway(UpdateServiceGatewayRequest) updateServiceGateway}, which replaces
the entire existing list of enabled Service
objects with the list that you provide in the
Update
call. UpdateServiceGateway
also lets you block all traffic through the service
gateway without having to remove each of the individual Service
objects.
Declaration
public Task<DetachServiceIdResponse> DetachServiceId(DetachServiceIdRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DetachServiceIdRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DetachServiceIdResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DetachServiceId API.
GetAllDrgAttachments(GetAllDrgAttachmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a complete list of DRG attachments that belong to a particular DRG.
Declaration
public Task<GetAllDrgAttachmentsResponse> GetAllDrgAttachments(GetAllDrgAttachmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetAllDrgAttachmentsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetAllDrgAttachmentsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetAllDrgAttachments API.
GetAllowedIkeIPSecParameters(GetAllowedIkeIPSecParametersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
The parameters allowed for IKE IPSec tunnels.
Declaration
public Task<GetAllowedIkeIPSecParametersResponse> GetAllowedIkeIPSecParameters(GetAllowedIkeIPSecParametersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetAllowedIkeIPSecParametersRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetAllowedIkeIPSecParametersResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetAllowedIkeIPSecParameters API.
GetByoipRange(GetByoipRangeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the ByoipRange
resource. You must specify the OCID.
Declaration
public Task<GetByoipRangeResponse> GetByoipRange(GetByoipRangeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetByoipRangeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetByoipRangeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetByoipRange API.
GetCaptureFilter(GetCaptureFilterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets information about the specified VTAP capture filter.
Declaration
public Task<GetCaptureFilterResponse> GetCaptureFilter(GetCaptureFilterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetCaptureFilterRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetCaptureFilterResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCaptureFilter API.
GetCpe(GetCpeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified CPE's information.
Declaration
public Task<GetCpeResponse> GetCpe(GetCpeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetCpeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetCpeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCpe API.
GetCpeDeviceConfigContent(GetCpeDeviceConfigContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Renders a set of CPE configuration content that can help a network engineer configure the actual
CPE device (for example, a hardware router) represented by the specified {@link Cpe}
object.
<br/>
The rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the
{@link Cpe} must have the CPE's device type specified by the cpeDeviceShapeId
attribute. The content optionally includes answers that the customer provides (see
{@link #updateTunnelCpeDeviceConfig(UpdateTunnelCpeDeviceConfigRequest) updateTunnelCpeDeviceConfig}),
merged with a template of other information specific to the CPE device type.
<br/>
The operation returns configuration information for all of the
{@link IPSecConnection} objects that use the specified CPE.
Here are similar operations:
<br/>
- {@link #getIpsecCpeDeviceConfigContent(GetIpsecCpeDeviceConfigContentRequest) getIpsecCpeDeviceConfigContent} returns CPE configuration content for all IPSec tunnels in a single IPSec connection.
- {@link #getTunnelCpeDeviceConfigContent(GetTunnelCpeDeviceConfigContentRequest) getTunnelCpeDeviceConfigContent} returns CPE configuration content for a specific IPSec tunnel in an IPSec connection.
Declaration
public Task<GetCpeDeviceConfigContentResponse> GetCpeDeviceConfigContent(GetCpeDeviceConfigContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetCpeDeviceConfigContentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetCpeDeviceConfigContentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCpeDeviceConfigContent API.
GetCpeDeviceShape(GetCpeDeviceShapeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the detailed information about the specified CPE device type. This might include a set of questions that are specific to the particular CPE device type. The customer must supply answers to those questions (see {@link #updateTunnelCpeDeviceConfig(UpdateTunnelCpeDeviceConfigRequest) updateTunnelCpeDeviceConfig}). The service merges the answers with a template of other information for the CPE device type. The following operations return the merged content: <br/>
- {@link #getCpeDeviceConfigContent(GetCpeDeviceConfigContentRequest) getCpeDeviceConfigContent}
- {@link #getIpsecCpeDeviceConfigContent(GetIpsecCpeDeviceConfigContentRequest) getIpsecCpeDeviceConfigContent}
- {@link #getTunnelCpeDeviceConfigContent(GetTunnelCpeDeviceConfigContentRequest) getTunnelCpeDeviceConfigContent}
Declaration
public Task<GetCpeDeviceShapeResponse> GetCpeDeviceShape(GetCpeDeviceShapeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetCpeDeviceShapeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetCpeDeviceShapeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCpeDeviceShape API.
GetCrossConnect(GetCrossConnectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified cross-connect's information.
Declaration
public Task<GetCrossConnectResponse> GetCrossConnect(GetCrossConnectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetCrossConnectRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetCrossConnectResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCrossConnect API.
GetCrossConnectGroup(GetCrossConnectGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified cross-connect group's information.
Declaration
public Task<GetCrossConnectGroupResponse> GetCrossConnectGroup(GetCrossConnectGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetCrossConnectGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetCrossConnectGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCrossConnectGroup API.
GetCrossConnectLetterOfAuthority(GetCrossConnectLetterOfAuthorityRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the Letter of Authority for the specified cross-connect.
Declaration
public Task<GetCrossConnectLetterOfAuthorityResponse> GetCrossConnectLetterOfAuthority(GetCrossConnectLetterOfAuthorityRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetCrossConnectLetterOfAuthorityRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetCrossConnectLetterOfAuthorityResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCrossConnectLetterOfAuthority API.
GetCrossConnectStatus(GetCrossConnectStatusRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the status of the specified cross-connect.
Declaration
public Task<GetCrossConnectStatusResponse> GetCrossConnectStatus(GetCrossConnectStatusRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetCrossConnectStatusRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetCrossConnectStatusResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCrossConnectStatus API.
GetDhcpOptions(GetDhcpOptionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified set of DHCP options.
Declaration
public Task<GetDhcpOptionsResponse> GetDhcpOptions(GetDhcpOptionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDhcpOptionsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetDhcpOptionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDhcpOptions API.
GetDrg(GetDrgRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified DRG's information.
Declaration
public Task<GetDrgResponse> GetDrg(GetDrgRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDrgRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetDrgResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDrg API.
GetDrgAttachment(GetDrgAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the DrgAttachment
resource.
Declaration
public Task<GetDrgAttachmentResponse> GetDrgAttachment(GetDrgAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDrgAttachmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetDrgAttachmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDrgAttachment API.
GetDrgRedundancyStatus(GetDrgRedundancyStatusRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the redundancy status for the specified DRG. For more information, see Redundancy Remedies.
Declaration
public Task<GetDrgRedundancyStatusResponse> GetDrgRedundancyStatus(GetDrgRedundancyStatusRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDrgRedundancyStatusRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetDrgRedundancyStatusResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDrgRedundancyStatus API.
GetDrgRouteDistribution(GetDrgRouteDistributionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified route distribution's information.
Declaration
public Task<GetDrgRouteDistributionResponse> GetDrgRouteDistribution(GetDrgRouteDistributionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDrgRouteDistributionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetDrgRouteDistributionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDrgRouteDistribution API.
GetDrgRouteTable(GetDrgRouteTableRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified DRG route table's information.
Declaration
public Task<GetDrgRouteTableResponse> GetDrgRouteTable(GetDrgRouteTableRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDrgRouteTableRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetDrgRouteTableResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDrgRouteTable API.
GetFastConnectProviderService(GetFastConnectProviderServiceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified provider service. For more information, see FastConnect Overview.
Declaration
public Task<GetFastConnectProviderServiceResponse> GetFastConnectProviderService(GetFastConnectProviderServiceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetFastConnectProviderServiceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetFastConnectProviderServiceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetFastConnectProviderService API.
GetFastConnectProviderServiceKey(GetFastConnectProviderServiceKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified provider service key's information. Use this operation to validate a provider service key. An invalid key returns a 404 error.
Declaration
public Task<GetFastConnectProviderServiceKeyResponse> GetFastConnectProviderServiceKey(GetFastConnectProviderServiceKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetFastConnectProviderServiceKeyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetFastConnectProviderServiceKeyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetFastConnectProviderServiceKey API.
GetIPSecConnection(GetIPSecConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified IPSec connection's basic information, including the static routes for the on-premises router. If you want the status of the connection (whether it's up or down), use {@link #getIPSecConnectionTunnel(GetIPSecConnectionTunnelRequest) getIPSecConnectionTunnel}.
Declaration
public Task<GetIPSecConnectionResponse> GetIPSecConnection(GetIPSecConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetIPSecConnectionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetIPSecConnectionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetIPSecConnection API.
GetIPSecConnectionDeviceConfig(GetIPSecConnectionDeviceConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deprecated. To get tunnel information, instead use: <br/>
- {@link #getIPSecConnectionTunnel(GetIPSecConnectionTunnelRequest) getIPSecConnectionTunnel}
- {@link #getIPSecConnectionTunnelSharedSecret(GetIPSecConnectionTunnelSharedSecretRequest) getIPSecConnectionTunnelSharedSecret}
Declaration
public Task<GetIPSecConnectionDeviceConfigResponse> GetIPSecConnectionDeviceConfig(GetIPSecConnectionDeviceConfigRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetIPSecConnectionDeviceConfigRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetIPSecConnectionDeviceConfigResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetIPSecConnectionDeviceConfig API.
GetIPSecConnectionDeviceStatus(GetIPSecConnectionDeviceStatusRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deprecated. To get the tunnel status, instead use {@link #getIPSecConnectionTunnel(GetIPSecConnectionTunnelRequest) getIPSecConnectionTunnel}.
Declaration
public Task<GetIPSecConnectionDeviceStatusResponse> GetIPSecConnectionDeviceStatus(GetIPSecConnectionDeviceStatusRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetIPSecConnectionDeviceStatusRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetIPSecConnectionDeviceStatusResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetIPSecConnectionDeviceStatus API.
GetIPSecConnectionTunnel(GetIPSecConnectionTunnelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified tunnel's information. The resulting object does not include the tunnel's shared secret (pre-shared key). To retrieve that, use {@link #getIPSecConnectionTunnelSharedSecret(GetIPSecConnectionTunnelSharedSecretRequest) getIPSecConnectionTunnelSharedSecret}.
Declaration
public Task<GetIPSecConnectionTunnelResponse> GetIPSecConnectionTunnel(GetIPSecConnectionTunnelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetIPSecConnectionTunnelRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetIPSecConnectionTunnelResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetIPSecConnectionTunnel API.
GetIPSecConnectionTunnelError(GetIPSecConnectionTunnelErrorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the identified error for the specified IPSec tunnel ID.
Declaration
public Task<GetIPSecConnectionTunnelErrorResponse> GetIPSecConnectionTunnelError(GetIPSecConnectionTunnelErrorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetIPSecConnectionTunnelErrorRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetIPSecConnectionTunnelErrorResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetIPSecConnectionTunnelError API.
GetIPSecConnectionTunnelSharedSecret(GetIPSecConnectionTunnelSharedSecretRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified tunnel's shared secret (pre-shared key). To get other information about the tunnel, use {@link #getIPSecConnectionTunnel(GetIPSecConnectionTunnelRequest) getIPSecConnectionTunnel}.
Declaration
public Task<GetIPSecConnectionTunnelSharedSecretResponse> GetIPSecConnectionTunnelSharedSecret(GetIPSecConnectionTunnelSharedSecretRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetIPSecConnectionTunnelSharedSecretRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetIPSecConnectionTunnelSharedSecretResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetIPSecConnectionTunnelSharedSecret API.
GetInternetGateway(GetInternetGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified internet gateway's information.
Declaration
public Task<GetInternetGatewayResponse> GetInternetGateway(GetInternetGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetInternetGatewayRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetInternetGatewayResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetInternetGateway API.
GetIpsecCpeDeviceConfigContent(GetIpsecCpeDeviceConfigContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Renders a set of CPE configuration content for the specified IPSec connection (for all the
tunnels in the connection). The content helps a network engineer configure the actual CPE
device (for example, a hardware router) that the specified IPSec connection terminates on.
<br/>
The rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the
{@link Cpe} used by the specified {@link IPSecConnection}
must have the CPE's device type specified by the cpeDeviceShapeId
attribute. The content
optionally includes answers that the customer provides (see
{@link #updateTunnelCpeDeviceConfig(UpdateTunnelCpeDeviceConfigRequest) updateTunnelCpeDeviceConfig}),
merged with a template of other information specific to the CPE device type.
<br/>
The operation returns configuration information for all tunnels in the single specified
{@link IPSecConnection} object. Here are other similar
operations:
<br/>
- {@link #getTunnelCpeDeviceConfigContent(GetTunnelCpeDeviceConfigContentRequest) getTunnelCpeDeviceConfigContent} returns CPE configuration content for a specific tunnel within an IPSec connection.
- {@link #getCpeDeviceConfigContent(GetCpeDeviceConfigContentRequest) getCpeDeviceConfigContent} returns CPE configuration content for all IPSec connections that use a specific CPE.
Declaration
public Task<GetIpsecCpeDeviceConfigContentResponse> GetIpsecCpeDeviceConfigContent(GetIpsecCpeDeviceConfigContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetIpsecCpeDeviceConfigContentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetIpsecCpeDeviceConfigContentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetIpsecCpeDeviceConfigContent API.
GetIpv6(GetIpv6Request, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified IPv6. You must specify the object's OCID. Alternatively, you can get the object by using {@link #listIpv6s(ListIpv6sRequest) listIpv6s} with the IPv6 address (for example, 2001:0db8:0123:1111:98fe:dcba:9876:4321) and subnet OCID.
Declaration
public Task<GetIpv6Response> GetIpv6(GetIpv6Request request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetIpv6Request | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetIpv6Response> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetIpv6 API.
GetLocalPeeringGateway(GetLocalPeeringGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified local peering gateway's information.
Declaration
public Task<GetLocalPeeringGatewayResponse> GetLocalPeeringGateway(GetLocalPeeringGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetLocalPeeringGatewayRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetLocalPeeringGatewayResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetLocalPeeringGateway API.
GetNatGateway(GetNatGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified NAT gateway's information.
Declaration
public Task<GetNatGatewayResponse> GetNatGateway(GetNatGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetNatGatewayRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetNatGatewayResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetNatGateway API.
GetNetworkSecurityGroup(GetNetworkSecurityGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified network security group's information. <br/> To list the VNICs in an NSG, see {@link #listNetworkSecurityGroupVnics(ListNetworkSecurityGroupVnicsRequest) listNetworkSecurityGroupVnics}. <br/> To list the security rules in an NSG, see {@link #listNetworkSecurityGroupSecurityRules(ListNetworkSecurityGroupSecurityRulesRequest) listNetworkSecurityGroupSecurityRules}.
Declaration
public Task<GetNetworkSecurityGroupResponse> GetNetworkSecurityGroup(GetNetworkSecurityGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetNetworkSecurityGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetNetworkSecurityGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetNetworkSecurityGroup API.
GetNetworkingTopology(GetNetworkingTopologyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a virtual networking topology for the current region.
Declaration
public Task<GetNetworkingTopologyResponse> GetNetworkingTopology(GetNetworkingTopologyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetNetworkingTopologyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetNetworkingTopologyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetNetworkingTopology API.
GetPrivateIp(GetPrivateIpRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified private IP. You must specify the object's OCID. Alternatively, you can get the object by using {@link #listPrivateIps(ListPrivateIpsRequest) listPrivateIps} with the private IP address (for example, 10.0.3.3) and subnet OCID.
Declaration
public Task<GetPrivateIpResponse> GetPrivateIp(GetPrivateIpRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetPrivateIpRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetPrivateIpResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetPrivateIp API.
GetPublicIp(GetPublicIpRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified public IP. You must specify the object's OCID.
<br/>
Alternatively, you can get the object by using {@link #getPublicIpByIpAddress(GetPublicIpByIpAddressRequest) getPublicIpByIpAddress}
with the public IP address (for example, 203.0.113.2).
<br/>
Or you can use {@link #getPublicIpByPrivateIpId(GetPublicIpByPrivateIpIdRequest) getPublicIpByPrivateIpId}
with the OCID of the private IP that the public IP is assigned to.
<br/>
Note: If you're fetching a reserved public IP that is in the process of being
moved to a different private IP, the service returns the public IP object with
lifecycleState
= ASSIGNING and assignedEntityId
= OCID of the target private IP.
Declaration
public Task<GetPublicIpResponse> GetPublicIp(GetPublicIpRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetPublicIpRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetPublicIpResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetPublicIp API.
GetPublicIpByIpAddress(GetPublicIpByIpAddressRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the public IP based on the public IP address (for example, 203.0.113.2).
<br/>
Note: If you're fetching a reserved public IP that is in the process of being
moved to a different private IP, the service returns the public IP object with
lifecycleState
= ASSIGNING and assignedEntityId
= OCID of the target private IP.
Declaration
public Task<GetPublicIpByIpAddressResponse> GetPublicIpByIpAddress(GetPublicIpByIpAddressRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetPublicIpByIpAddressRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetPublicIpByIpAddressResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetPublicIpByIpAddress API.
GetPublicIpByPrivateIpId(GetPublicIpByPrivateIpIdRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the public IP assigned to the specified private IP. You must specify the OCID
of the private IP. If no public IP is assigned, a 404 is returned.
<br/>
Note: If you're fetching a reserved public IP that is in the process of being
moved to a different private IP, and you provide the OCID of the original private
IP, this operation returns a 404. If you instead provide the OCID of the target
private IP, or if you instead call
{@link #getPublicIp(GetPublicIpRequest) getPublicIp} or
{@link #getPublicIpByIpAddress(GetPublicIpByIpAddressRequest) getPublicIpByIpAddress}, the
service returns the public IP object with lifecycleState
= ASSIGNING and
assignedEntityId
= OCID of the target private IP.
Declaration
public Task<GetPublicIpByPrivateIpIdResponse> GetPublicIpByPrivateIpId(GetPublicIpByPrivateIpIdRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetPublicIpByPrivateIpIdRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetPublicIpByPrivateIpIdResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetPublicIpByPrivateIpId API.
GetPublicIpPool(GetPublicIpPoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified PublicIpPool
object. You must specify the object's OCID.
Declaration
public Task<GetPublicIpPoolResponse> GetPublicIpPool(GetPublicIpPoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetPublicIpPoolRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetPublicIpPoolResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetPublicIpPool API.
GetRemotePeeringConnection(GetRemotePeeringConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get the specified remote peering connection's information.
Declaration
public Task<GetRemotePeeringConnectionResponse> GetRemotePeeringConnection(GetRemotePeeringConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetRemotePeeringConnectionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetRemotePeeringConnectionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetRemotePeeringConnection API.
GetResourceIpInventory(GetResourceIpInventoryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the IpInventory
resource.
Declaration
public Task<GetResourceIpInventoryResponse> GetResourceIpInventory(GetResourceIpInventoryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetResourceIpInventoryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetResourceIpInventoryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetResourceIpInventory API.
GetRouteTable(GetRouteTableRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified route table's information.
Declaration
public Task<GetRouteTableResponse> GetRouteTable(GetRouteTableRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetRouteTableRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetRouteTableResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetRouteTable API.
GetSecurityList(GetSecurityListRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified security list's information.
Declaration
public Task<GetSecurityListResponse> GetSecurityList(GetSecurityListRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSecurityListRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetSecurityListResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSecurityList API.
GetService(GetServiceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified {@link Service} object.
Declaration
public Task<GetServiceResponse> GetService(GetServiceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetServiceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetServiceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetService API.
GetServiceGateway(GetServiceGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified service gateway's information.
Declaration
public Task<GetServiceGatewayResponse> GetServiceGateway(GetServiceGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetServiceGatewayRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetServiceGatewayResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetServiceGateway API.
GetSubnet(GetSubnetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified subnet's information.
Declaration
public Task<GetSubnetResponse> GetSubnet(GetSubnetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSubnetRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetSubnetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSubnet API.
GetSubnetCidrUtilization(GetSubnetCidrUtilizationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the CIDR utilization data of the specified subnet. Specify the OCID.
Declaration
public Task<GetSubnetCidrUtilizationResponse> GetSubnetCidrUtilization(GetSubnetCidrUtilizationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSubnetCidrUtilizationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetSubnetCidrUtilizationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSubnetCidrUtilization API.
GetSubnetIpInventory(GetSubnetIpInventoryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the IP Inventory data of the specified subnet. Specify the OCID.
Declaration
public Task<GetSubnetIpInventoryResponse> GetSubnetIpInventory(GetSubnetIpInventoryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSubnetIpInventoryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetSubnetIpInventoryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSubnetIpInventory API.
GetSubnetTopology(GetSubnetTopologyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a topology for a given subnet.
Declaration
public Task<GetSubnetTopologyResponse> GetSubnetTopology(GetSubnetTopologyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSubnetTopologyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetSubnetTopologyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSubnetTopology API.
GetTunnelCpeDeviceConfig(GetTunnelCpeDeviceConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the set of CPE configuration answers for the tunnel, which the customer provided in {@link #updateTunnelCpeDeviceConfig(UpdateTunnelCpeDeviceConfigRequest) updateTunnelCpeDeviceConfig}. To get the full set of content for the tunnel (any answers merged with the template of other information specific to the CPE device type), use {@link #getTunnelCpeDeviceConfigContent(GetTunnelCpeDeviceConfigContentRequest) getTunnelCpeDeviceConfigContent}.
Declaration
public Task<GetTunnelCpeDeviceConfigResponse> GetTunnelCpeDeviceConfig(GetTunnelCpeDeviceConfigRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTunnelCpeDeviceConfigRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetTunnelCpeDeviceConfigResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTunnelCpeDeviceConfig API.
GetTunnelCpeDeviceConfigContent(GetTunnelCpeDeviceConfigContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Renders a set of CPE configuration content for the specified IPSec tunnel. The content helps a
network engineer configure the actual CPE device (for example, a hardware router) that the specified
IPSec tunnel terminates on.
<br/>
The rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the
{@link Cpe} used by the specified {@link IPSecConnection}
must have the CPE's device type specified by the cpeDeviceShapeId
attribute. The content
optionally includes answers that the customer provides (see
{@link #updateTunnelCpeDeviceConfig(UpdateTunnelCpeDeviceConfigRequest) updateTunnelCpeDeviceConfig}),
merged with a template of other information specific to the CPE device type.
<br/>
The operation returns configuration information for only the specified IPSec tunnel.
Here are other similar operations:
<br/>
- {@link #getIpsecCpeDeviceConfigContent(GetIpsecCpeDeviceConfigContentRequest) getIpsecCpeDeviceConfigContent} returns CPE configuration content for all tunnels in a single IPSec connection.
- {@link #getCpeDeviceConfigContent(GetCpeDeviceConfigContentRequest) getCpeDeviceConfigContent} returns CPE configuration content for all IPSec connections that use a specific CPE.
Declaration
public Task<GetTunnelCpeDeviceConfigContentResponse> GetTunnelCpeDeviceConfigContent(GetTunnelCpeDeviceConfigContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTunnelCpeDeviceConfigContentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetTunnelCpeDeviceConfigContentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTunnelCpeDeviceConfigContent API.
GetUpgradeStatus(GetUpgradeStatusRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the DRG upgrade status. The status can be not updated, in progress, or updated. Also indicates how much of the upgrade is completed.
Declaration
public Task<GetUpgradeStatusResponse> GetUpgradeStatus(GetUpgradeStatusRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetUpgradeStatusRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetUpgradeStatusResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetUpgradeStatus API.
GetVcn(GetVcnRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified VCN's information.
Declaration
public Task<GetVcnResponse> GetVcn(GetVcnRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetVcnRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetVcnResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetVcn API.
GetVcnDnsResolverAssociation(GetVcnDnsResolverAssociationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get the associated DNS resolver information with a vcn
Declaration
public Task<GetVcnDnsResolverAssociationResponse> GetVcnDnsResolverAssociation(GetVcnDnsResolverAssociationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetVcnDnsResolverAssociationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetVcnDnsResolverAssociationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetVcnDnsResolverAssociation API.
GetVcnOverlap(GetVcnOverlapRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the CIDR overlap information of the specified VCN in selected compartments. Specify the OCID.
Declaration
public Task<GetVcnOverlapResponse> GetVcnOverlap(GetVcnOverlapRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetVcnOverlapRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetVcnOverlapResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetVcnOverlap API.
GetVcnTopology(GetVcnTopologyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a virtual network topology for a given VCN.
Declaration
public Task<GetVcnTopologyResponse> GetVcnTopology(GetVcnTopologyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetVcnTopologyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetVcnTopologyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetVcnTopology API.
GetVirtualCircuit(GetVirtualCircuitRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified virtual circuit's information.
Declaration
public Task<GetVirtualCircuitResponse> GetVirtualCircuit(GetVirtualCircuitRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetVirtualCircuitRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetVirtualCircuitResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetVirtualCircuit API.
GetVlan(GetVlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified VLAN's information.
Declaration
public Task<GetVlanResponse> GetVlan(GetVlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetVlanRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetVlanResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetVlan API.
GetVnic(GetVnicRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the information for the specified virtual network interface card (VNIC). You can get the VNIC OCID from the {@link #listVnicAttachments(ListVnicAttachmentsRequest) listVnicAttachments} operation.
Declaration
public Task<GetVnicResponse> GetVnic(GetVnicRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetVnicRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetVnicResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetVnic API.
GetVtap(GetVtapRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified Vtap
resource.
Declaration
public Task<GetVtapResponse> GetVtap(GetVtapRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetVtapRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetVtapResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetVtap API.
ListAllowedPeerRegionsForRemotePeering(ListAllowedPeerRegionsForRemotePeeringRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the regions that support remote VCN peering (which is peering across regions). For more information, see VCN Peering.
Declaration
public Task<ListAllowedPeerRegionsForRemotePeeringResponse> ListAllowedPeerRegionsForRemotePeering(ListAllowedPeerRegionsForRemotePeeringRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAllowedPeerRegionsForRemotePeeringRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAllowedPeerRegionsForRemotePeeringResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAllowedPeerRegionsForRemotePeering API.
ListByoipAllocatedRanges(ListByoipAllocatedRangesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the subranges of a BYOIP CIDR block currently allocated to an IP pool.
Each ByoipAllocatedRange
object also lists the IP pool where it is allocated.
Declaration
public Task<ListByoipAllocatedRangesResponse> ListByoipAllocatedRanges(ListByoipAllocatedRangesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListByoipAllocatedRangesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListByoipAllocatedRangesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListByoipAllocatedRanges API.
ListByoipRanges(ListByoipRangesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the ByoipRange
resources in the specified compartment.
You can filter the list using query parameters.
Declaration
public Task<ListByoipRangesResponse> ListByoipRanges(ListByoipRangesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListByoipRangesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListByoipRangesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListByoipRanges API.
ListCaptureFilters(ListCaptureFiltersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the capture filters in the specified compartment.
Declaration
public Task<ListCaptureFiltersResponse> ListCaptureFilters(ListCaptureFiltersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCaptureFiltersRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListCaptureFiltersResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCaptureFilters API.
ListCpeDeviceShapes(ListCpeDeviceShapesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the CPE device types that the Networking service provides CPE configuration
content for (example: Cisco ASA). The content helps a network engineer configure
the actual CPE device represented by a {@link Cpe} object.
<br/>
If you want to generate CPE configuration content for one of the returned CPE device types,
ensure that the {@link Cpe} object's cpeDeviceShapeId
attribute is set
to the CPE device type's OCID (returned by this operation).
<br/>
For information about generating CPE configuration content, see these operations:
<br/>
- {@link #getCpeDeviceConfigContent(GetCpeDeviceConfigContentRequest) getCpeDeviceConfigContent}
- {@link #getIpsecCpeDeviceConfigContent(GetIpsecCpeDeviceConfigContentRequest) getIpsecCpeDeviceConfigContent}
- {@link #getTunnelCpeDeviceConfigContent(GetTunnelCpeDeviceConfigContentRequest) getTunnelCpeDeviceConfigContent}
Declaration
public Task<ListCpeDeviceShapesResponse> ListCpeDeviceShapes(ListCpeDeviceShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCpeDeviceShapesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListCpeDeviceShapesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCpeDeviceShapes API.
ListCpes(ListCpesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the customer-premises equipment objects (CPEs) in the specified compartment.
Declaration
public Task<ListCpesResponse> ListCpes(ListCpesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCpesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListCpesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCpes API.
ListCrossConnectGroups(ListCrossConnectGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the cross-connect groups in the specified compartment.
Declaration
public Task<ListCrossConnectGroupsResponse> ListCrossConnectGroups(ListCrossConnectGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCrossConnectGroupsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListCrossConnectGroupsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCrossConnectGroups API.
ListCrossConnectLocations(ListCrossConnectLocationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the available FastConnect locations for cross-connect installation. You need this information so you can specify your desired location when you create a cross-connect.
Declaration
public Task<ListCrossConnectLocationsResponse> ListCrossConnectLocations(ListCrossConnectLocationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCrossConnectLocationsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListCrossConnectLocationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCrossConnectLocations API.
ListCrossConnectMappings(ListCrossConnectMappingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the Cross Connect mapping Details for the specified virtual circuit.
Declaration
public Task<ListCrossConnectMappingsResponse> ListCrossConnectMappings(ListCrossConnectMappingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCrossConnectMappingsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListCrossConnectMappingsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCrossConnectMappings API.
ListCrossConnects(ListCrossConnectsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the cross-connects in the specified compartment. You can filter the list by specifying the OCID of a cross-connect group.
Declaration
public Task<ListCrossConnectsResponse> ListCrossConnects(ListCrossConnectsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCrossConnectsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListCrossConnectsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCrossConnects API.
ListCrossconnectPortSpeedShapes(ListCrossconnectPortSpeedShapesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the available port speeds for cross-connects. You need this information so you can specify your desired port speed (that is, shape) when you create a cross-connect.
Declaration
public Task<ListCrossconnectPortSpeedShapesResponse> ListCrossconnectPortSpeedShapes(ListCrossconnectPortSpeedShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCrossconnectPortSpeedShapesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListCrossconnectPortSpeedShapesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCrossconnectPortSpeedShapes API.
ListDhcpOptions(ListDhcpOptionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the sets of DHCP options in the specified VCN and specified compartment. If the VCN ID is not provided, then the list includes the sets of DHCP options from all VCNs in the specified compartment. The response includes the default set of options that automatically comes with each VCN, plus any other sets you've created.
Declaration
public Task<ListDhcpOptionsResponse> ListDhcpOptions(ListDhcpOptionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDhcpOptionsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListDhcpOptionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDhcpOptions API.
ListDrgAttachments(ListDrgAttachmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the DrgAttachment
resource for the specified compartment. You can filter the
results by DRG, attached network, attachment type, DRG route table or
VCN route table.
<br/>
The LIST API lists DRG attachments by attachment type. It will default to list VCN attachments,
but you may request to list ALL attachments of ALL types.
Declaration
public Task<ListDrgAttachmentsResponse> ListDrgAttachments(ListDrgAttachmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDrgAttachmentsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListDrgAttachmentsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDrgAttachments API.
ListDrgRouteDistributionStatements(ListDrgRouteDistributionStatementsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the statements for the specified route distribution.
Declaration
public Task<ListDrgRouteDistributionStatementsResponse> ListDrgRouteDistributionStatements(ListDrgRouteDistributionStatementsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDrgRouteDistributionStatementsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListDrgRouteDistributionStatementsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDrgRouteDistributionStatements API.
ListDrgRouteDistributions(ListDrgRouteDistributionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the route distributions in the specified DRG. <br/> To retrieve the statements in a distribution, use the ListDrgRouteDistributionStatements operation.
Declaration
public Task<ListDrgRouteDistributionsResponse> ListDrgRouteDistributions(ListDrgRouteDistributionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDrgRouteDistributionsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListDrgRouteDistributionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDrgRouteDistributions API.
ListDrgRouteRules(ListDrgRouteRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the route rules in the specified DRG route table.
Declaration
public Task<ListDrgRouteRulesResponse> ListDrgRouteRules(ListDrgRouteRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDrgRouteRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListDrgRouteRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDrgRouteRules API.
ListDrgRouteTables(ListDrgRouteTablesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the DRG route tables for the specified DRG.
<br/>
Use the ListDrgRouteRules
operation to retrieve the route rules in a table.
Declaration
public Task<ListDrgRouteTablesResponse> ListDrgRouteTables(ListDrgRouteTablesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDrgRouteTablesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListDrgRouteTablesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDrgRouteTables API.
ListDrgs(ListDrgsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the DRGs in the specified compartment.
Declaration
public Task<ListDrgsResponse> ListDrgs(ListDrgsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDrgsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListDrgsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDrgs API.
ListFastConnectProviderServices(ListFastConnectProviderServicesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the service offerings from supported providers. You need this information so you can specify your desired provider and service offering when you create a virtual circuit. <br/> For the compartment ID, provide the OCID of your tenancy (the root compartment). <br/> For more information, see FastConnect Overview.
Declaration
public Task<ListFastConnectProviderServicesResponse> ListFastConnectProviderServices(ListFastConnectProviderServicesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListFastConnectProviderServicesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListFastConnectProviderServicesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListFastConnectProviderServices API.
ListFastConnectProviderVirtualCircuitBandwidthShapes(ListFastConnectProviderVirtualCircuitBandwidthShapesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the list of available virtual circuit bandwidth levels for a provider. You need this information so you can specify your desired bandwidth level (shape) when you create a virtual circuit. <br/> For more information about virtual circuits, see FastConnect Overview.
Declaration
public Task<ListFastConnectProviderVirtualCircuitBandwidthShapesResponse> ListFastConnectProviderVirtualCircuitBandwidthShapes(ListFastConnectProviderVirtualCircuitBandwidthShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListFastConnectProviderVirtualCircuitBandwidthShapesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListFastConnectProviderVirtualCircuitBandwidthShapesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListFastConnectProviderVirtualCircuitBandwidthShapes API.
ListIPSecConnectionTunnelRoutes(ListIPSecConnectionTunnelRoutesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
The routes advertised to the on-premises network and the routes received from the on-premises network.
Declaration
public Task<ListIPSecConnectionTunnelRoutesResponse> ListIPSecConnectionTunnelRoutes(ListIPSecConnectionTunnelRoutesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListIPSecConnectionTunnelRoutesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListIPSecConnectionTunnelRoutesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListIPSecConnectionTunnelRoutes API.
ListIPSecConnectionTunnelSecurityAssociations(ListIPSecConnectionTunnelSecurityAssociationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the tunnel security associations information for the specified IPSec tunnel ID.
Declaration
public Task<ListIPSecConnectionTunnelSecurityAssociationsResponse> ListIPSecConnectionTunnelSecurityAssociations(ListIPSecConnectionTunnelSecurityAssociationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListIPSecConnectionTunnelSecurityAssociationsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListIPSecConnectionTunnelSecurityAssociationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListIPSecConnectionTunnelSecurityAssociations API.
ListIPSecConnectionTunnels(ListIPSecConnectionTunnelsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the tunnel information for the specified IPSec connection.
Declaration
public Task<ListIPSecConnectionTunnelsResponse> ListIPSecConnectionTunnels(ListIPSecConnectionTunnelsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListIPSecConnectionTunnelsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListIPSecConnectionTunnelsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListIPSecConnectionTunnels API.
ListIPSecConnections(ListIPSecConnectionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the IPSec connections for the specified compartment. You can filter the results by DRG or CPE.
Declaration
public Task<ListIPSecConnectionsResponse> ListIPSecConnections(ListIPSecConnectionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListIPSecConnectionsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListIPSecConnectionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListIPSecConnections API.
ListInternetGateways(ListInternetGatewaysRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the internet gateways in the specified VCN and the specified compartment. If the VCN ID is not provided, then the list includes the internet gateways from all VCNs in the specified compartment.
Declaration
public Task<ListInternetGatewaysResponse> ListInternetGateways(ListInternetGatewaysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListInternetGatewaysRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListInternetGatewaysResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListInternetGateways API.
ListIpInventory(ListIpInventoryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the IP Inventory information in the selected compartments.
Declaration
public Task<ListIpInventoryResponse> ListIpInventory(ListIpInventoryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListIpInventoryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListIpInventoryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListIpInventory API.
ListIpv6s(ListIpv6sRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the {@link Ipv6} objects based on one of these filters: <br/>
Declaration
public Task<ListIpv6sResponse> ListIpv6s(ListIpv6sRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListIpv6sRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListIpv6sResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListIpv6s API.
ListLocalPeeringGateways(ListLocalPeeringGatewaysRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the local peering gateways (LPGs) for the specified VCN and specified compartment. If the VCN ID is not provided, then the list includes the LPGs from all VCNs in the specified compartment.
Declaration
public Task<ListLocalPeeringGatewaysResponse> ListLocalPeeringGateways(ListLocalPeeringGatewaysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListLocalPeeringGatewaysRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListLocalPeeringGatewaysResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListLocalPeeringGateways API.
ListNatGateways(ListNatGatewaysRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the NAT gateways in the specified compartment. You may optionally specify a VCN OCID to filter the results by VCN.
Declaration
public Task<ListNatGatewaysResponse> ListNatGateways(ListNatGatewaysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListNatGatewaysRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListNatGatewaysResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListNatGateways API.
ListNetworkSecurityGroupSecurityRules(ListNetworkSecurityGroupSecurityRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the security rules in the specified network security group.
Declaration
public Task<ListNetworkSecurityGroupSecurityRulesResponse> ListNetworkSecurityGroupSecurityRules(ListNetworkSecurityGroupSecurityRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListNetworkSecurityGroupSecurityRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListNetworkSecurityGroupSecurityRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListNetworkSecurityGroupSecurityRules API.
ListNetworkSecurityGroupVnics(ListNetworkSecurityGroupVnicsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the VNICs in the specified network security group.
Declaration
public Task<ListNetworkSecurityGroupVnicsResponse> ListNetworkSecurityGroupVnics(ListNetworkSecurityGroupVnicsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListNetworkSecurityGroupVnicsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListNetworkSecurityGroupVnicsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListNetworkSecurityGroupVnics API.
ListNetworkSecurityGroups(ListNetworkSecurityGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists either the network security groups in the specified compartment, or those associated with the specified VLAN.
You must specify either a vlanId
or a compartmentId
, but not both. If you specify a vlanId
, all other parameters are ignored.
Declaration
public Task<ListNetworkSecurityGroupsResponse> ListNetworkSecurityGroups(ListNetworkSecurityGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListNetworkSecurityGroupsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListNetworkSecurityGroupsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListNetworkSecurityGroups API.
ListPrivateIps(ListPrivateIpsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the {@link PrivateIp} objects based on one of these filters: <br/>
- Subnet OCID.
- VNIC OCID.
- Both private IP address and subnet OCID: This lets
you get a
privateIP
object based on its private IP address (for example, 10.0.3.3) and not its OCID. For comparison, {@link #getPrivateIp(GetPrivateIpRequest) getPrivateIp} requires the OCID. <br/> If you're listing all the private IPs associated with a given subnet or VNIC, the response includes both primary and secondary private IPs. <br/> If you are an Oracle Cloud VMware Solution customer and have VLANs in your VCN, you can filter the list by VLAN OCID. See {@link Vlan}.
Declaration
public Task<ListPrivateIpsResponse> ListPrivateIps(ListPrivateIpsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPrivateIpsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListPrivateIpsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPrivateIps API.
ListPublicIpPools(ListPublicIpPoolsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the public IP pools in the specified compartment. You can filter the list using query parameters.
Declaration
public Task<ListPublicIpPoolsResponse> ListPublicIpPools(ListPublicIpPoolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPublicIpPoolsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListPublicIpPoolsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPublicIpPools API.
ListPublicIps(ListPublicIpsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the {@link PublicIp} objects in the specified compartment. You can filter the list by using query parameters. <br/> To list your reserved public IPs:
- Set
scope
=REGION
(required) - Leave the
availabilityDomain
parameter empty - Set
lifetime
=RESERVED
<br/> To list the ephemeral public IPs assigned to a regional entity such as a NAT gateway: - Set
scope
=REGION
(required) - Leave the
availabilityDomain
parameter empty - Set
lifetime
=EPHEMERAL
<br/> To list the ephemeral public IPs assigned to private IPs: - Set
scope
=AVAILABILITY_DOMAIN
(required) - Set the
availabilityDomain
parameter to the desired availability domain (required) - Set
lifetime
=EPHEMERAL
<br/> Note: An ephemeral public IP assigned to a private IP is always in the same availability domain and compartment as the private IP.
Declaration
public Task<ListPublicIpsResponse> ListPublicIps(ListPublicIpsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPublicIpsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListPublicIpsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPublicIps API.
ListRemotePeeringConnections(ListRemotePeeringConnectionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the remote peering connections (RPCs) for the specified DRG and compartment (the RPC's compartment).
Declaration
public Task<ListRemotePeeringConnectionsResponse> ListRemotePeeringConnections(ListRemotePeeringConnectionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListRemotePeeringConnectionsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListRemotePeeringConnectionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListRemotePeeringConnections API.
ListRouteTables(ListRouteTablesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the route tables in the specified VCN and specified compartment. If the VCN ID is not provided, then the list includes the route tables from all VCNs in the specified compartment. The response includes the default route table that automatically comes with each VCN in the specified compartment, plus any route tables you've created.
Declaration
public Task<ListRouteTablesResponse> ListRouteTables(ListRouteTablesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListRouteTablesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListRouteTablesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListRouteTables API.
ListSecurityLists(ListSecurityListsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the security lists in the specified VCN and compartment. If the VCN ID is not provided, then the list includes the security lists from all VCNs in the specified compartment.
Declaration
public Task<ListSecurityListsResponse> ListSecurityLists(ListSecurityListsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSecurityListsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSecurityListsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSecurityLists API.
ListServiceGateways(ListServiceGatewaysRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the service gateways in the specified compartment. You may optionally specify a VCN OCID to filter the results by VCN.
Declaration
public Task<ListServiceGatewaysResponse> ListServiceGateways(ListServiceGatewaysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListServiceGatewaysRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListServiceGatewaysResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListServiceGateways API.
ListServices(ListServicesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the available {@link Service} objects that you can enable for a service gateway in this region.
Declaration
public Task<ListServicesResponse> ListServices(ListServicesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListServicesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListServicesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListServices API.
ListSubnets(ListSubnetsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the subnets in the specified VCN and the specified compartment. If the VCN ID is not provided, then the list includes the subnets from all VCNs in the specified compartment.
Declaration
public Task<ListSubnetsResponse> ListSubnets(ListSubnetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSubnetsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSubnetsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSubnets API.
ListVcns(ListVcnsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the virtual cloud networks (VCNs) in the specified compartment.
Declaration
public Task<ListVcnsResponse> ListVcns(ListVcnsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListVcnsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListVcnsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListVcns API.
ListVirtualCircuitAssociatedTunnels(ListVirtualCircuitAssociatedTunnelsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified virtual circuit's associatedTunnelsInfo.
Declaration
public Task<ListVirtualCircuitAssociatedTunnelsResponse> ListVirtualCircuitAssociatedTunnels(ListVirtualCircuitAssociatedTunnelsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListVirtualCircuitAssociatedTunnelsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListVirtualCircuitAssociatedTunnelsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListVirtualCircuitAssociatedTunnels API.
ListVirtualCircuitBandwidthShapes(ListVirtualCircuitBandwidthShapesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
The operation lists available bandwidth levels for virtual circuits. For the compartment ID, provide the OCID of your tenancy (the root compartment).
Declaration
public Task<ListVirtualCircuitBandwidthShapesResponse> ListVirtualCircuitBandwidthShapes(ListVirtualCircuitBandwidthShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListVirtualCircuitBandwidthShapesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListVirtualCircuitBandwidthShapesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListVirtualCircuitBandwidthShapes API.
ListVirtualCircuitPublicPrefixes(ListVirtualCircuitPublicPrefixesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the public IP prefixes and their details for the specified public virtual circuit.
Declaration
public Task<ListVirtualCircuitPublicPrefixesResponse> ListVirtualCircuitPublicPrefixes(ListVirtualCircuitPublicPrefixesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListVirtualCircuitPublicPrefixesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListVirtualCircuitPublicPrefixesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListVirtualCircuitPublicPrefixes API.
ListVirtualCircuits(ListVirtualCircuitsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the virtual circuits in the specified compartment.
Declaration
public Task<ListVirtualCircuitsResponse> ListVirtualCircuits(ListVirtualCircuitsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListVirtualCircuitsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListVirtualCircuitsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListVirtualCircuits API.
ListVlans(ListVlansRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the VLANs in the specified VCN and the specified compartment.
Declaration
public Task<ListVlansResponse> ListVlans(ListVlansRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListVlansRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListVlansResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListVlans API.
ListVtaps(ListVtapsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the virtual test access points (VTAPs) in the specified compartment.
Declaration
public Task<ListVtapsResponse> ListVtaps(ListVtapsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListVtapsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListVtapsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListVtaps API.
ModifyVcnCidr(ModifyVcnCidrRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified CIDR block of a VCN. The new CIDR IP range must meet the following criteria: <br/>
- Must be valid.
- Must not overlap with another CIDR block in the VCN, a CIDR block of a peered VCN, or the on-premises network CIDR block.
- Must not exceed the limit of CIDR blocks allowed per VCN.
- Must include IP addresses from the original CIDR block that are used in the VCN's existing route rules.
- No IP address in an existing subnet should be outside of the new CIDR block range.
<br/>
Note: Modifying a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can vary depending on the size of your network. Updating a small network could take about a minute, and updating a large network could take up to an hour. You can use the
GetWorkRequest
operation to check the status of the update.
Declaration
public Task<ModifyVcnCidrResponse> ModifyVcnCidr(ModifyVcnCidrRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ModifyVcnCidrRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ModifyVcnCidrResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ModifyVcnCidr API.
RemoveDrgRouteDistributionStatements(RemoveDrgRouteDistributionStatementsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes one or more route distribution statements from the specified route distribution's map.
Declaration
public Task<RemoveDrgRouteDistributionStatementsResponse> RemoveDrgRouteDistributionStatements(RemoveDrgRouteDistributionStatementsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveDrgRouteDistributionStatementsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveDrgRouteDistributionStatementsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveDrgRouteDistributionStatements API.
RemoveDrgRouteRules(RemoveDrgRouteRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes one or more route rules from the specified DRG route table.
Declaration
public Task<RemoveDrgRouteRulesResponse> RemoveDrgRouteRules(RemoveDrgRouteRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveDrgRouteRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveDrgRouteRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveDrgRouteRules API.
RemoveExportDrgRouteDistribution(RemoveExportDrgRouteDistributionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes the export route distribution from the DRG attachment so no routes are advertised to it.
Declaration
public Task<RemoveExportDrgRouteDistributionResponse> RemoveExportDrgRouteDistribution(RemoveExportDrgRouteDistributionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveExportDrgRouteDistributionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveExportDrgRouteDistributionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveExportDrgRouteDistribution API.
RemoveImportDrgRouteDistribution(RemoveImportDrgRouteDistributionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes the import route distribution from the DRG route table so no routes are imported into it.
Declaration
public Task<RemoveImportDrgRouteDistributionResponse> RemoveImportDrgRouteDistribution(RemoveImportDrgRouteDistributionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveImportDrgRouteDistributionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveImportDrgRouteDistributionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveImportDrgRouteDistribution API.
RemoveIpv6SubnetCidr(RemoveIpv6SubnetCidrRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Remove an IPv6 prefix from a subnet. At least one IPv6 CIDR should remain.
Declaration
public Task<RemoveIpv6SubnetCidrResponse> RemoveIpv6SubnetCidr(RemoveIpv6SubnetCidrRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveIpv6SubnetCidrRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveIpv6SubnetCidrResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveIpv6SubnetCidr API.
RemoveIpv6VcnCidr(RemoveIpv6VcnCidrRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removing an existing IPv6 prefix from a VCN.
Declaration
public Task<RemoveIpv6VcnCidrResponse> RemoveIpv6VcnCidr(RemoveIpv6VcnCidrRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveIpv6VcnCidrRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveIpv6VcnCidrResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveIpv6VcnCidr API.
RemoveNetworkSecurityGroupSecurityRules(RemoveNetworkSecurityGroupSecurityRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes one or more security rules from the specified network security group.
Declaration
public Task<RemoveNetworkSecurityGroupSecurityRulesResponse> RemoveNetworkSecurityGroupSecurityRules(RemoveNetworkSecurityGroupSecurityRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveNetworkSecurityGroupSecurityRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveNetworkSecurityGroupSecurityRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveNetworkSecurityGroupSecurityRules API.
RemovePublicIpPoolCapacity(RemovePublicIpPoolCapacityRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes a CIDR block from the referenced public IP pool.
Declaration
public Task<RemovePublicIpPoolCapacityResponse> RemovePublicIpPoolCapacity(RemovePublicIpPoolCapacityRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemovePublicIpPoolCapacityRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemovePublicIpPoolCapacityResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemovePublicIpPoolCapacity API.
RemoveVcnCidr(RemoveVcnCidrRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes a specified CIDR block from a VCN. <br/> Notes:
- You cannot remove a CIDR block if an IP address in its range is in use.
- Removing a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can take a few minutes. You can use the
GetWorkRequest
operation to check the status of the update.
Declaration
public Task<RemoveVcnCidrResponse> RemoveVcnCidr(RemoveVcnCidrRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveVcnCidrRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveVcnCidrResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveVcnCidr API.
UpdateByoipRange(UpdateByoipRangeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the tags or display name associated to the specified BYOIP CIDR block.
Declaration
public Task<UpdateByoipRangeResponse> UpdateByoipRange(UpdateByoipRangeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateByoipRangeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateByoipRangeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateByoipRange API.
UpdateCaptureFilter(UpdateCaptureFilterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified VTAP capture filter's display name or tags.
Declaration
public Task<UpdateCaptureFilterResponse> UpdateCaptureFilter(UpdateCaptureFilterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateCaptureFilterRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateCaptureFilterResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateCaptureFilter API.
UpdateCpe(UpdateCpeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified CPE's display name or tags. Avoid entering confidential information.
Declaration
public Task<UpdateCpeResponse> UpdateCpe(UpdateCpeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateCpeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateCpeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateCpe API.
UpdateCrossConnect(UpdateCrossConnectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified cross-connect.
Declaration
public Task<UpdateCrossConnectResponse> UpdateCrossConnect(UpdateCrossConnectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateCrossConnectRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateCrossConnectResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateCrossConnect API.
UpdateCrossConnectGroup(UpdateCrossConnectGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified cross-connect group's display name. Avoid entering confidential information.
Declaration
public Task<UpdateCrossConnectGroupResponse> UpdateCrossConnectGroup(UpdateCrossConnectGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateCrossConnectGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateCrossConnectGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateCrossConnectGroup API.
UpdateDhcpOptions(UpdateDhcpOptionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified set of DHCP options. You can update the display name or the options
themselves. Avoid entering confidential information.
<br/>
Note that the options
object you provide replaces the entire existing set of options.
Declaration
public Task<UpdateDhcpOptionsResponse> UpdateDhcpOptions(UpdateDhcpOptionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDhcpOptionsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateDhcpOptionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDhcpOptions API.
UpdateDrg(UpdateDrgRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified DRG's display name or tags. Avoid entering confidential information.
Declaration
public Task<UpdateDrgResponse> UpdateDrg(UpdateDrgRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDrgRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateDrgResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDrg API.
UpdateDrgAttachment(UpdateDrgAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the display name and routing information for the specified DrgAttachment
.
Avoid entering confidential information.
Declaration
public Task<UpdateDrgAttachmentResponse> UpdateDrgAttachment(UpdateDrgAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDrgAttachmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateDrgAttachmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDrgAttachment API.
UpdateDrgRouteDistribution(UpdateDrgRouteDistributionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified route distribution
Declaration
public Task<UpdateDrgRouteDistributionResponse> UpdateDrgRouteDistribution(UpdateDrgRouteDistributionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDrgRouteDistributionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateDrgRouteDistributionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDrgRouteDistribution API.
UpdateDrgRouteDistributionStatements(UpdateDrgRouteDistributionStatementsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates one or more route distribution statements in the specified route distribution.
Declaration
public Task<UpdateDrgRouteDistributionStatementsResponse> UpdateDrgRouteDistributionStatements(UpdateDrgRouteDistributionStatementsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDrgRouteDistributionStatementsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateDrgRouteDistributionStatementsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDrgRouteDistributionStatements API.
UpdateDrgRouteRules(UpdateDrgRouteRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates one or more route rules in the specified DRG route table.
Declaration
public Task<UpdateDrgRouteRulesResponse> UpdateDrgRouteRules(UpdateDrgRouteRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDrgRouteRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateDrgRouteRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDrgRouteRules API.
UpdateDrgRouteTable(UpdateDrgRouteTableRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified DRG route table.
Declaration
public Task<UpdateDrgRouteTableResponse> UpdateDrgRouteTable(UpdateDrgRouteTableRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDrgRouteTableRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateDrgRouteTableResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDrgRouteTable API.
UpdateIPSecConnection(UpdateIPSecConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified IPSec connection. <br/> To update an individual IPSec tunnel's attributes, use {@link #updateIPSecConnectionTunnel(UpdateIPSecConnectionTunnelRequest) updateIPSecConnectionTunnel}.
Declaration
public Task<UpdateIPSecConnectionResponse> UpdateIPSecConnection(UpdateIPSecConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateIPSecConnectionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateIPSecConnectionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateIPSecConnection API.
UpdateIPSecConnectionTunnel(UpdateIPSecConnectionTunnelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified tunnel. This operation lets you change tunnel attributes such as the routing type (BGP dynamic routing or static routing). Here are some important notes: <br/>
- If you change the tunnel's routing type or BGP session configuration, the tunnel will go down while it's reprovisioned. <br/>
- If you want to switch the tunnel's
routing
fromSTATIC
toBGP
, make sure the tunnel's BGP session configuration attributes have been set ({@link #bgpSessionInfo(BgpSessionInfoRequest) bgpSessionInfo}). <br/> - If you want to switch the tunnel's
routing
fromBGP
toSTATIC
, make sure the {@link IPSecConnection} already has at least one valid CIDR static route.
Declaration
public Task<UpdateIPSecConnectionTunnelResponse> UpdateIPSecConnectionTunnel(UpdateIPSecConnectionTunnelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateIPSecConnectionTunnelRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateIPSecConnectionTunnelResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateIPSecConnectionTunnel API.
UpdateIPSecConnectionTunnelSharedSecret(UpdateIPSecConnectionTunnelSharedSecretRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the shared secret (pre-shared key) for the specified tunnel. <br/> Important: If you change the shared secret, the tunnel will go down while it's reprovisioned.
Declaration
public Task<UpdateIPSecConnectionTunnelSharedSecretResponse> UpdateIPSecConnectionTunnelSharedSecret(UpdateIPSecConnectionTunnelSharedSecretRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateIPSecConnectionTunnelSharedSecretRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateIPSecConnectionTunnelSharedSecretResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateIPSecConnectionTunnelSharedSecret API.
UpdateInternetGateway(UpdateInternetGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified internet gateway. You can disable/enable it, or change its display name or tags. Avoid entering confidential information. <br/> If the gateway is disabled, that means no traffic will flow to/from the internet even if there's a route rule that enables that traffic.
Declaration
public Task<UpdateInternetGatewayResponse> UpdateInternetGateway(UpdateInternetGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateInternetGatewayRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateInternetGatewayResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateInternetGateway API.
UpdateIpv6(UpdateIpv6Request, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified IPv6. You must specify the object's OCID. Use this operation if you want to: <br/>
- Move an IPv6 to a different VNIC in the same subnet.
- Enable/disable internet access for an IPv6.
- Change the display name for an IPv6.
- Update resource tags for an IPv6.
Declaration
public Task<UpdateIpv6Response> UpdateIpv6(UpdateIpv6Request request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateIpv6Request | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateIpv6Response> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateIpv6 API.
UpdateLocalPeeringGateway(UpdateLocalPeeringGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified local peering gateway (LPG).
Declaration
public Task<UpdateLocalPeeringGatewayResponse> UpdateLocalPeeringGateway(UpdateLocalPeeringGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateLocalPeeringGatewayRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateLocalPeeringGatewayResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateLocalPeeringGateway API.
UpdateNatGateway(UpdateNatGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified NAT gateway.
Declaration
public Task<UpdateNatGatewayResponse> UpdateNatGateway(UpdateNatGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateNatGatewayRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateNatGatewayResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateNatGateway API.
UpdateNetworkSecurityGroup(UpdateNetworkSecurityGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified network security group.
<br/>
To add or remove an existing VNIC from the group, use
{@link #updateVnic(UpdateVnicRequest) updateVnic}.
<br/>
To add a VNIC to the group when you create the VNIC, specify the NSG's OCID during creation.
For example, see the nsgIds
attribute in {@link #createVnicDetails(CreateVnicDetailsRequest) createVnicDetails}.
<br/>
To add or remove security rules from the group, use
{@link #addNetworkSecurityGroupSecurityRules(AddNetworkSecurityGroupSecurityRulesRequest) addNetworkSecurityGroupSecurityRules}
or
{@link #removeNetworkSecurityGroupSecurityRules(RemoveNetworkSecurityGroupSecurityRulesRequest) removeNetworkSecurityGroupSecurityRules}.
<br/>
To edit the contents of existing security rules in the group, use
{@link #updateNetworkSecurityGroupSecurityRules(UpdateNetworkSecurityGroupSecurityRulesRequest) updateNetworkSecurityGroupSecurityRules}.
Declaration
public Task<UpdateNetworkSecurityGroupResponse> UpdateNetworkSecurityGroup(UpdateNetworkSecurityGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateNetworkSecurityGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateNetworkSecurityGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateNetworkSecurityGroup API.
UpdateNetworkSecurityGroupSecurityRules(UpdateNetworkSecurityGroupSecurityRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates one or more security rules in the specified network security group.
Declaration
public Task<UpdateNetworkSecurityGroupSecurityRulesResponse> UpdateNetworkSecurityGroupSecurityRules(UpdateNetworkSecurityGroupSecurityRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateNetworkSecurityGroupSecurityRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateNetworkSecurityGroupSecurityRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateNetworkSecurityGroupSecurityRules API.
UpdatePrivateIp(UpdatePrivateIpRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified private IP. You must specify the object's OCID. Use this operation if you want to: <br/>
- Move a secondary private IP to a different VNIC in the same subnet.
- Change the display name for a secondary private IP.
- Change the hostname for a secondary private IP. <br/> This operation cannot be used with primary private IPs. To update the hostname for the primary IP on a VNIC, use {@link #updateVnic(UpdateVnicRequest) updateVnic}.
Declaration
public Task<UpdatePrivateIpResponse> UpdatePrivateIp(UpdatePrivateIpRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdatePrivateIpRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdatePrivateIpResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdatePrivateIp API.
UpdatePublicIp(UpdatePublicIpRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified public IP. You must specify the object's OCID. Use this operation if you want to: <br/>
- Assign a reserved public IP in your pool to a private IP.
- Move a reserved public IP to a different private IP.
- Unassign a reserved public IP from a private IP (which returns it to your pool of reserved public IPs).
- Change the display name or tags for a public IP.
<br/>
Assigning, moving, and unassigning a reserved public IP are asynchronous
operations. Poll the public IP's
lifecycleState
to determine if the operation succeeded. <br/> Note: When moving a reserved public IP, the target private IP must not already have a public IP withlifecycleState
= ASSIGNING or ASSIGNED. If it does, an error is returned. Also, the initial unassignment from the original private IP always succeeds, but the assignment to the target private IP is asynchronous and could fail silently (for example, if the target private IP is deleted or has a different public IP assigned to it in the interim). If that occurs, the public IP remains unassigned and itslifecycleState
switches to AVAILABLE (it is not reassigned to its original private IP). You must poll the public IP'slifecycleState
to determine if the move succeeded. <br/> Regarding ephemeral public IPs: <br/> - If you want to assign an ephemeral public IP to a primary private IP, use {@link #createPublicIp(CreatePublicIpRequest) createPublicIp}.
- You can't move an ephemeral public IP to a different private IP.
- If you want to unassign an ephemeral public IP from its private IP, use {@link #deletePublicIp(DeletePublicIpRequest) deletePublicIp}, which unassigns and deletes the ephemeral public IP. <br/> Note: If a public IP is assigned to a secondary private IP (see {@link PrivateIp}), and you move that secondary private IP to another VNIC, the public IP moves with it. <br/> Note: There's a limit to the number of {@link PublicIp} a VNIC or instance can have. If you try to move a reserved public IP to a VNIC or instance that has already reached its public IP limit, an error is returned. For information about the public IP limits, see Public IP Addresses.
Declaration
public Task<UpdatePublicIpResponse> UpdatePublicIp(UpdatePublicIpRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdatePublicIpRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdatePublicIpResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdatePublicIp API.
UpdatePublicIpPool(UpdatePublicIpPoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified public IP pool.
Declaration
public Task<UpdatePublicIpPoolResponse> UpdatePublicIpPool(UpdatePublicIpPoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdatePublicIpPoolRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdatePublicIpPoolResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdatePublicIpPool API.
UpdateRemotePeeringConnection(UpdateRemotePeeringConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified remote peering connection (RPC).
Declaration
public Task<UpdateRemotePeeringConnectionResponse> UpdateRemotePeeringConnection(UpdateRemotePeeringConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateRemotePeeringConnectionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateRemotePeeringConnectionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateRemotePeeringConnection API.
UpdateRouteTable(UpdateRouteTableRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified route table's display name or route rules.
Avoid entering confidential information.
<br/>
Note that the routeRules
object you provide replaces the entire existing set of rules.
Declaration
public Task<UpdateRouteTableResponse> UpdateRouteTable(UpdateRouteTableRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateRouteTableRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateRouteTableResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateRouteTable API.
UpdateSecurityList(UpdateSecurityListRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified security list's display name or rules.
Avoid entering confidential information.
<br/>
Note that the egressSecurityRules
or ingressSecurityRules
objects you provide replace the entire
existing objects.
Declaration
public Task<UpdateSecurityListResponse> UpdateSecurityList(UpdateSecurityListRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateSecurityListRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateSecurityListResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateSecurityList API.
UpdateServiceGateway(UpdateServiceGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified service gateway. The information you provide overwrites the existing attributes of the gateway.
Declaration
public Task<UpdateServiceGatewayResponse> UpdateServiceGateway(UpdateServiceGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateServiceGatewayRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateServiceGatewayResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateServiceGateway API.
UpdateSubnet(UpdateSubnetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified subnet.
Declaration
public Task<UpdateSubnetResponse> UpdateSubnet(UpdateSubnetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateSubnetRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateSubnetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateSubnet API.
UpdateTunnelCpeDeviceConfig(UpdateTunnelCpeDeviceConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates or updates the set of CPE configuration answers for the specified tunnel.
The answers correlate to the questions that are specific to the CPE device type (see the
parameters
attribute of {@link CpeDeviceShapeDetail}).
Declaration
public Task<UpdateTunnelCpeDeviceConfigResponse> UpdateTunnelCpeDeviceConfig(UpdateTunnelCpeDeviceConfigRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateTunnelCpeDeviceConfigRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateTunnelCpeDeviceConfigResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateTunnelCpeDeviceConfig API.
UpdateVcn(UpdateVcnRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified VCN.
Declaration
public Task<UpdateVcnResponse> UpdateVcn(UpdateVcnRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateVcnRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateVcnResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateVcn API.
UpdateVirtualCircuit(UpdateVirtualCircuitRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified virtual circuit. This can be called by either the customer who owns the virtual circuit, or the provider (when provisioning or de-provisioning the virtual circuit from their end). The documentation for {@link #updateVirtualCircuitDetails(UpdateVirtualCircuitDetailsRequest) updateVirtualCircuitDetails} indicates who can update each property of the virtual circuit. <br/> Important: If the virtual circuit is working and in the PROVISIONED state, updating any of the network-related properties (such as the DRG being used, the BGP ASN, and so on) will cause the virtual circuit's state to switch to PROVISIONING and the related BGP session to go down. After Oracle re-provisions the virtual circuit, its state will return to PROVISIONED. Make sure you confirm that the associated BGP session is back up. For more information about the various states and how to test connectivity, see FastConnect Overview. <br/> To change the list of public IP prefixes for a public virtual circuit, use {@link #bulkAddVirtualCircuitPublicPrefixes(BulkAddVirtualCircuitPublicPrefixesRequest) bulkAddVirtualCircuitPublicPrefixes} and {@link #bulkDeleteVirtualCircuitPublicPrefixes(BulkDeleteVirtualCircuitPublicPrefixesRequest) bulkDeleteVirtualCircuitPublicPrefixes}. Updating the list of prefixes does NOT cause the BGP session to go down. However, Oracle must verify the customer's ownership of each added prefix before traffic for that prefix will flow across the virtual circuit.
Declaration
public Task<UpdateVirtualCircuitResponse> UpdateVirtualCircuit(UpdateVirtualCircuitRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateVirtualCircuitRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateVirtualCircuitResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateVirtualCircuit API.
UpdateVlan(UpdateVlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified VLAN. Note that this operation might require changes to all the VNICs in the VLAN, which can take a while. The VLAN will be in the UPDATING state until the changes are complete.
Declaration
public Task<UpdateVlanResponse> UpdateVlan(UpdateVlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateVlanRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateVlanResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateVlan API.
UpdateVnic(UpdateVnicRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified VNIC.
Declaration
public Task<UpdateVnicResponse> UpdateVnic(UpdateVnicRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateVnicRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateVnicResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateVnic API.
UpdateVtap(UpdateVtapRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified VTAP's display name or tags.
Declaration
public Task<UpdateVtapResponse> UpdateVtap(UpdateVtapRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateVtapRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateVtapResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateVtap API.
UpgradeDrg(UpgradeDrgRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Upgrades the DRG. After upgrade, you can control routing inside your DRG via DRG attachments, route distributions, and DRG route tables.
Declaration
public Task<UpgradeDrgResponse> UpgradeDrg(UpgradeDrgRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpgradeDrgRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpgradeDrgResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpgradeDrg API.
ValidateByoipRange(ValidateByoipRangeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Submits the BYOIP CIDR block you are importing for validation. Do not submit to Oracle for validation if you have not already modified the information for the BYOIP CIDR block with your Regional Internet Registry. See To import a CIDR block for details.
Declaration
public Task<ValidateByoipRangeResponse> ValidateByoipRange(ValidateByoipRangeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ValidateByoipRangeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ValidateByoipRangeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ValidateByoipRange API.
WithdrawByoipRange(WithdrawByoipRangeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Withdraws BGP route advertisement for the BYOIP CIDR block.
Declaration
public Task<WithdrawByoipRangeResponse> WithdrawByoipRange(WithdrawByoipRangeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
WithdrawByoipRangeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<WithdrawByoipRangeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use WithdrawByoipRange API.