lib/oci/core/virtual_network_client.rb
# Creates a new virtual circuit to use with Oracle Cloud
# Infrastructure FastConnect. For more information, see
# [FastConnect Overview](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm).
#
# 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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm).
# For information about OCIDs, see
# [Resource Identifiers](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
#
# 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.
#
# **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](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm).
#
# @param [OCI::Core::Models::CreateVirtualCircuitDetails] create_virtual_circuit_details Details to create a VirtualCircuit.
# @param [Hash] opts the optional parameters
# @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
#   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
# @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
#   server error without risk of executing that same action again. Retry tokens expire after 24
#   hours, but can be invalidated before then due to conflicting operations (for example, if a resource
#   has been deleted and purged from the system, then a retry of the original creation request
#   may be rejected).
#
# @return [Response] A Response object with data of type {OCI::Core::Models::VirtualCircuit VirtualCircuit}
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/core/create_virtual_circuit.rb.html) to see an example of how to use create_virtual_circuit API.
Creates a new virtual circuit to use with Oracle Cloud
Infrastructure FastConnect. For more information, see
[FastConnect Overview].

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].

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.

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].
Creates a new virtual circuit to use with Oracle Cloud Infrastructure FastConnect . For more information see [ FastConnect Overview ] . 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 ] . 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 . 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 ] .
def create_virtual_circuit(create_virtual_circuit_details, opts = {})
      logger.debug 'Calling operation VirtualNetworkClient#create_virtual_circuit.' if logger
      raise "Missing the required parameter 'create_virtual_circuit_details' when calling create_virtual_circuit." if create_virtual_circuit_details.nil?
      path = '/virtualCircuits'
      operation_signing_strategy = :standard
      query_params = {}
      header_params = {}
      header_params[:accept] = 'application/json'
      header_params[:'content-type'] = 'application/json'
      header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
      header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token
      post_body = @api_client.object_to_http_body(create_virtual_circuit_details)
      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_virtual_circuit') do
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'OCI::Core::Models::VirtualCircuit'
        )
      end
    end
def create_virtual_circuit ( create_virtual_circuit_details , opts = { } ) logger . debug 'Calling operation VirtualNetworkClient#create_virtual_circuit.' if logger raise "Missing the required parameter 'create_virtual_circuit_details' when calling create_virtual_circuit." if create_virtual_circuit_details . nil? path = '/virtualCircuits' operation_signing_strategy = :standard query_params = { } header_params = { } header_params [ :accept ] = 'application/json' header_params [ :' content-type ' ] = 'application/json' header_params [ :' opc-retry-token ' ] = opts [ :opc_retry_token ] if opts [ :opc_retry_token ] header_params [ :' opc-retry-token ' ] ||= OCI :: Retry . generate_opc_retry_token post_body = @api_client . object_to_http_body ( create_virtual_circuit_details ) OCI :: Retry . make_retrying_call ( applicable_retry_config ( opts ) , call_name : 'VirtualNetworkClient#create_virtual_circuit' ) do @api_client . call_api ( :POST , path , endpoint , header_params : header_params , query_params : query_params , operation_signing_strategy : operation_signing_strategy , body : post_body , return_type : 'OCI::Core::Models::VirtualCircuit' ) end end
Creates a new virtual circuit to use with Oracle Cloud
Infrastructure FastConnect.
Creates a new virtual circuit to use with Oracle Cloud Infrastructure FastConnect .
# rubocop:disable Style/NegatedIf # Query Params # Header Params # rubocop:enable Style/NegatedIf # rubocop:disable Metrics/BlockLength # rubocop:enable Metrics/BlockLength
A Response object with data of type {OCI::Core::Models::VirtualCircuit VirtualCircuit}
A Response object with data of type { OCI :: Core :: Models :: VirtualCircuit VirtualCircuit }
Response
create_virtual_circuit_details
<not_specific>
opts
:opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
: opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again . Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations ( for example if a resource has been deleted and purged from the system then a retry of the original creation request may be rejected ) .
<not_specific>
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use create_virtual_circuit API.
Click [ here ] to see an example of how to use create_virtual_circuit API .