byoasns

Creates, updates, deletes, gets or lists a byoasns resource.

Overview

Name	byoasns
Type	Resource
Id	oci.network.byoasns

Fields

The following fields are returned by SELECT queries:

get

The Byoasn resource was retrieved.

Name	Datatype	Description
id	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Byoasn resource.
asn	integer (int64)	The Autonomous System Number (ASN) you are importing to the Oracle cloud.
byoipRanges	array	The BYOIP Ranges that has the Byoasn as origin.
compartmentId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the Byoasn resource.
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
displayName	string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags	object	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
lifecycleState	string	The Byoasn resource's current state. (UPDATING, ACTIVE, DELETED, FAILED, CREATING)
timeCreated	string (date-time)	The date and time the Byoasn resource was created, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
timeUpdated	string (date-time)	The date and time the Byoasn resource was last updated, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
timeValidated	string (date-time)	The date and time the Byoasn resource was validated, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
validationToken	string	The validation token is an internally-generated ASCII string used in the validation process. See [Importing a Byoasn](/iaas/Content/Network/Concepts/BYOASN.htm) for details.

list

The list is being retrieved.

Name	Datatype	Description
id	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Byoasn resource.
asn	integer (int64)	The Autonomous System Number (ASN) you are importing to the Oracle cloud.
compartmentId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the Byoasn resource.
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
displayName	string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags	object	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
lifecycleState	string	The Byoasn resource's current state. (x-obmcs-enumref: #/definitions/Byoasn/lifecycleState)
systemTags	object	System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
timeCreated	string (date-time)	The date and time the Byoasn resource was created, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	byoasnId, region	opc-request-id	Gets the Byoasn resource. You must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm).<br />
list	select	compartmentId, region	opc-request-id, limit, page, displayName, lifecycleState, sortBy, sortOrder	Lists the Byoasn resources in the specified compartment.<br />You can filter the list using query parameters.<br />
create	insert	region, compartmentId, asn, displayName	opc-request-id, opc-retry-token	Creates a BYOASN Resource<br />
update	update	byoasnId, region	opc-request-id, if-match	Updates the tags or display name associated with the specified BYOASN Resource.<br />
delete	delete	byoasnId, region	opc-request-id, if-match	Deletes the specified Byoasn resource.<br />The resource must be in one of the following states: CREATING, ACTIVE or FAILED.<br />It must not be in use by any of the byoipRanges or deletion will fail.<br />You must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm).<br />
change_compartment	exec	byoasnId, region, compartmentId	opc-request-id, opc-retry-token, if-match	Moves a BYOASN Resource to a different compartment. For information<br />about moving resources between compartments, see<br />[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />
validate_byoasn	exec	byoasnId, region	opc-request-id, if-match, opc-retry-token	Submits the BYOASN for validation. Please do not submit to Oracle for validation if the information for the BYOASN is not already modified in the Regional Internet Registry.<br />See [To import a BYOASN](/iaas/Content/Network/Concepts/BYOASN.htm) for details.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
byoasnId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Byoasn resource.
compartmentId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
displayName	string	A filter to return only resources that match the given display name exactly.
if-match	string	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
lifecycleState	string	A filter to return only resources that match the given lifecycle state name exactly.
limit	integer	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: 50
opc-request-id	string	Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-retry-token	string	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).
page	string	For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
sortBy	string	The field to sort by, for byoasn List operation.
sortOrder	string	The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

SELECT examples

get

Gets the Byoasn resource. You must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm).<br />

SELECT
id,
asn,
byoipRanges,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
timeCreated,
timeUpdated,
timeValidated,
validationToken
FROM oci.network.byoasns
WHERE byoasnId = '{{ byoasnId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

Lists the Byoasn resources in the specified compartment.<br />You can filter the list using query parameters.<br />

SELECT
id,
asn,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
systemTags,
timeCreated
FROM oci.network.byoasns
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND displayName = '{{ displayName }}'
AND lifecycleState = '{{ lifecycleState }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
;

INSERT examples

create

Creates a BYOASN Resource<br />

INSERT INTO oci.network.byoasns (
asn,
compartmentId,
definedTags,
displayName,
freeformTags,
region,
opc-request-id,
opc-retry-token
)
SELECT 
{{ asn }} /* required */,
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ displayName }}' /* required */,
'{{ freeformTags }}',
'{{ region }}',
'{{ opc-request-id }}',
'{{ opc-retry-token }}'
RETURNING
id,
asn,
byoipRanges,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
timeCreated,
timeUpdated,
timeValidated,
validationToken
;

Manifest

# Description fields are for documentation purposes
- name: byoasns
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the byoasns resource.
  - name: asn
    value: {{ asn }}
    description: |
      The Autonomous System Number (ASN) you are importing to the Oracle cloud.
  - name: compartmentId
    value: "{{ compartmentId }}"
    description: |
      The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the BYOASN Resource.
  - name: definedTags
    value: "{{ definedTags }}"
    description: |
      Defined tags for this resource. Each key is predefined and scoped to a
      namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
      Example: `{"Operations": {"CostCenter": "42"}}`
  - name: displayName
    value: "{{ displayName }}"
    description: |
      A user-friendly name. Does not have to be unique, and it's changeable.
      Avoid entering confidential information.
  - name: freeformTags
    value: "{{ freeformTags }}"
    description: |
      Free-form tags for this resource. Each tag is a simple key-value pair with no
      predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
      Example: `{"Department": "Finance"}`
  - name: opc-request-id
    value: "{{ opc-request-id }}"
    description: Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 
    description: Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: 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). 
    description: 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). 

UPDATE examples

update

Updates the tags or display name associated with the specified BYOASN Resource.<br />

UPDATE oci.network.byoasns
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}'
WHERE 
byoasnId = '{{ byoasnId }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id}}'
AND if-match = '{{ if-match}}'
RETURNING
id,
asn,
byoipRanges,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
timeCreated,
timeUpdated,
timeValidated,
validationToken;

DELETE examples

delete

Deletes the specified Byoasn resource.<br />The resource must be in one of the following states: CREATING, ACTIVE or FAILED.<br />It must not be in use by any of the byoipRanges or deletion will fail.<br />You must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm).<br />

DELETE FROM oci.network.byoasns
WHERE byoasnId = '{{ byoasnId }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id }}'
AND if-match = '{{ if-match }}'
;

Lifecycle Methods

change_compartment

Moves a BYOASN Resource to a different compartment. For information<br />about moving resources between compartments, see<br />[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />

EXEC oci.network.byoasns.change_compartment 
@byoasnId='{{ byoasnId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}', 
@if-match='{{ if-match }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;

validate_byoasn

Submits the BYOASN for validation. Please do not submit to Oracle for validation if the information for the BYOASN is not already modified in the Regional Internet Registry.<br />See [To import a BYOASN](/iaas/Content/Network/Concepts/BYOASN.htm) for details.<br />

EXEC oci.network.byoasns.validate_byoasn 
@byoasnId='{{ byoasnId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@if-match='{{ if-match }}', 
@opc-retry-token='{{ opc-retry-token }}'
;