/** * Core Services API * Use the Core Services API to manage resources such as virtual cloud networks (VCNs), compute instances, and block storage volumes. For more information, see the console documentation for the [Networking](https://docs.oracle.com/iaas/Content/Network/Concepts/overview.htm), [Compute](https://docs.oracle.com/iaas/Content/Compute/Concepts/computeoverview.htm), and [Block Volume](https://docs.oracle.com/iaas/Content/Block/Concepts/overview.htm) services. The required permissions are documented in the [Details for the Core Services](https://docs.oracle.com/iaas/Content/Identity/Reference/corepolicyreference.htm) article. * OpenAPI spec version: 20160918 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ import common = require("oci-common"); import * as requests from "./request"; import * as model from "./model"; import * as responses from "./response"; import { WorkRequestClient } from "oci-workrequests"; import { BlockstorageWaiter } from "./blockstorage-waiter"; import { ComputeWaiter } from "./compute-waiter"; import { ComputeManagementWaiter } from "./computemanagement-waiter"; import { VirtualNetworkWaiter } from "./virtualnetwork-waiter"; declare const Breaker: any; export declare enum BlockstorageApiKeys { } /** * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user. */ export declare class BlockstorageClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_waiters": BlockstorageWaiter; protected "_clientConfiguration": common.ClientConfiguration; protected _circuitBreaker: typeof Breaker | null; protected _httpOptions: any; protected _bodyDuplexMode: any; targetService: string; protected _regionId: string; protected "_region": common.Region; protected _lastSetRegionOrRegionId: string; protected _enableDualstackEndpoint: boolean | undefined; protected _serviceUsesDualStackByDefault: boolean; protected _httpClient: common.HttpClient; protected _authProvider: common.AuthenticationDetailsProvider | undefined; constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration); /** * Get the endpoint that is being used to call (ex, https://www.example.com). */ get endpoint(): string; /** * Sets the endpoint to call (ex, https://www.example.com). * @param endpoint The endpoint of the service. */ set endpoint(endpoint: string); get logger(): import("oci-common/lib/log").Logger; /** * Determines whether realm specific endpoint should be used or not. * Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false" * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template */ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean); /** * Sets the region to call (ex, Region.US_PHOENIX_1). * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint. * @param region The region of the service. */ set region(region: common.Region); /** * Sets the regionId to call (ex, 'us-phoenix-1'). * * Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. * If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 * and then call {@link #endpoint(String) endpoint}. * @param regionId The public region ID. */ set regionId(regionId: string); set enableDualstackEndpoint(enableDualstackEndpoint: boolean); /** * Creates a new BlockstorageWaiter for resources for this service. * * @param workRequestClient The work request service client used to query for work request status * @param config The waiter configuration for termination and delay strategy * @return The service waiters. */ createWaiters(workRequestClient: WorkRequestClient, config?: common.WaiterConfiguration): BlockstorageWaiter; /** * Gets the waiters available for resources for this service. * * @return The service waiters. */ getWaiters(): BlockstorageWaiter; /** * Shutdown the circuit breaker used by the client when it is no longer needed */ shutdownCircuitBreaker(): void; /** * Close the provider if possible which in turn shuts down any associated circuit breaker */ closeProvider(): void; /** * Close the client once it is no longer needed */ close(): void; /** * Moves a boot volume backup into a different compartment within the same tenancy. * For information about moving resources between compartments, * see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeBootVolumeBackupCompartmentRequest * @return ChangeBootVolumeBackupCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeBootVolumeBackupCompartment.ts.html |here} to see how to use ChangeBootVolumeBackupCompartment API. */ changeBootVolumeBackupCompartment(changeBootVolumeBackupCompartmentRequest: requests.ChangeBootVolumeBackupCompartmentRequest): Promise; /** * Moves a boot volume into a different compartment within the same tenancy. * For information about moving resources between compartments, * see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeBootVolumeCompartmentRequest * @return ChangeBootVolumeCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeBootVolumeCompartment.ts.html |here} to see how to use ChangeBootVolumeCompartment API. */ changeBootVolumeCompartment(changeBootVolumeCompartmentRequest: requests.ChangeBootVolumeCompartmentRequest): Promise; /** * Moves a volume backup into a different compartment within the same tenancy. * For information about moving resources between compartments, * see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeVolumeBackupCompartmentRequest * @return ChangeVolumeBackupCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeVolumeBackupCompartment.ts.html |here} to see how to use ChangeVolumeBackupCompartment API. */ changeVolumeBackupCompartment(changeVolumeBackupCompartmentRequest: requests.ChangeVolumeBackupCompartmentRequest): Promise; /** * Moves a volume into a different compartment within the same tenancy. * For information about moving resources between compartments, * see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeVolumeCompartmentRequest * @return ChangeVolumeCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeVolumeCompartment.ts.html |here} to see how to use ChangeVolumeCompartment API. */ changeVolumeCompartment(changeVolumeCompartmentRequest: requests.ChangeVolumeCompartmentRequest): Promise; /** * Moves a volume group backup into a different compartment within the same tenancy. * For information about moving resources between compartments, * see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeVolumeGroupBackupCompartmentRequest * @return ChangeVolumeGroupBackupCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeVolumeGroupBackupCompartment.ts.html |here} to see how to use ChangeVolumeGroupBackupCompartment API. */ changeVolumeGroupBackupCompartment(changeVolumeGroupBackupCompartmentRequest: requests.ChangeVolumeGroupBackupCompartmentRequest): Promise; /** * Moves a volume group into a different compartment within the same tenancy. * For information about moving resources between compartments, * see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeVolumeGroupCompartmentRequest * @return ChangeVolumeGroupCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeVolumeGroupCompartment.ts.html |here} to see how to use ChangeVolumeGroupCompartment API. */ changeVolumeGroupCompartment(changeVolumeGroupCompartmentRequest: requests.ChangeVolumeGroupCompartmentRequest): Promise; /** * Creates a boot volume backup copy in specified region. For general information about volume backups, * see [Overview of Boot Volume Backups](https://docs.oracle.com/iaas/Content/Block/Concepts/bootvolumebackups.htm) * * This operation does not retry by default if the user has not defined a retry configuration. * @param CopyBootVolumeBackupRequest * @return CopyBootVolumeBackupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CopyBootVolumeBackup.ts.html |here} to see how to use CopyBootVolumeBackup API. */ copyBootVolumeBackup(copyBootVolumeBackupRequest: requests.CopyBootVolumeBackupRequest): Promise; /** * Creates a volume backup copy in specified region. For general information about volume backups, * see [Overview of Block Volume Service Backups](https://docs.oracle.com/iaas/Content/Block/Concepts/blockvolumebackups.htm) * * This operation does not retry by default if the user has not defined a retry configuration. * @param CopyVolumeBackupRequest * @return CopyVolumeBackupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CopyVolumeBackup.ts.html |here} to see how to use CopyVolumeBackup API. */ copyVolumeBackup(copyVolumeBackupRequest: requests.CopyVolumeBackupRequest): Promise; /** * Creates a volume group backup copy in specified region. For general information about volume group backups, * see [Overview of Block Volume Backups](https://docs.oracle.com/iaas/Content/Block/Concepts/blockvolumebackups.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param CopyVolumeGroupBackupRequest * @return CopyVolumeGroupBackupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CopyVolumeGroupBackup.ts.html |here} to see how to use CopyVolumeGroupBackup API. */ copyVolumeGroupBackup(copyVolumeGroupBackupRequest: requests.CopyVolumeGroupBackupRequest): Promise; /** * Creates a new boot volume in the specified compartment from an existing boot volume or a boot volume backup. * For general information about boot volumes, see [Boot Volumes](https://docs.oracle.com/iaas/Content/Block/Concepts/bootvolumes.htm). * You may optionally specify a *display name* for the volume, which is simply a friendly name or * description. It does not have to be unique, and you can change it. Avoid entering confidential information. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateBootVolumeRequest * @return CreateBootVolumeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateBootVolume.ts.html |here} to see how to use CreateBootVolume API. */ createBootVolume(createBootVolumeRequest: requests.CreateBootVolumeRequest): Promise; /** * Creates a new boot volume backup of the specified boot volume. For general information about boot volume backups, * see [Overview of Boot Volume Backups](https://docs.oracle.com/iaas/Content/Block/Concepts/bootvolumebackups.htm) *

When the request is received, the backup object is in a REQUEST_RECEIVED state. * When the data is imaged, it goes into a CREATING state. * After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateBootVolumeBackupRequest * @return CreateBootVolumeBackupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateBootVolumeBackup.ts.html |here} to see how to use CreateBootVolumeBackup API. */ createBootVolumeBackup(createBootVolumeBackupRequest: requests.CreateBootVolumeBackupRequest): Promise; /** * Creates a new volume in the specified compartment. Volumes can be created in sizes ranging from * 50 GB (51200 MB) to 32 TB (33554432 MB), in 1 GB (1024 MB) increments. By default, volumes are 1 TB (1048576 MB). * For general information about block volumes, see * [Overview of Block Volume Service](https://docs.oracle.com/iaas/Content/Block/Concepts/overview.htm). *

A volume and instance can be in separate compartments but must be in the same availability domain. * For information about access control and compartments, see * [Overview of the IAM Service](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about * availability domains, see [Regions and Availability Domains](https://docs.oracle.com/iaas/Content/General/Concepts/regions.htm). * To get a list of availability domains, use the `ListAvailabilityDomains` operation * in the Identity and Access Management Service API. *

You may optionally specify a *display name* for the volume, which is simply a friendly name or * description. It does not have to be unique, and you can change it. Avoid entering confidential information. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateVolumeRequest * @return CreateVolumeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateVolume.ts.html |here} to see how to use CreateVolume API. */ createVolume(createVolumeRequest: requests.CreateVolumeRequest): Promise; /** * Creates a new backup of the specified volume. For general information about volume backups, * see [Overview of Block Volume Service Backups](https://docs.oracle.com/iaas/Content/Block/Concepts/blockvolumebackups.htm) *

When the request is received, the backup object is in a REQUEST_RECEIVED state. * When the data is imaged, it goes into a CREATING state. * After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateVolumeBackupRequest * @return CreateVolumeBackupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateVolumeBackup.ts.html |here} to see how to use CreateVolumeBackup API. */ createVolumeBackup(createVolumeBackupRequest: requests.CreateVolumeBackupRequest): Promise; /** * Creates a new user defined backup policy. *

For more information about Oracle defined backup policies and user defined backup policies, * see [Policy-Based Backups](https://docs.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateVolumeBackupPolicyRequest * @return CreateVolumeBackupPolicyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateVolumeBackupPolicy.ts.html |here} to see how to use CreateVolumeBackupPolicy API. */ createVolumeBackupPolicy(createVolumeBackupPolicyRequest: requests.CreateVolumeBackupPolicyRequest): Promise; /** * Assigns a volume backup policy to the specified volume. Note that a given volume can * only have one backup policy assigned to it. If this operation is used for a volume that already * has a different backup policy assigned, the prior backup policy will be silently unassigned. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateVolumeBackupPolicyAssignmentRequest * @return CreateVolumeBackupPolicyAssignmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateVolumeBackupPolicyAssignment.ts.html |here} to see how to use CreateVolumeBackupPolicyAssignment API. */ createVolumeBackupPolicyAssignment(createVolumeBackupPolicyAssignmentRequest: requests.CreateVolumeBackupPolicyAssignmentRequest): Promise; /** * Creates a new volume group in the specified compartment. * A volume group is a collection of volumes and may be created from a list of volumes, cloning an existing * volume group, or by restoring a volume group backup. * You may optionally specify a *display name* for the volume group, which is simply a friendly name or * description. It does not have to be unique, and you can change it. Avoid entering confidential information. *

For more information, see [Volume Groups](https://docs.oracle.com/iaas/Content/Block/Concepts/volumegroups.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateVolumeGroupRequest * @return CreateVolumeGroupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateVolumeGroup.ts.html |here} to see how to use CreateVolumeGroup API. */ createVolumeGroup(createVolumeGroupRequest: requests.CreateVolumeGroupRequest): Promise; /** * Creates a new backup volume group of the specified volume group. * For more information, see [Volume Groups](https://docs.oracle.com/iaas/Content/Block/Concepts/volumegroups.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateVolumeGroupBackupRequest * @return CreateVolumeGroupBackupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateVolumeGroupBackup.ts.html |here} to see how to use CreateVolumeGroupBackup API. */ createVolumeGroupBackup(createVolumeGroupBackupRequest: requests.CreateVolumeGroupBackupRequest): Promise; /** * Deletes the specified boot volume. The volume cannot have an active connection to an instance. * To disconnect the boot volume from a connected instance, see * [Disconnecting From a Boot Volume](https://docs.oracle.com/iaas/Content/Block/Tasks/deletingbootvolume.htm). * **Warning:** All data on the boot volume will be permanently lost when the boot volume is deleted. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteBootVolumeRequest * @return DeleteBootVolumeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteBootVolume.ts.html |here} to see how to use DeleteBootVolume API. */ deleteBootVolume(deleteBootVolumeRequest: requests.DeleteBootVolumeRequest): Promise; /** * Deletes a boot volume backup. * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteBootVolumeBackupRequest * @return DeleteBootVolumeBackupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteBootVolumeBackup.ts.html |here} to see how to use DeleteBootVolumeBackup API. */ deleteBootVolumeBackup(deleteBootVolumeBackupRequest: requests.DeleteBootVolumeBackupRequest): Promise; /** * Removes the specified boot volume's assigned Vault Service encryption key. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteBootVolumeKmsKeyRequest * @return DeleteBootVolumeKmsKeyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteBootVolumeKmsKey.ts.html |here} to see how to use DeleteBootVolumeKmsKey API. */ deleteBootVolumeKmsKey(deleteBootVolumeKmsKeyRequest: requests.DeleteBootVolumeKmsKeyRequest): Promise; /** * Deletes the specified volume. The volume cannot have an active connection to an instance. * To disconnect the volume from a connected instance, see * [Disconnecting From a Volume](https://docs.oracle.com/iaas/Content/Block/Tasks/disconnectingfromavolume.htm). * **Warning:** All data on the volume will be permanently lost when the volume is deleted. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteVolumeRequest * @return DeleteVolumeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteVolume.ts.html |here} to see how to use DeleteVolume API. */ deleteVolume(deleteVolumeRequest: requests.DeleteVolumeRequest): Promise; /** * Deletes a volume backup. * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteVolumeBackupRequest * @return DeleteVolumeBackupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteVolumeBackup.ts.html |here} to see how to use DeleteVolumeBackup API. */ deleteVolumeBackup(deleteVolumeBackupRequest: requests.DeleteVolumeBackupRequest): Promise; /** * Deletes a user defined backup policy. * For more information about user defined backup policies, * see [Policy-Based Backups](https://docs.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#UserDefinedBackupPolicies). *

Avoid entering confidential information. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteVolumeBackupPolicyRequest * @return DeleteVolumeBackupPolicyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteVolumeBackupPolicy.ts.html |here} to see how to use DeleteVolumeBackupPolicy API. */ deleteVolumeBackupPolicy(deleteVolumeBackupPolicyRequest: requests.DeleteVolumeBackupPolicyRequest): Promise; /** * Deletes a volume backup policy assignment. * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteVolumeBackupPolicyAssignmentRequest * @return DeleteVolumeBackupPolicyAssignmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteVolumeBackupPolicyAssignment.ts.html |here} to see how to use DeleteVolumeBackupPolicyAssignment API. */ deleteVolumeBackupPolicyAssignment(deleteVolumeBackupPolicyAssignmentRequest: requests.DeleteVolumeBackupPolicyAssignmentRequest): Promise; /** * Deletes the specified volume group. Individual volumes are not deleted, only the volume group is deleted. * For more information, see [Volume Groups](https://docs.oracle.com/iaas/Content/Block/Concepts/volumegroups.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteVolumeGroupRequest * @return DeleteVolumeGroupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteVolumeGroup.ts.html |here} to see how to use DeleteVolumeGroup API. */ deleteVolumeGroup(deleteVolumeGroupRequest: requests.DeleteVolumeGroupRequest): Promise; /** * Deletes a volume group backup. This operation deletes all the backups in * the volume group. For more information, see [Volume Groups](https://docs.oracle.com/iaas/Content/Block/Concepts/volumegroups.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteVolumeGroupBackupRequest * @return DeleteVolumeGroupBackupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteVolumeGroupBackup.ts.html |here} to see how to use DeleteVolumeGroupBackup API. */ deleteVolumeGroupBackup(deleteVolumeGroupBackupRequest: requests.DeleteVolumeGroupBackupRequest): Promise; /** * Removes the specified volume's assigned Vault service encryption key. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteVolumeKmsKeyRequest * @return DeleteVolumeKmsKeyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteVolumeKmsKey.ts.html |here} to see how to use DeleteVolumeKmsKey API. */ deleteVolumeKmsKey(deleteVolumeKmsKeyRequest: requests.DeleteVolumeKmsKeyRequest): Promise; /** * Gets information for the specified block volume replica. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetBlockVolumeReplicaRequest * @return GetBlockVolumeReplicaResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetBlockVolumeReplica.ts.html |here} to see how to use GetBlockVolumeReplica API. */ getBlockVolumeReplica(getBlockVolumeReplicaRequest: requests.GetBlockVolumeReplicaRequest): Promise; /** * Gets information for the specified boot volume. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetBootVolumeRequest * @return GetBootVolumeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetBootVolume.ts.html |here} to see how to use GetBootVolume API. */ getBootVolume(getBootVolumeRequest: requests.GetBootVolumeRequest): Promise; /** * Gets information for the specified boot volume backup. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetBootVolumeBackupRequest * @return GetBootVolumeBackupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetBootVolumeBackup.ts.html |here} to see how to use GetBootVolumeBackup API. */ getBootVolumeBackup(getBootVolumeBackupRequest: requests.GetBootVolumeBackupRequest): Promise; /** * Gets the Vault service encryption key assigned to the specified boot volume. * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetBootVolumeKmsKeyRequest * @return GetBootVolumeKmsKeyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetBootVolumeKmsKey.ts.html |here} to see how to use GetBootVolumeKmsKey API. */ getBootVolumeKmsKey(getBootVolumeKmsKeyRequest: requests.GetBootVolumeKmsKeyRequest): Promise; /** * Gets information for the specified boot volume replica. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetBootVolumeReplicaRequest * @return GetBootVolumeReplicaResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetBootVolumeReplica.ts.html |here} to see how to use GetBootVolumeReplica API. */ getBootVolumeReplica(getBootVolumeReplicaRequest: requests.GetBootVolumeReplicaRequest): Promise; /** * Gets information for the specified volume. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetVolumeRequest * @return GetVolumeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetVolume.ts.html |here} to see how to use GetVolume API. */ getVolume(getVolumeRequest: requests.GetVolumeRequest): Promise; /** * Gets information for the specified volume backup. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetVolumeBackupRequest * @return GetVolumeBackupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetVolumeBackup.ts.html |here} to see how to use GetVolumeBackup API. */ getVolumeBackup(getVolumeBackupRequest: requests.GetVolumeBackupRequest): Promise; /** * Gets information for the specified volume backup policy. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetVolumeBackupPolicyRequest * @return GetVolumeBackupPolicyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetVolumeBackupPolicy.ts.html |here} to see how to use GetVolumeBackupPolicy API. */ getVolumeBackupPolicy(getVolumeBackupPolicyRequest: requests.GetVolumeBackupPolicyRequest): Promise; /** * Gets the volume backup policy assignment for the specified volume. The * `assetId` query parameter is required, and the returned list will contain at most * one item, since volume can only have one volume backup policy assigned at a time. * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetVolumeBackupPolicyAssetAssignmentRequest * @return GetVolumeBackupPolicyAssetAssignmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetVolumeBackupPolicyAssetAssignment.ts.html |here} to see how to use GetVolumeBackupPolicyAssetAssignment API. */ getVolumeBackupPolicyAssetAssignment(getVolumeBackupPolicyAssetAssignmentRequest: requests.GetVolumeBackupPolicyAssetAssignmentRequest): Promise; /** * NOTE: This function is deprecated in favor of getVolumeBackupPolicyAssetAssignmentRecordIterator function. * Creates a new async iterator which will iterate over the models.VolumeBackupPolicyAssignment objects * contained in responses from the getVolumeBackupPolicyAssetAssignment operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ getAllVolumeBackupPolicyAssetAssignment(request: requests.GetVolumeBackupPolicyAssetAssignmentRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of getVolumeBackupPolicyAssetAssignmentResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the getVolumeBackupPolicyAssetAssignment operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ getAllVolumeBackupPolicyAssetAssignmentResponses(request: requests.GetVolumeBackupPolicyAssetAssignmentRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.VolumeBackupPolicyAssignment objects * contained in responses from the getVolumeBackupPolicyAssetAssignment operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ getVolumeBackupPolicyAssetAssignmentRecordIterator(request: requests.GetVolumeBackupPolicyAssetAssignmentRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the getVolumeBackupPolicyAssetAssignment operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ getVolumeBackupPolicyAssetAssignmentResponseIterator(request: requests.GetVolumeBackupPolicyAssetAssignmentRequest): AsyncIterableIterator; /** * Gets information for the specified volume backup policy assignment. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetVolumeBackupPolicyAssignmentRequest * @return GetVolumeBackupPolicyAssignmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetVolumeBackupPolicyAssignment.ts.html |here} to see how to use GetVolumeBackupPolicyAssignment API. */ getVolumeBackupPolicyAssignment(getVolumeBackupPolicyAssignmentRequest: requests.GetVolumeBackupPolicyAssignmentRequest): Promise; /** * Gets information for the specified volume group. For more information, see [Volume Groups](https://docs.oracle.com/iaas/Content/Block/Concepts/volumegroups.htm). * This operation does not retry by default if the user has not defined a retry configuration. * @param GetVolumeGroupRequest * @return GetVolumeGroupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetVolumeGroup.ts.html |here} to see how to use GetVolumeGroup API. */ getVolumeGroup(getVolumeGroupRequest: requests.GetVolumeGroupRequest): Promise; /** * Gets information for the specified volume group backup. For more information, see [Volume Groups](https://docs.oracle.com/iaas/Content/Block/Concepts/volumegroups.htm). * This operation does not retry by default if the user has not defined a retry configuration. * @param GetVolumeGroupBackupRequest * @return GetVolumeGroupBackupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetVolumeGroupBackup.ts.html |here} to see how to use GetVolumeGroupBackup API. */ getVolumeGroupBackup(getVolumeGroupBackupRequest: requests.GetVolumeGroupBackupRequest): Promise; /** * Gets information for the specified volume group replica. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetVolumeGroupReplicaRequest * @return GetVolumeGroupReplicaResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetVolumeGroupReplica.ts.html |here} to see how to use GetVolumeGroupReplica API. */ getVolumeGroupReplica(getVolumeGroupReplicaRequest: requests.GetVolumeGroupReplicaRequest): Promise; /** * Gets the Vault service encryption key assigned to the specified volume. * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetVolumeKmsKeyRequest * @return GetVolumeKmsKeyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetVolumeKmsKey.ts.html |here} to see how to use GetVolumeKmsKey API. */ getVolumeKmsKey(getVolumeKmsKeyRequest: requests.GetVolumeKmsKeyRequest): Promise; /** * Lists the block volume replicas in the specified compartment and availability domain. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListBlockVolumeReplicasRequest * @return ListBlockVolumeReplicasResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListBlockVolumeReplicas.ts.html |here} to see how to use ListBlockVolumeReplicas API. */ listBlockVolumeReplicas(listBlockVolumeReplicasRequest: requests.ListBlockVolumeReplicasRequest): Promise; /** * NOTE: This function is deprecated in favor of listBlockVolumeReplicasRecordIterator function. * Creates a new async iterator which will iterate over the models.BlockVolumeReplica objects * contained in responses from the listBlockVolumeReplicas operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllBlockVolumeReplicas(request: requests.ListBlockVolumeReplicasRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listBlockVolumeReplicasResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listBlockVolumeReplicas operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllBlockVolumeReplicasResponses(request: requests.ListBlockVolumeReplicasRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.BlockVolumeReplica objects * contained in responses from the listBlockVolumeReplicas operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listBlockVolumeReplicasRecordIterator(request: requests.ListBlockVolumeReplicasRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listBlockVolumeReplicas operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listBlockVolumeReplicasResponseIterator(request: requests.ListBlockVolumeReplicasRequest): AsyncIterableIterator; /** * Lists the boot volume backups in the specified compartment. You can filter the results by boot volume. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListBootVolumeBackupsRequest * @return ListBootVolumeBackupsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListBootVolumeBackups.ts.html |here} to see how to use ListBootVolumeBackups API. */ listBootVolumeBackups(listBootVolumeBackupsRequest: requests.ListBootVolumeBackupsRequest): Promise; /** * NOTE: This function is deprecated in favor of listBootVolumeBackupsRecordIterator function. * Creates a new async iterator which will iterate over the models.BootVolumeBackup objects * contained in responses from the listBootVolumeBackups operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllBootVolumeBackups(request: requests.ListBootVolumeBackupsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listBootVolumeBackupsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listBootVolumeBackups operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllBootVolumeBackupsResponses(request: requests.ListBootVolumeBackupsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.BootVolumeBackup objects * contained in responses from the listBootVolumeBackups operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listBootVolumeBackupsRecordIterator(request: requests.ListBootVolumeBackupsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listBootVolumeBackups operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listBootVolumeBackupsResponseIterator(request: requests.ListBootVolumeBackupsRequest): AsyncIterableIterator; /** * Lists the boot volume replicas in the specified compartment and availability domain. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListBootVolumeReplicasRequest * @return ListBootVolumeReplicasResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListBootVolumeReplicas.ts.html |here} to see how to use ListBootVolumeReplicas API. */ listBootVolumeReplicas(listBootVolumeReplicasRequest: requests.ListBootVolumeReplicasRequest): Promise; /** * NOTE: This function is deprecated in favor of listBootVolumeReplicasRecordIterator function. * Creates a new async iterator which will iterate over the models.BootVolumeReplica objects * contained in responses from the listBootVolumeReplicas operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllBootVolumeReplicas(request: requests.ListBootVolumeReplicasRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listBootVolumeReplicasResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listBootVolumeReplicas operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllBootVolumeReplicasResponses(request: requests.ListBootVolumeReplicasRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.BootVolumeReplica objects * contained in responses from the listBootVolumeReplicas operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listBootVolumeReplicasRecordIterator(request: requests.ListBootVolumeReplicasRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listBootVolumeReplicas operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listBootVolumeReplicasResponseIterator(request: requests.ListBootVolumeReplicasRequest): AsyncIterableIterator; /** * Lists the boot volumes in the specified compartment and availability domain. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListBootVolumesRequest * @return ListBootVolumesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListBootVolumes.ts.html |here} to see how to use ListBootVolumes API. */ listBootVolumes(listBootVolumesRequest: requests.ListBootVolumesRequest): Promise; /** * NOTE: This function is deprecated in favor of listBootVolumesRecordIterator function. * Creates a new async iterator which will iterate over the models.BootVolume objects * contained in responses from the listBootVolumes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllBootVolumes(request: requests.ListBootVolumesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listBootVolumesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listBootVolumes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllBootVolumesResponses(request: requests.ListBootVolumesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.BootVolume objects * contained in responses from the listBootVolumes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listBootVolumesRecordIterator(request: requests.ListBootVolumesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listBootVolumes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listBootVolumesResponseIterator(request: requests.ListBootVolumesRequest): AsyncIterableIterator; /** * Lists all the volume backup policies available in the specified compartment. *

For more information about Oracle defined backup policies and user defined backup policies, * see [Policy-Based Backups](https://docs.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListVolumeBackupPoliciesRequest * @return ListVolumeBackupPoliciesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListVolumeBackupPolicies.ts.html |here} to see how to use ListVolumeBackupPolicies API. */ listVolumeBackupPolicies(listVolumeBackupPoliciesRequest: requests.ListVolumeBackupPoliciesRequest): Promise; /** * NOTE: This function is deprecated in favor of listVolumeBackupPoliciesRecordIterator function. * Creates a new async iterator which will iterate over the models.VolumeBackupPolicy objects * contained in responses from the listVolumeBackupPolicies operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllVolumeBackupPolicies(request: requests.ListVolumeBackupPoliciesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listVolumeBackupPoliciesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listVolumeBackupPolicies operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllVolumeBackupPoliciesResponses(request: requests.ListVolumeBackupPoliciesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.VolumeBackupPolicy objects * contained in responses from the listVolumeBackupPolicies operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listVolumeBackupPoliciesRecordIterator(request: requests.ListVolumeBackupPoliciesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listVolumeBackupPolicies operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listVolumeBackupPoliciesResponseIterator(request: requests.ListVolumeBackupPoliciesRequest): AsyncIterableIterator; /** * Lists the volume backups in the specified compartment. You can filter the results by volume. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListVolumeBackupsRequest * @return ListVolumeBackupsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListVolumeBackups.ts.html |here} to see how to use ListVolumeBackups API. */ listVolumeBackups(listVolumeBackupsRequest: requests.ListVolumeBackupsRequest): Promise; /** * NOTE: This function is deprecated in favor of listVolumeBackupsRecordIterator function. * Creates a new async iterator which will iterate over the models.VolumeBackup objects * contained in responses from the listVolumeBackups operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllVolumeBackups(request: requests.ListVolumeBackupsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listVolumeBackupsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listVolumeBackups operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllVolumeBackupsResponses(request: requests.ListVolumeBackupsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.VolumeBackup objects * contained in responses from the listVolumeBackups operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listVolumeBackupsRecordIterator(request: requests.ListVolumeBackupsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listVolumeBackups operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listVolumeBackupsResponseIterator(request: requests.ListVolumeBackupsRequest): AsyncIterableIterator; /** * Lists the volume group backups in the specified compartment. You can filter the results by volume group. * For more information, see [Volume Groups](https://docs.oracle.com/iaas/Content/Block/Concepts/volumegroups.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListVolumeGroupBackupsRequest * @return ListVolumeGroupBackupsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListVolumeGroupBackups.ts.html |here} to see how to use ListVolumeGroupBackups API. */ listVolumeGroupBackups(listVolumeGroupBackupsRequest: requests.ListVolumeGroupBackupsRequest): Promise; /** * NOTE: This function is deprecated in favor of listVolumeGroupBackupsRecordIterator function. * Creates a new async iterator which will iterate over the models.VolumeGroupBackup objects * contained in responses from the listVolumeGroupBackups operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllVolumeGroupBackups(request: requests.ListVolumeGroupBackupsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listVolumeGroupBackupsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listVolumeGroupBackups operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllVolumeGroupBackupsResponses(request: requests.ListVolumeGroupBackupsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.VolumeGroupBackup objects * contained in responses from the listVolumeGroupBackups operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listVolumeGroupBackupsRecordIterator(request: requests.ListVolumeGroupBackupsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listVolumeGroupBackups operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listVolumeGroupBackupsResponseIterator(request: requests.ListVolumeGroupBackupsRequest): AsyncIterableIterator; /** * Lists the volume group replicas in the specified compartment. You can filter the results by volume group. * For more information, see [Volume Group Replication](https://docs.oracle.com/iaas/Content/Block/Concepts/volumegroupreplication.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListVolumeGroupReplicasRequest * @return ListVolumeGroupReplicasResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListVolumeGroupReplicas.ts.html |here} to see how to use ListVolumeGroupReplicas API. */ listVolumeGroupReplicas(listVolumeGroupReplicasRequest: requests.ListVolumeGroupReplicasRequest): Promise; /** * NOTE: This function is deprecated in favor of listVolumeGroupReplicasRecordIterator function. * Creates a new async iterator which will iterate over the models.VolumeGroupReplica objects * contained in responses from the listVolumeGroupReplicas operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllVolumeGroupReplicas(request: requests.ListVolumeGroupReplicasRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listVolumeGroupReplicasResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listVolumeGroupReplicas operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllVolumeGroupReplicasResponses(request: requests.ListVolumeGroupReplicasRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.VolumeGroupReplica objects * contained in responses from the listVolumeGroupReplicas operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listVolumeGroupReplicasRecordIterator(request: requests.ListVolumeGroupReplicasRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listVolumeGroupReplicas operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listVolumeGroupReplicasResponseIterator(request: requests.ListVolumeGroupReplicasRequest): AsyncIterableIterator; /** * Lists the volume groups in the specified compartment and availability domain. * For more information, see [Volume Groups](https://docs.oracle.com/iaas/Content/Block/Concepts/volumegroups.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListVolumeGroupsRequest * @return ListVolumeGroupsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListVolumeGroups.ts.html |here} to see how to use ListVolumeGroups API. */ listVolumeGroups(listVolumeGroupsRequest: requests.ListVolumeGroupsRequest): Promise; /** * NOTE: This function is deprecated in favor of listVolumeGroupsRecordIterator function. * Creates a new async iterator which will iterate over the models.VolumeGroup objects * contained in responses from the listVolumeGroups operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllVolumeGroups(request: requests.ListVolumeGroupsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listVolumeGroupsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listVolumeGroups operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllVolumeGroupsResponses(request: requests.ListVolumeGroupsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.VolumeGroup objects * contained in responses from the listVolumeGroups operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listVolumeGroupsRecordIterator(request: requests.ListVolumeGroupsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listVolumeGroups operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listVolumeGroupsResponseIterator(request: requests.ListVolumeGroupsRequest): AsyncIterableIterator; /** * Lists the volumes in the specified compartment and availability domain. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListVolumesRequest * @return ListVolumesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListVolumes.ts.html |here} to see how to use ListVolumes API. */ listVolumes(listVolumesRequest: requests.ListVolumesRequest): Promise; /** * NOTE: This function is deprecated in favor of listVolumesRecordIterator function. * Creates a new async iterator which will iterate over the models.Volume objects * contained in responses from the listVolumes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllVolumes(request: requests.ListVolumesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listVolumesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listVolumes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllVolumesResponses(request: requests.ListVolumesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.Volume objects * contained in responses from the listVolumes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listVolumesRecordIterator(request: requests.ListVolumesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listVolumes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listVolumesResponseIterator(request: requests.ListVolumesRequest): AsyncIterableIterator; /** * Updates the specified boot volume's display name, defined tags, and free-form tags. * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateBootVolumeRequest * @return UpdateBootVolumeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateBootVolume.ts.html |here} to see how to use UpdateBootVolume API. */ updateBootVolume(updateBootVolumeRequest: requests.UpdateBootVolumeRequest): Promise; /** * Updates the display name for the specified boot volume backup. * Avoid entering confidential information. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateBootVolumeBackupRequest * @return UpdateBootVolumeBackupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateBootVolumeBackup.ts.html |here} to see how to use UpdateBootVolumeBackup API. */ updateBootVolumeBackup(updateBootVolumeBackupRequest: requests.UpdateBootVolumeBackupRequest): Promise; /** * Updates the specified volume with a new Vault service master encryption key. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateBootVolumeKmsKeyRequest * @return UpdateBootVolumeKmsKeyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateBootVolumeKmsKey.ts.html |here} to see how to use UpdateBootVolumeKmsKey API. */ updateBootVolumeKmsKey(updateBootVolumeKmsKeyRequest: requests.UpdateBootVolumeKmsKeyRequest): Promise; /** * Updates the specified volume's display name. * Avoid entering confidential information. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateVolumeRequest * @return UpdateVolumeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateVolume.ts.html |here} to see how to use UpdateVolume API. */ updateVolume(updateVolumeRequest: requests.UpdateVolumeRequest): Promise; /** * Updates the display name for the specified volume backup. * Avoid entering confidential information. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateVolumeBackupRequest * @return UpdateVolumeBackupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateVolumeBackup.ts.html |here} to see how to use UpdateVolumeBackup API. */ updateVolumeBackup(updateVolumeBackupRequest: requests.UpdateVolumeBackupRequest): Promise; /** * Updates a user defined backup policy. * For more information about user defined backup policies, * see [Policy-Based Backups](https://docs.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#UserDefinedBackupPolicies). *

Avoid entering confidential information. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateVolumeBackupPolicyRequest * @return UpdateVolumeBackupPolicyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateVolumeBackupPolicy.ts.html |here} to see how to use UpdateVolumeBackupPolicy API. */ updateVolumeBackupPolicy(updateVolumeBackupPolicyRequest: requests.UpdateVolumeBackupPolicyRequest): Promise; /** * Updates the set of volumes in a volume group along with the display name. Use this operation * to add or remove volumes in a volume group. Specify the full list of volume IDs to include in the * volume group. If the volume ID is not specified in the call, it will be removed from the volume group. * Avoid entering confidential information. *

For more information, see [Volume Groups](https://docs.oracle.com/iaas/Content/Block/Concepts/volumegroups.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateVolumeGroupRequest * @return UpdateVolumeGroupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateVolumeGroup.ts.html |here} to see how to use UpdateVolumeGroup API. */ updateVolumeGroup(updateVolumeGroupRequest: requests.UpdateVolumeGroupRequest): Promise; /** * Updates the display name for the specified volume group backup. For more information, see [Volume Groups](https://docs.oracle.com/iaas/Content/Block/Concepts/volumegroups.htm). * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateVolumeGroupBackupRequest * @return UpdateVolumeGroupBackupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateVolumeGroupBackup.ts.html |here} to see how to use UpdateVolumeGroupBackup API. */ updateVolumeGroupBackup(updateVolumeGroupBackupRequest: requests.UpdateVolumeGroupBackupRequest): Promise; /** * Updates the specified volume with a new Key Management master encryption key. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateVolumeKmsKeyRequest * @return UpdateVolumeKmsKeyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateVolumeKmsKey.ts.html |here} to see how to use UpdateVolumeKmsKey API. */ updateVolumeKmsKey(updateVolumeKmsKeyRequest: requests.UpdateVolumeKmsKeyRequest): Promise; } export declare enum ComputeApiKeys { } /** * This service client does not use circuit breakers by default if the user has not defined a circuit breaker configuration. */ export declare class ComputeClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_waiters": ComputeWaiter; protected "_clientConfiguration": common.ClientConfiguration; protected _circuitBreaker: typeof Breaker | null; protected _httpOptions: any; protected _bodyDuplexMode: any; targetService: string; protected _regionId: string; protected "_region": common.Region; protected _lastSetRegionOrRegionId: string; protected _enableDualstackEndpoint: boolean | undefined; protected _serviceUsesDualStackByDefault: boolean; protected _httpClient: common.HttpClient; protected _authProvider: common.AuthenticationDetailsProvider | undefined; constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration); /** * Get the endpoint that is being used to call (ex, https://www.example.com). */ get endpoint(): string; /** * Sets the endpoint to call (ex, https://www.example.com). * @param endpoint The endpoint of the service. */ set endpoint(endpoint: string); get logger(): import("oci-common/lib/log").Logger; /** * Determines whether realm specific endpoint should be used or not. * Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false" * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template */ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean); /** * Sets the region to call (ex, Region.US_PHOENIX_1). * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint. * @param region The region of the service. */ set region(region: common.Region); /** * Sets the regionId to call (ex, 'us-phoenix-1'). * * Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. * If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 * and then call {@link #endpoint(String) endpoint}. * @param regionId The public region ID. */ set regionId(regionId: string); set enableDualstackEndpoint(enableDualstackEndpoint: boolean); /** * Creates a new ComputeWaiter for resources for this service. * * @param workRequestClient The work request service client used to query for work request status * @param config The waiter configuration for termination and delay strategy * @return The service waiters. */ createWaiters(workRequestClient: WorkRequestClient, config?: common.WaiterConfiguration): ComputeWaiter; /** * Gets the waiters available for resources for this service. * * @return The service waiters. */ getWaiters(): ComputeWaiter; /** * Shutdown the circuit breaker used by the client when it is no longer needed */ shutdownCircuitBreaker(): void; /** * Close the provider if possible which in turn shuts down any associated circuit breaker */ closeProvider(): void; /** * Close the client once it is no longer needed */ close(): void; /** * Accept the changes to the PCR values in the measured boot report. * This operation does not retry by default if the user has not defined a retry configuration. * @param AcceptShieldedIntegrityPolicyRequest * @return AcceptShieldedIntegrityPolicyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/AcceptShieldedIntegrityPolicy.ts.html |here} to see how to use AcceptShieldedIntegrityPolicy API. */ acceptShieldedIntegrityPolicy(acceptShieldedIntegrityPolicyRequest: requests.AcceptShieldedIntegrityPolicyRequest): Promise; /** * Adds a shape to the compatible shapes list for the image. * This operation does not retry by default if the user has not defined a retry configuration. * @param AddImageShapeCompatibilityEntryRequest * @return AddImageShapeCompatibilityEntryResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/AddImageShapeCompatibilityEntry.ts.html |here} to see how to use AddImageShapeCompatibilityEntry API. */ addImageShapeCompatibilityEntry(addImageShapeCompatibilityEntryRequest: requests.AddImageShapeCompatibilityEntryRequest): Promise; /** * Triggers the asynchronous process that applies the host's target configuration * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ApplyHostConfigurationRequest * @return ApplyHostConfigurationResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ApplyHostConfiguration.ts.html |here} to see how to use ApplyHostConfiguration API. */ applyHostConfiguration(applyHostConfigurationRequest: requests.ApplyHostConfigurationRequest): Promise; /** * Attaches the specified boot volume to the specified instance. * * This operation does not retry by default if the user has not defined a retry configuration. * @param AttachBootVolumeRequest * @return AttachBootVolumeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/AttachBootVolume.ts.html |here} to see how to use AttachBootVolume API. */ attachBootVolume(attachBootVolumeRequest: requests.AttachBootVolumeRequest): Promise; /** * Attaches the Compute BM Host to a Host group * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param AttachComputeHostGroupHostRequest * @return AttachComputeHostGroupHostResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/AttachComputeHostGroupHost.ts.html |here} to see how to use AttachComputeHostGroupHost API. */ attachComputeHostGroupHost(attachComputeHostGroupHostRequest: requests.AttachComputeHostGroupHostRequest): Promise; /** * Creates a secondary VNIC and attaches it to the specified instance. * For more information about secondary VNICs, see * [Virtual Network Interface Cards (VNICs)](https://docs.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param AttachVnicRequest * @return AttachVnicResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/AttachVnic.ts.html |here} to see how to use AttachVnic API. */ attachVnic(attachVnicRequest: requests.AttachVnicRequest): Promise; /** * Attaches the specified storage volume to the specified instance. * * This operation does not retry by default if the user has not defined a retry configuration. * @param AttachVolumeRequest * @return AttachVolumeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/AttachVolume.ts.html |here} to see how to use AttachVolume API. */ attachVolume(attachVolumeRequest: requests.AttachVolumeRequest): Promise; /** * Captures the most recent serial console data (up to a megabyte) for the * specified instance. *

The `CaptureConsoleHistory` operation works with the other console history operations * as described below. *

1. Use `CaptureConsoleHistory` to request the capture of up to a megabyte of the * most recent console history. This call returns a `ConsoleHistory` * object. The object will have a state of REQUESTED. * 2. Wait for the capture operation to succeed by polling `GetConsoleHistory` with * the identifier of the console history metadata. The state of the * `ConsoleHistory` object will go from REQUESTED to GETTING-HISTORY and * then SUCCEEDED (or FAILED). * 3. Use `GetConsoleHistoryContent` to get the actual console history data (not the * metadata). * 4. Optionally, use `DeleteConsoleHistory` to delete the console history metadata * and the console history data. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CaptureConsoleHistoryRequest * @return CaptureConsoleHistoryResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CaptureConsoleHistory.ts.html |here} to see how to use CaptureConsoleHistory API. */ captureConsoleHistory(captureConsoleHistoryRequest: requests.CaptureConsoleHistoryRequest): Promise; /** * Moves a compute capacity reservation into a different compartment. For information about * moving resources between compartments, see * [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeComputeCapacityReservationCompartmentRequest * @return ChangeComputeCapacityReservationCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeComputeCapacityReservationCompartment.ts.html |here} to see how to use ChangeComputeCapacityReservationCompartment API. */ changeComputeCapacityReservationCompartment(changeComputeCapacityReservationCompartmentRequest: requests.ChangeComputeCapacityReservationCompartmentRequest): Promise; /** * Moves a compute capacity topology into a different compartment. For information about moving resources between * compartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ChangeComputeCapacityTopologyCompartmentRequest * @return ChangeComputeCapacityTopologyCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeComputeCapacityTopologyCompartment.ts.html |here} to see how to use ChangeComputeCapacityTopologyCompartment API. */ changeComputeCapacityTopologyCompartment(changeComputeCapacityTopologyCompartmentRequest: requests.ChangeComputeCapacityTopologyCompartmentRequest): Promise; /** * Moves a compute cluster into a different compartment within the same tenancy. * A [compute cluster](https://docs.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory access (RDMA) network group. *

For information about moving resources between compartments, see * [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeComputeClusterCompartmentRequest * @return ChangeComputeClusterCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeComputeClusterCompartment.ts.html |here} to see how to use ChangeComputeClusterCompartment API. */ changeComputeClusterCompartment(changeComputeClusterCompartmentRequest: requests.ChangeComputeClusterCompartmentRequest): Promise; /** * Moves a compute GPU memory cluster into a different compartment. For information about moving resources between * compartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ChangeComputeGpuMemoryClusterCompartmentRequest * @return ChangeComputeGpuMemoryClusterCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeComputeGpuMemoryClusterCompartment.ts.html |here} to see how to use ChangeComputeGpuMemoryClusterCompartment API. */ changeComputeGpuMemoryClusterCompartment(changeComputeGpuMemoryClusterCompartmentRequest: requests.ChangeComputeGpuMemoryClusterCompartmentRequest): Promise; /** * Moves a compute GPU memory fabric into a different compartment. For information about moving resources between * compartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ChangeComputeGpuMemoryFabricCompartmentRequest * @return ChangeComputeGpuMemoryFabricCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeComputeGpuMemoryFabricCompartment.ts.html |here} to see how to use ChangeComputeGpuMemoryFabricCompartment API. */ changeComputeGpuMemoryFabricCompartment(changeComputeGpuMemoryFabricCompartmentRequest: requests.ChangeComputeGpuMemoryFabricCompartmentRequest): Promise; /** * Moves a compute host into a different compartment. For information about moving resources between * compartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ChangeComputeHostCompartmentRequest * @return ChangeComputeHostCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeComputeHostCompartment.ts.html |here} to see how to use ChangeComputeHostCompartment API. */ changeComputeHostCompartment(changeComputeHostCompartmentRequest: requests.ChangeComputeHostCompartmentRequest): Promise; /** * Moves a compute host group into a different compartment. For information about moving resources between * compartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ChangeComputeHostGroupCompartmentRequest * @return ChangeComputeHostGroupCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeComputeHostGroupCompartment.ts.html |here} to see how to use ChangeComputeHostGroupCompartment API. */ changeComputeHostGroupCompartment(changeComputeHostGroupCompartmentRequest: requests.ChangeComputeHostGroupCompartmentRequest): Promise; /** * Moves a compute image capability schema into a different compartment within the same tenancy. * For information about moving resources between compartments, see * [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ChangeComputeImageCapabilitySchemaCompartmentRequest * @return ChangeComputeImageCapabilitySchemaCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeComputeImageCapabilitySchemaCompartment.ts.html |here} to see how to use ChangeComputeImageCapabilitySchemaCompartment API. */ changeComputeImageCapabilitySchemaCompartment(changeComputeImageCapabilitySchemaCompartmentRequest: requests.ChangeComputeImageCapabilitySchemaCompartmentRequest): Promise; /** * Moves a dedicated virtual machine host from one compartment to another. * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeDedicatedVmHostCompartmentRequest * @return ChangeDedicatedVmHostCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeDedicatedVmHostCompartment.ts.html |here} to see how to use ChangeDedicatedVmHostCompartment API. */ changeDedicatedVmHostCompartment(changeDedicatedVmHostCompartmentRequest: requests.ChangeDedicatedVmHostCompartmentRequest): Promise; /** * Moves an image into a different compartment within the same tenancy. For information about moving * resources between compartments, see * [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ChangeImageCompartmentRequest * @return ChangeImageCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeImageCompartment.ts.html |here} to see how to use ChangeImageCompartment API. */ changeImageCompartment(changeImageCompartmentRequest: requests.ChangeImageCompartmentRequest): Promise; /** * Moves an instance into a different compartment within the same tenancy. For information about * moving resources between compartments, see * [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). *

When you move an instance to a different compartment, associated resources such as boot volumes and VNICs * are not moved. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeInstanceCompartmentRequest * @return ChangeInstanceCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeInstanceCompartment.ts.html |here} to see how to use ChangeInstanceCompartment API. */ changeInstanceCompartment(changeInstanceCompartmentRequest: requests.ChangeInstanceCompartmentRequest): Promise; /** * Marks the host to be checked for conformance to its target configuration * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CheckHostConfigurationRequest * @return CheckHostConfigurationResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CheckHostConfiguration.ts.html |here} to see how to use CheckHostConfiguration API. */ checkHostConfiguration(checkHostConfigurationRequest: requests.CheckHostConfigurationRequest): Promise; /** * Create a subscription for listing resource version for a compartment. It will take some time to propagate to all regions. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateAppCatalogSubscriptionRequest * @return CreateAppCatalogSubscriptionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateAppCatalogSubscription.ts.html |here} to see how to use CreateAppCatalogSubscription API. */ createAppCatalogSubscription(createAppCatalogSubscriptionRequest: requests.CreateAppCatalogSubscriptionRequest): Promise; /** * Generates a report of the host capacity within an availability domain that is available for you * to create compute instances. Host capacity is the physical infrastructure that resources such as compute * instances run on. *

Use the capacity report to determine whether sufficient capacity is available for a shape before * you create an instance or change the shape of an instance. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateComputeCapacityReportRequest * @return CreateComputeCapacityReportResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateComputeCapacityReport.ts.html |here} to see how to use CreateComputeCapacityReport API. */ createComputeCapacityReport(createComputeCapacityReportRequest: requests.CreateComputeCapacityReportRequest): Promise; /** * Creates a new compute capacity reservation in the specified compartment and availability domain. * Compute capacity reservations let you reserve instances in a compartment. * When you launch an instance using this reservation, you are assured that you have enough space for your instance, * and you won't get out of capacity errors. * For more information, see [Reserved Capacity](https://docs.oracle.com/iaas/Content/Compute/Tasks/reserve-capacity.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateComputeCapacityReservationRequest * @return CreateComputeCapacityReservationResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateComputeCapacityReservation.ts.html |here} to see how to use CreateComputeCapacityReservation API. */ createComputeCapacityReservation(createComputeCapacityReservationRequest: requests.CreateComputeCapacityReservationRequest): Promise; /** * Creates a new compute capacity topology in the specified compartment and availability domain. *

Compute capacity topologies provide the RDMA network topology of your bare metal hosts so that you can launch * instances on your bare metal hosts with targeted network locations. *

Compute capacity topologies report the health status of your bare metal hosts. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateComputeCapacityTopologyRequest * @return CreateComputeCapacityTopologyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateComputeCapacityTopology.ts.html |here} to see how to use CreateComputeCapacityTopology API. */ createComputeCapacityTopology(createComputeCapacityTopologyRequest: requests.CreateComputeCapacityTopologyRequest): Promise; /** * Creates an empty [compute cluster](https://docs.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm). A compute cluster * is a remote direct memory access (RDMA) network group. *

After the compute cluster is created, you can use the compute cluster's OCID with the * {@link #launchInstance(LaunchInstanceRequest) launchInstance} operation to create instances in the compute cluster. * The instances must be created in the same compartment and availability domain as the cluster. *

Use compute clusters when you want to manage instances in the cluster individually in the RDMA network group. *

If you want predictable capacity for a specific number of identical instances that are managed as a group, * create a cluster network that uses instance pools by using the * {@link #createClusterNetwork(CreateClusterNetworkRequest) createClusterNetwork} operation. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateComputeClusterRequest * @return CreateComputeClusterResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateComputeCluster.ts.html |here} to see how to use CreateComputeCluster API. */ createComputeCluster(createComputeClusterRequest: requests.CreateComputeClusterRequest): Promise; /** * Create a compute GPU memory cluster instance on a specific compute GPU memory fabric * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateComputeGpuMemoryClusterRequest * @return CreateComputeGpuMemoryClusterResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateComputeGpuMemoryCluster.ts.html |here} to see how to use CreateComputeGpuMemoryCluster API. */ createComputeGpuMemoryCluster(createComputeGpuMemoryClusterRequest: requests.CreateComputeGpuMemoryClusterRequest): Promise; /** * Creates a new compute host group in the specified compartment and availability domain. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateComputeHostGroupRequest * @return CreateComputeHostGroupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateComputeHostGroup.ts.html |here} to see how to use CreateComputeHostGroup API. */ createComputeHostGroup(createComputeHostGroupRequest: requests.CreateComputeHostGroupRequest): Promise; /** * Creates compute image capability schema. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateComputeImageCapabilitySchemaRequest * @return CreateComputeImageCapabilitySchemaResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateComputeImageCapabilitySchema.ts.html |here} to see how to use CreateComputeImageCapabilitySchema API. */ createComputeImageCapabilitySchema(createComputeImageCapabilitySchemaRequest: requests.CreateComputeImageCapabilitySchemaRequest): Promise; /** * Creates a new dedicated virtual machine host in the specified compartment and the specified availability domain. * Dedicated virtual machine hosts enable you to run your Compute virtual machine (VM) instances on dedicated servers * that are a single tenant and not shared with other customers. * For more information, see [Dedicated Virtual Machine Hosts](https://docs.oracle.com/iaas/Content/Compute/Concepts/dedicatedvmhosts.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateDedicatedVmHostRequest * @return CreateDedicatedVmHostResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateDedicatedVmHost.ts.html |here} to see how to use CreateDedicatedVmHost API. */ createDedicatedVmHost(createDedicatedVmHostRequest: requests.CreateDedicatedVmHostRequest): Promise; /** * Creates a boot disk image for the specified instance or imports an exported image from the Oracle Cloud Infrastructure Object Storage service. *

When creating a new image, you must provide the OCID of the instance you want to use as the basis for the image, and * the OCID of the compartment containing that instance. For more information about images, * see [Managing Custom Images](https://docs.oracle.com/iaas/Content/Compute/Tasks/managingcustomimages.htm). *

When importing an exported image from Object Storage, you specify the source information * in {@link #imageSourceDetails(ImageSourceDetailsRequest) imageSourceDetails}. *

When importing an image based on the namespace, bucket name, and object name, * use {@link #imageSourceViaObjectStorageTupleDetails(ImageSourceViaObjectStorageTupleDetailsRequest) imageSourceViaObjectStorageTupleDetails}. *

When importing an image based on the Object Storage URL, use * {@link #imageSourceViaObjectStorageUriDetails(ImageSourceViaObjectStorageUriDetailsRequest) imageSourceViaObjectStorageUriDetails}. * See [Object Storage URLs](https://docs.oracle.com/iaas/Content/Compute/Tasks/imageimportexport.htm#URLs) and [Using Pre-Authenticated Requests](https://docs.oracle.com/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm) * for constructing URLs for image import/export. *

For more information about importing exported images, see * [Image Import/Export](https://docs.oracle.com/iaas/Content/Compute/Tasks/imageimportexport.htm). *

You may optionally specify a *display name* for the image, which is simply a friendly name or description. * It does not have to be unique, and you can change it. See {@link #updateImage(UpdateImageRequest) updateImage}. * Avoid entering confidential information. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateImageRequest * @return CreateImageResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateImage.ts.html |here} to see how to use CreateImage API. */ createImage(createImageRequest: requests.CreateImageRequest): Promise; /** * Creates a new console connection to the specified instance. * After the console connection has been created and is available, * you connect to the console using SSH. *

For more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](https://docs.oracle.com/iaas/Content/Compute/References/serialconsole.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateInstanceConsoleConnectionRequest * @return CreateInstanceConsoleConnectionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateInstanceConsoleConnection.ts.html |here} to see how to use CreateInstanceConsoleConnection API. */ createInstanceConsoleConnection(createInstanceConsoleConnectionRequest: requests.CreateInstanceConsoleConnectionRequest): Promise; /** * Delete a subscription for a listing resource version for a compartment. * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteAppCatalogSubscriptionRequest * @return DeleteAppCatalogSubscriptionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteAppCatalogSubscription.ts.html |here} to see how to use DeleteAppCatalogSubscription API. */ deleteAppCatalogSubscription(deleteAppCatalogSubscriptionRequest: requests.DeleteAppCatalogSubscriptionRequest): Promise; /** * Deletes the specified compute capacity reservation. * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteComputeCapacityReservationRequest * @return DeleteComputeCapacityReservationResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteComputeCapacityReservation.ts.html |here} to see how to use DeleteComputeCapacityReservation API. */ deleteComputeCapacityReservation(deleteComputeCapacityReservationRequest: requests.DeleteComputeCapacityReservationRequest): Promise; /** * Deletes the specified compute capacity topology. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param DeleteComputeCapacityTopologyRequest * @return DeleteComputeCapacityTopologyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteComputeCapacityTopology.ts.html |here} to see how to use DeleteComputeCapacityTopology API. */ deleteComputeCapacityTopology(deleteComputeCapacityTopologyRequest: requests.DeleteComputeCapacityTopologyRequest): Promise; /** * Deletes a compute cluster. A [compute cluster](https://docs.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm) is a * remote direct memory access (RDMA) network group. *

Before you delete a compute cluster, first delete all instances in the cluster by using * the {@link #terminateInstance(TerminateInstanceRequest) terminateInstance} operation. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteComputeClusterRequest * @return DeleteComputeClusterResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteComputeCluster.ts.html |here} to see how to use DeleteComputeCluster API. */ deleteComputeCluster(deleteComputeClusterRequest: requests.DeleteComputeClusterRequest): Promise; /** * Terminates and deletes the specified compute GPU memory cluster and underlying instances. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param DeleteComputeGpuMemoryClusterRequest * @return DeleteComputeGpuMemoryClusterResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteComputeGpuMemoryCluster.ts.html |here} to see how to use DeleteComputeGpuMemoryCluster API. */ deleteComputeGpuMemoryCluster(deleteComputeGpuMemoryClusterRequest: requests.DeleteComputeGpuMemoryClusterRequest): Promise; /** * Deletes the specified compute host group * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteComputeHostGroupRequest * @return DeleteComputeHostGroupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteComputeHostGroup.ts.html |here} to see how to use DeleteComputeHostGroup API. */ deleteComputeHostGroup(deleteComputeHostGroupRequest: requests.DeleteComputeHostGroupRequest): Promise; /** * Deletes the specified Compute Image Capability Schema * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteComputeImageCapabilitySchemaRequest * @return DeleteComputeImageCapabilitySchemaResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteComputeImageCapabilitySchema.ts.html |here} to see how to use DeleteComputeImageCapabilitySchema API. */ deleteComputeImageCapabilitySchema(deleteComputeImageCapabilitySchemaRequest: requests.DeleteComputeImageCapabilitySchemaRequest): Promise; /** * Deletes the specified console history metadata and the console history data. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteConsoleHistoryRequest * @return DeleteConsoleHistoryResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteConsoleHistory.ts.html |here} to see how to use DeleteConsoleHistory API. */ deleteConsoleHistory(deleteConsoleHistoryRequest: requests.DeleteConsoleHistoryRequest): Promise; /** * Deletes the specified dedicated virtual machine host. *

If any VM instances are assigned to the dedicated virtual machine host, * the delete operation will fail and the service will return a 409 response code. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteDedicatedVmHostRequest * @return DeleteDedicatedVmHostResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteDedicatedVmHost.ts.html |here} to see how to use DeleteDedicatedVmHost API. */ deleteDedicatedVmHost(deleteDedicatedVmHostRequest: requests.DeleteDedicatedVmHostRequest): Promise; /** * Deletes an image. * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteImageRequest * @return DeleteImageResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteImage.ts.html |here} to see how to use DeleteImage API. */ deleteImage(deleteImageRequest: requests.DeleteImageRequest): Promise; /** * Deletes the specified instance console connection. * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteInstanceConsoleConnectionRequest * @return DeleteInstanceConsoleConnectionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteInstanceConsoleConnection.ts.html |here} to see how to use DeleteInstanceConsoleConnection API. */ deleteInstanceConsoleConnection(deleteInstanceConsoleConnectionRequest: requests.DeleteInstanceConsoleConnectionRequest): Promise; /** * Detaches a boot volume from an instance. You must specify the OCID of the boot volume attachment. *

This is an asynchronous operation. The attachment's `lifecycleState` will change to DETACHING temporarily * until the attachment is completely removed. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DetachBootVolumeRequest * @return DetachBootVolumeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DetachBootVolume.ts.html |here} to see how to use DetachBootVolume API. */ detachBootVolume(detachBootVolumeRequest: requests.DetachBootVolumeRequest): Promise; /** * Detaches the specified bare metal host from the compute host group * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param DetachComputeHostGroupHostRequest * @return DetachComputeHostGroupHostResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DetachComputeHostGroupHost.ts.html |here} to see how to use DetachComputeHostGroupHost API. */ detachComputeHostGroupHost(detachComputeHostGroupHostRequest: requests.DetachComputeHostGroupHostRequest): Promise; /** * Detaches and deletes the specified secondary VNIC. * This operation cannot be used on the instance's primary VNIC. * When you terminate an instance, all attached VNICs (primary * and secondary) are automatically detached and deleted. *

**Important:** If the VNIC has a * {@link PrivateIp} that is the * [target of a route rule](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip), * deleting the VNIC causes that route rule to blackhole and the traffic * will be dropped. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DetachVnicRequest * @return DetachVnicResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DetachVnic.ts.html |here} to see how to use DetachVnic API. */ detachVnic(detachVnicRequest: requests.DetachVnicRequest): Promise; /** * Detaches a storage volume from an instance. You must specify the OCID of the volume attachment. *

This is an asynchronous operation. The attachment's `lifecycleState` will change to DETACHING temporarily * until the attachment is completely removed. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DetachVolumeRequest * @return DetachVolumeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DetachVolume.ts.html |here} to see how to use DetachVolume API. */ detachVolume(detachVolumeRequest: requests.DetachVolumeRequest): Promise; /** * Exports the specified image to the Oracle Cloud Infrastructure Object Storage service. You can use the Object Storage URL, * or the namespace, bucket name, and object name when specifying the location to export to. *

For more information about exporting images, see [Image Import/Export](https://docs.oracle.com/iaas/Content/Compute/Tasks/imageimportexport.htm). *

To perform an image export, you need write access to the Object Storage bucket for the image, * see [Let Users Write Objects to Object Storage Buckets](https://docs.oracle.com/iaas/Content/Identity/Concepts/commonpolicies.htm#Let4). *

See [Object Storage URLs](https://docs.oracle.com/iaas/Content/Compute/Tasks/imageimportexport.htm#URLs) and [Using Pre-Authenticated Requests](https://docs.oracle.com/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm) * for constructing URLs for image import/export. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ExportImageRequest * @return ExportImageResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ExportImage.ts.html |here} to see how to use ExportImage API. */ exportImage(exportImageRequest: requests.ExportImageRequest): Promise; /** * Gets the specified listing. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetAppCatalogListingRequest * @return GetAppCatalogListingResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetAppCatalogListing.ts.html |here} to see how to use GetAppCatalogListing API. */ getAppCatalogListing(getAppCatalogListingRequest: requests.GetAppCatalogListingRequest): Promise; /** * Retrieves the agreements for a particular resource version of a listing. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetAppCatalogListingAgreementsRequest * @return GetAppCatalogListingAgreementsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetAppCatalogListingAgreements.ts.html |here} to see how to use GetAppCatalogListingAgreements API. */ getAppCatalogListingAgreements(getAppCatalogListingAgreementsRequest: requests.GetAppCatalogListingAgreementsRequest): Promise; /** * Gets the specified listing resource version. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetAppCatalogListingResourceVersionRequest * @return GetAppCatalogListingResourceVersionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetAppCatalogListingResourceVersion.ts.html |here} to see how to use GetAppCatalogListingResourceVersion API. */ getAppCatalogListingResourceVersion(getAppCatalogListingResourceVersionRequest: requests.GetAppCatalogListingResourceVersionRequest): Promise; /** * Gets information about the specified boot volume attachment. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetBootVolumeAttachmentRequest * @return GetBootVolumeAttachmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetBootVolumeAttachment.ts.html |here} to see how to use GetBootVolumeAttachment API. */ getBootVolumeAttachment(getBootVolumeAttachmentRequest: requests.GetBootVolumeAttachmentRequest): Promise; /** * Gets information about the specified compute capacity reservation. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetComputeCapacityReservationRequest * @return GetComputeCapacityReservationResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetComputeCapacityReservation.ts.html |here} to see how to use GetComputeCapacityReservation API. */ getComputeCapacityReservation(getComputeCapacityReservationRequest: requests.GetComputeCapacityReservationRequest): Promise; /** * Gets information about the specified compute capacity topology. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetComputeCapacityTopologyRequest * @return GetComputeCapacityTopologyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetComputeCapacityTopology.ts.html |here} to see how to use GetComputeCapacityTopology API. */ getComputeCapacityTopology(getComputeCapacityTopologyRequest: requests.GetComputeCapacityTopologyRequest): Promise; /** * Gets information about a compute cluster. A [compute cluster](https://docs.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm) * is a remote direct memory access (RDMA) network group. * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetComputeClusterRequest * @return GetComputeClusterResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetComputeCluster.ts.html |here} to see how to use GetComputeCluster API. */ getComputeCluster(getComputeClusterRequest: requests.GetComputeClusterRequest): Promise; /** * Gets the specified Compute Global Image Capability Schema * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetComputeGlobalImageCapabilitySchemaRequest * @return GetComputeGlobalImageCapabilitySchemaResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetComputeGlobalImageCapabilitySchema.ts.html |here} to see how to use GetComputeGlobalImageCapabilitySchema API. */ getComputeGlobalImageCapabilitySchema(getComputeGlobalImageCapabilitySchemaRequest: requests.GetComputeGlobalImageCapabilitySchemaRequest): Promise; /** * Gets the specified Compute Global Image Capability Schema Version * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetComputeGlobalImageCapabilitySchemaVersionRequest * @return GetComputeGlobalImageCapabilitySchemaVersionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetComputeGlobalImageCapabilitySchemaVersion.ts.html |here} to see how to use GetComputeGlobalImageCapabilitySchemaVersion API. */ getComputeGlobalImageCapabilitySchemaVersion(getComputeGlobalImageCapabilitySchemaVersionRequest: requests.GetComputeGlobalImageCapabilitySchemaVersionRequest): Promise; /** * Gets information about the specified compute GPU memory cluster * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetComputeGpuMemoryClusterRequest * @return GetComputeGpuMemoryClusterResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetComputeGpuMemoryCluster.ts.html |here} to see how to use GetComputeGpuMemoryCluster API. */ getComputeGpuMemoryCluster(getComputeGpuMemoryClusterRequest: requests.GetComputeGpuMemoryClusterRequest): Promise; /** * Gets information about the specified compute GPU memory fabric * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetComputeGpuMemoryFabricRequest * @return GetComputeGpuMemoryFabricResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetComputeGpuMemoryFabric.ts.html |here} to see how to use GetComputeGpuMemoryFabric API. */ getComputeGpuMemoryFabric(getComputeGpuMemoryFabricRequest: requests.GetComputeGpuMemoryFabricRequest): Promise; /** * Gets information about the specified compute host * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetComputeHostRequest * @return GetComputeHostResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetComputeHost.ts.html |here} to see how to use GetComputeHost API. */ getComputeHost(getComputeHostRequest: requests.GetComputeHostRequest): Promise; /** * Gets information about the specified compute host group * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetComputeHostGroupRequest * @return GetComputeHostGroupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetComputeHostGroup.ts.html |here} to see how to use GetComputeHostGroup API. */ getComputeHostGroup(getComputeHostGroupRequest: requests.GetComputeHostGroupRequest): Promise; /** * Gets the specified Compute Image Capability Schema * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetComputeImageCapabilitySchemaRequest * @return GetComputeImageCapabilitySchemaResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetComputeImageCapabilitySchema.ts.html |here} to see how to use GetComputeImageCapabilitySchema API. */ getComputeImageCapabilitySchema(getComputeImageCapabilitySchemaRequest: requests.GetComputeImageCapabilitySchemaRequest): Promise; /** * Shows the metadata for the specified console history. * See {@link #captureConsoleHistory(CaptureConsoleHistoryRequest) captureConsoleHistory} * for details about using the console history operations. * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetConsoleHistoryRequest * @return GetConsoleHistoryResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetConsoleHistory.ts.html |here} to see how to use GetConsoleHistory API. */ getConsoleHistory(getConsoleHistoryRequest: requests.GetConsoleHistoryRequest): Promise; /** * Gets the actual console history data (not the metadata). * See {@link #captureConsoleHistory(CaptureConsoleHistoryRequest) captureConsoleHistory} * for details about using the console history operations. * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetConsoleHistoryContentRequest * @return GetConsoleHistoryContentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetConsoleHistoryContent.ts.html |here} to see how to use GetConsoleHistoryContent API. */ getConsoleHistoryContent(getConsoleHistoryContentRequest: requests.GetConsoleHistoryContentRequest): Promise; /** * Gets information about the specified dedicated virtual machine host. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetDedicatedVmHostRequest * @return GetDedicatedVmHostResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetDedicatedVmHost.ts.html |here} to see how to use GetDedicatedVmHost API. */ getDedicatedVmHost(getDedicatedVmHostRequest: requests.GetDedicatedVmHostRequest): Promise; /** * Returns the Firmware Bundle matching the provided firmwareBundleId. * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetFirmwareBundleRequest * @return GetFirmwareBundleResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetFirmwareBundle.ts.html |here} to see how to use GetFirmwareBundle API. */ getFirmwareBundle(getFirmwareBundleRequest: requests.GetFirmwareBundleRequest): Promise; /** * Gets the specified image. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetImageRequest * @return GetImageResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetImage.ts.html |here} to see how to use GetImage API. */ getImage(getImageRequest: requests.GetImageRequest): Promise; /** * Retrieves an image shape compatibility entry. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetImageShapeCompatibilityEntryRequest * @return GetImageShapeCompatibilityEntryResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetImageShapeCompatibilityEntry.ts.html |here} to see how to use GetImageShapeCompatibilityEntry API. */ getImageShapeCompatibilityEntry(getImageShapeCompatibilityEntryRequest: requests.GetImageShapeCompatibilityEntryRequest): Promise; /** * Gets information about the specified instance. *

**Note:** To retrieve public and private IP addresses for an instance, use the {@link #listVnicAttachments(ListVnicAttachmentsRequest) listVnicAttachments} * operation to get the VNIC ID for the instance, and then call {@link #getVnic(GetVnicRequest) getVnic} with the VNIC ID. * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetInstanceRequest * @return GetInstanceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetInstance.ts.html |here} to see how to use GetInstance API. */ getInstance(getInstanceRequest: requests.GetInstanceRequest): Promise; /** * Gets the specified instance console connection's information. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetInstanceConsoleConnectionRequest * @return GetInstanceConsoleConnectionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetInstanceConsoleConnection.ts.html |here} to see how to use GetInstanceConsoleConnection API. */ getInstanceConsoleConnection(getInstanceConsoleConnectionRequest: requests.GetInstanceConsoleConnectionRequest): Promise; /** * Gets the maintenance event for the given instance. * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetInstanceMaintenanceEventRequest * @return GetInstanceMaintenanceEventResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetInstanceMaintenanceEvent.ts.html |here} to see how to use GetInstanceMaintenanceEvent API. */ getInstanceMaintenanceEvent(getInstanceMaintenanceEventRequest: requests.GetInstanceMaintenanceEventRequest): Promise; /** * Gets the maximum possible date that a maintenance reboot can be extended. For more information, see * [Infrastructure Maintenance](https://docs.oracle.com/iaas/Content/Compute/References/infrastructure-maintenance.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetInstanceMaintenanceRebootRequest * @return GetInstanceMaintenanceRebootResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetInstanceMaintenanceReboot.ts.html |here} to see how to use GetInstanceMaintenanceReboot API. */ getInstanceMaintenanceReboot(getInstanceMaintenanceRebootRequest: requests.GetInstanceMaintenanceRebootRequest): Promise; /** * Gets the measured boot report for this shielded instance. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetMeasuredBootReportRequest * @return GetMeasuredBootReportResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetMeasuredBootReport.ts.html |here} to see how to use GetMeasuredBootReport API. */ getMeasuredBootReport(getMeasuredBootReportRequest: requests.GetMeasuredBootReportRequest): Promise; /** * Gets the information for the specified VNIC attachment. * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetVnicAttachmentRequest * @return GetVnicAttachmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetVnicAttachment.ts.html |here} to see how to use GetVnicAttachment API. */ getVnicAttachment(getVnicAttachmentRequest: requests.GetVnicAttachmentRequest): Promise; /** * Gets information about the specified volume attachment. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetVolumeAttachmentRequest * @return GetVolumeAttachmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetVolumeAttachment.ts.html |here} to see how to use GetVolumeAttachment API. */ getVolumeAttachment(getVolumeAttachmentRequest: requests.GetVolumeAttachmentRequest): Promise; /** * Gets the generated credentials for the instance. Only works for instances that require a password to log in, such as Windows. * For certain operating systems, users will be forced to change the initial credentials. * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetWindowsInstanceInitialCredentialsRequest * @return GetWindowsInstanceInitialCredentialsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetWindowsInstanceInitialCredentials.ts.html |here} to see how to use GetWindowsInstanceInitialCredentials API. */ getWindowsInstanceInitialCredentials(getWindowsInstanceInitialCredentialsRequest: requests.GetWindowsInstanceInitialCredentialsRequest): Promise; /** * Performs one of the following power actions on the specified instance: *

- **START** - Powers on the instance. *

- **STOP** - Powers off the instance. *

- **RESET** - Powers off the instance and then powers it back on. *

- **SOFTSTOP** - Gracefully shuts down the instance by sending a shutdown command to the operating system. * After waiting 15 minutes for the OS to shut down, the instance is powered off. * If the applications that run on the instance take more than 15 minutes to shut down, they could be improperly stopped, resulting * in data corruption. To avoid this, manually shut down the instance using the commands available in the OS before you softstop the * instance. *

- **SOFTRESET** - Gracefully reboots the instance by sending a shutdown command to the operating system. * After waiting 15 minutes for the OS to shut down, the instance is powered off and * then powered back on. *

* - **SENDDIAGNOSTICINTERRUPT** - For advanced users. **Caution: Sending a diagnostic interrupt to a live system can * cause data corruption or system failure.** Sends a diagnostic interrupt that causes the instance's * OS to crash and then reboot. Before you send a diagnostic interrupt, you must configure the instance to generate a * crash dump file when it crashes. The crash dump captures information about the state of the OS at the time of * the crash. After the OS restarts, you can analyze the crash dump to diagnose the issue. For more information, see * [Sending a Diagnostic Interrupt](https://docs.oracle.com/iaas/Content/Compute/Tasks/sendingdiagnosticinterrupt.htm). *

*

- **DIAGNOSTICREBOOT** - Powers off the instance, rebuilds it, and then powers it back on. * Before you send a diagnostic reboot, restart the instance's OS, confirm that the instance and networking settings are configured * correctly, and try other [troubleshooting steps](https://docs.oracle.com/iaas/Content/Compute/References/troubleshooting-compute-instances.htm). * Use diagnostic reboot as a final attempt to troubleshoot an unreachable instance. For virtual machine (VM) instances only. * For more information, see [Performing a Diagnostic Reboot](https://docs.oracle.com/iaas/Content/Compute/Tasks/diagnostic-reboot.htm). *

* - **REBOOTMIGRATE** - Powers off the instance, moves it to new hardware, and then powers it back on. For more information, see * [Infrastructure Maintenance](https://docs.oracle.com/iaas/Content/Compute/References/infrastructure-maintenance.htm). *

* For more information about managing instance lifecycle states, see * [Stopping and Starting an Instance](https://docs.oracle.com/iaas/Content/Compute/Tasks/restartinginstance.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param InstanceActionRequest * @return InstanceActionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/InstanceAction.ts.html |here} to see how to use InstanceAction API. */ instanceAction(instanceActionRequest: requests.InstanceActionRequest): Promise; /** * Creates a new instance in the specified compartment and the specified availability domain. * For general information about instances, see * [Overview of the Compute Service](https://docs.oracle.com/iaas/Content/Compute/Concepts/computeoverview.htm). *

For information about access control and compartments, see * [Overview of the IAM Service](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). *

For information about availability domains, see * [Regions and Availability Domains](https://docs.oracle.com/iaas/Content/General/Concepts/regions.htm). * To get a list of availability domains, use the `ListAvailabilityDomains` operation * in the Identity and Access Management Service API. *

All Oracle Cloud Infrastructure resources, including instances, get an Oracle-assigned, * unique ID called an Oracle Cloud Identifier (OCID). * When you create a resource, you can find its OCID in the response. You can * also retrieve a resource's OCID by using a List API operation * on that resource type, or by viewing the resource in the Console. *

To launch an instance using an image or a boot volume use the `sourceDetails` parameter in {@link LaunchInstanceDetails}. *

When you launch an instance, it is automatically attached to a virtual * network interface card (VNIC), called the *primary VNIC*. The VNIC * has a private IP address from the subnet's CIDR. You can either assign a * private IP address of your choice or let Oracle automatically assign one. * You can choose whether the instance has a public IP address. To retrieve the * addresses, use the {@link #listVnicAttachments(ListVnicAttachmentsRequest) listVnicAttachments} * operation to get the VNIC ID for the instance, and then call * {@link #getVnic(GetVnicRequest) getVnic} with the VNIC ID. *

You can later add secondary VNICs to an instance. For more information, see * [Virtual Network Interface Cards (VNICs)](https://docs.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm). *

To launch an instance from a Marketplace image listing, you must provide the image ID of the * listing resource version that you want, but you also must subscribe to the listing before you try * to launch the instance. To subscribe to the listing, use the {@link #getAppCatalogListingAgreements(GetAppCatalogListingAgreementsRequest) getAppCatalogListingAgreements} * operation to get the signature for the terms of use agreement for the desired listing resource version. * Then, call {@link #createAppCatalogSubscription(CreateAppCatalogSubscriptionRequest) createAppCatalogSubscription} * with the signature. To get the image ID for the LaunchInstance operation, call * {@link #getAppCatalogListingResourceVersion(GetAppCatalogListingResourceVersionRequest) getAppCatalogListingResourceVersion}. *

When launching an instance, you may provide the `securityAttributes` parameter in * {@link LaunchInstanceDetails} to manage security attributes via the instance, * or in the embedded {@link CreateVnicDetails} to manage security attributes * via the VNIC directly, but not both. Providing `securityAttributes` in both locations will return a * 400 Bad Request response. *

To determine whether capacity is available for a specific shape before you create an instance, * use the {@link #createComputeCapacityReport(CreateComputeCapacityReportRequest) createComputeCapacityReport} * operation. * * This operation does not retry by default if the user has not defined a retry configuration. * @param LaunchInstanceRequest * @return LaunchInstanceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/LaunchInstance.ts.html |here} to see how to use LaunchInstance API. */ launchInstance(launchInstanceRequest: requests.LaunchInstanceRequest): Promise; /** * Gets all resource versions for a particular listing. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListAppCatalogListingResourceVersionsRequest * @return ListAppCatalogListingResourceVersionsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListAppCatalogListingResourceVersions.ts.html |here} to see how to use ListAppCatalogListingResourceVersions API. */ listAppCatalogListingResourceVersions(listAppCatalogListingResourceVersionsRequest: requests.ListAppCatalogListingResourceVersionsRequest): Promise; /** * NOTE: This function is deprecated in favor of listAppCatalogListingResourceVersionsRecordIterator function. * Creates a new async iterator which will iterate over the models.AppCatalogListingResourceVersionSummary objects * contained in responses from the listAppCatalogListingResourceVersions operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllAppCatalogListingResourceVersions(request: requests.ListAppCatalogListingResourceVersionsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listAppCatalogListingResourceVersionsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listAppCatalogListingResourceVersions operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllAppCatalogListingResourceVersionsResponses(request: requests.ListAppCatalogListingResourceVersionsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.AppCatalogListingResourceVersionSummary objects * contained in responses from the listAppCatalogListingResourceVersions operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAppCatalogListingResourceVersionsRecordIterator(request: requests.ListAppCatalogListingResourceVersionsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listAppCatalogListingResourceVersions operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAppCatalogListingResourceVersionsResponseIterator(request: requests.ListAppCatalogListingResourceVersionsRequest): AsyncIterableIterator; /** * Lists the published listings. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListAppCatalogListingsRequest * @return ListAppCatalogListingsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListAppCatalogListings.ts.html |here} to see how to use ListAppCatalogListings API. */ listAppCatalogListings(listAppCatalogListingsRequest: requests.ListAppCatalogListingsRequest): Promise; /** * NOTE: This function is deprecated in favor of listAppCatalogListingsRecordIterator function. * Creates a new async iterator which will iterate over the models.AppCatalogListingSummary objects * contained in responses from the listAppCatalogListings operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllAppCatalogListings(request: requests.ListAppCatalogListingsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listAppCatalogListingsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listAppCatalogListings operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllAppCatalogListingsResponses(request: requests.ListAppCatalogListingsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.AppCatalogListingSummary objects * contained in responses from the listAppCatalogListings operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAppCatalogListingsRecordIterator(request: requests.ListAppCatalogListingsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listAppCatalogListings operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAppCatalogListingsResponseIterator(request: requests.ListAppCatalogListingsRequest): AsyncIterableIterator; /** * Lists subscriptions for a compartment. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListAppCatalogSubscriptionsRequest * @return ListAppCatalogSubscriptionsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListAppCatalogSubscriptions.ts.html |here} to see how to use ListAppCatalogSubscriptions API. */ listAppCatalogSubscriptions(listAppCatalogSubscriptionsRequest: requests.ListAppCatalogSubscriptionsRequest): Promise; /** * NOTE: This function is deprecated in favor of listAppCatalogSubscriptionsRecordIterator function. * Creates a new async iterator which will iterate over the models.AppCatalogSubscriptionSummary objects * contained in responses from the listAppCatalogSubscriptions operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllAppCatalogSubscriptions(request: requests.ListAppCatalogSubscriptionsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listAppCatalogSubscriptionsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listAppCatalogSubscriptions operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllAppCatalogSubscriptionsResponses(request: requests.ListAppCatalogSubscriptionsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.AppCatalogSubscriptionSummary objects * contained in responses from the listAppCatalogSubscriptions operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAppCatalogSubscriptionsRecordIterator(request: requests.ListAppCatalogSubscriptionsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listAppCatalogSubscriptions operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAppCatalogSubscriptionsResponseIterator(request: requests.ListAppCatalogSubscriptionsRequest): AsyncIterableIterator; /** * Lists the boot volume attachments in the specified compartment. You can filter the * list by specifying an instance OCID, boot volume OCID, or both. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListBootVolumeAttachmentsRequest * @return ListBootVolumeAttachmentsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListBootVolumeAttachments.ts.html |here} to see how to use ListBootVolumeAttachments API. */ listBootVolumeAttachments(listBootVolumeAttachmentsRequest: requests.ListBootVolumeAttachmentsRequest): Promise; /** * NOTE: This function is deprecated in favor of listBootVolumeAttachmentsRecordIterator function. * Creates a new async iterator which will iterate over the models.BootVolumeAttachment objects * contained in responses from the listBootVolumeAttachments operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllBootVolumeAttachments(request: requests.ListBootVolumeAttachmentsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listBootVolumeAttachmentsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listBootVolumeAttachments operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllBootVolumeAttachmentsResponses(request: requests.ListBootVolumeAttachmentsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.BootVolumeAttachment objects * contained in responses from the listBootVolumeAttachments operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listBootVolumeAttachmentsRecordIterator(request: requests.ListBootVolumeAttachmentsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listBootVolumeAttachments operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listBootVolumeAttachmentsResponseIterator(request: requests.ListBootVolumeAttachmentsRequest): AsyncIterableIterator; /** * Lists the shapes that can be reserved within the specified compartment. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListComputeCapacityReservationInstanceShapesRequest * @return ListComputeCapacityReservationInstanceShapesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListComputeCapacityReservationInstanceShapes.ts.html |here} to see how to use ListComputeCapacityReservationInstanceShapes API. */ listComputeCapacityReservationInstanceShapes(listComputeCapacityReservationInstanceShapesRequest: requests.ListComputeCapacityReservationInstanceShapesRequest): Promise; /** * NOTE: This function is deprecated in favor of listComputeCapacityReservationInstanceShapesRecordIterator function. * Creates a new async iterator which will iterate over the models.ComputeCapacityReservationInstanceShapeSummary objects * contained in responses from the listComputeCapacityReservationInstanceShapes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllComputeCapacityReservationInstanceShapes(request: requests.ListComputeCapacityReservationInstanceShapesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listComputeCapacityReservationInstanceShapesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listComputeCapacityReservationInstanceShapes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllComputeCapacityReservationInstanceShapesResponses(request: requests.ListComputeCapacityReservationInstanceShapesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.ComputeCapacityReservationInstanceShapeSummary objects * contained in responses from the listComputeCapacityReservationInstanceShapes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listComputeCapacityReservationInstanceShapesRecordIterator(request: requests.ListComputeCapacityReservationInstanceShapesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listComputeCapacityReservationInstanceShapes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listComputeCapacityReservationInstanceShapesResponseIterator(request: requests.ListComputeCapacityReservationInstanceShapesRequest): AsyncIterableIterator; /** * Lists the instances launched under a capacity reservation. You can filter results by specifying criteria. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListComputeCapacityReservationInstancesRequest * @return ListComputeCapacityReservationInstancesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListComputeCapacityReservationInstances.ts.html |here} to see how to use ListComputeCapacityReservationInstances API. */ listComputeCapacityReservationInstances(listComputeCapacityReservationInstancesRequest: requests.ListComputeCapacityReservationInstancesRequest): Promise; /** * NOTE: This function is deprecated in favor of listComputeCapacityReservationInstancesRecordIterator function. * Creates a new async iterator which will iterate over the models.CapacityReservationInstanceSummary objects * contained in responses from the listComputeCapacityReservationInstances operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllComputeCapacityReservationInstances(request: requests.ListComputeCapacityReservationInstancesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listComputeCapacityReservationInstancesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listComputeCapacityReservationInstances operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllComputeCapacityReservationInstancesResponses(request: requests.ListComputeCapacityReservationInstancesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.CapacityReservationInstanceSummary objects * contained in responses from the listComputeCapacityReservationInstances operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listComputeCapacityReservationInstancesRecordIterator(request: requests.ListComputeCapacityReservationInstancesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listComputeCapacityReservationInstances operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listComputeCapacityReservationInstancesResponseIterator(request: requests.ListComputeCapacityReservationInstancesRequest): AsyncIterableIterator; /** * Lists the compute capacity reservations that match the specified criteria and compartment. *

You can limit the list by specifying a compute capacity reservation display name * (the list will include all the identically-named compute capacity reservations in the compartment). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListComputeCapacityReservationsRequest * @return ListComputeCapacityReservationsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListComputeCapacityReservations.ts.html |here} to see how to use ListComputeCapacityReservations API. */ listComputeCapacityReservations(listComputeCapacityReservationsRequest: requests.ListComputeCapacityReservationsRequest): Promise; /** * NOTE: This function is deprecated in favor of listComputeCapacityReservationsRecordIterator function. * Creates a new async iterator which will iterate over the models.ComputeCapacityReservationSummary objects * contained in responses from the listComputeCapacityReservations operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllComputeCapacityReservations(request: requests.ListComputeCapacityReservationsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listComputeCapacityReservationsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listComputeCapacityReservations operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllComputeCapacityReservationsResponses(request: requests.ListComputeCapacityReservationsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.ComputeCapacityReservationSummary objects * contained in responses from the listComputeCapacityReservations operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listComputeCapacityReservationsRecordIterator(request: requests.ListComputeCapacityReservationsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listComputeCapacityReservations operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listComputeCapacityReservationsResponseIterator(request: requests.ListComputeCapacityReservationsRequest): AsyncIterableIterator; /** * Lists the compute capacity topologies in the specified compartment. You can filter the list by a compute * capacity topology display name. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListComputeCapacityTopologiesRequest * @return ListComputeCapacityTopologiesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListComputeCapacityTopologies.ts.html |here} to see how to use ListComputeCapacityTopologies API. */ listComputeCapacityTopologies(listComputeCapacityTopologiesRequest: requests.ListComputeCapacityTopologiesRequest): Promise; /** * Lists compute bare metal hosts in the specified compute capacity topology. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListComputeCapacityTopologyComputeBareMetalHostsRequest * @return ListComputeCapacityTopologyComputeBareMetalHostsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListComputeCapacityTopologyComputeBareMetalHosts.ts.html |here} to see how to use ListComputeCapacityTopologyComputeBareMetalHosts API. */ listComputeCapacityTopologyComputeBareMetalHosts(listComputeCapacityTopologyComputeBareMetalHostsRequest: requests.ListComputeCapacityTopologyComputeBareMetalHostsRequest): Promise; /** * Lists compute HPC islands in the specified compute capacity topology. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListComputeCapacityTopologyComputeHpcIslandsRequest * @return ListComputeCapacityTopologyComputeHpcIslandsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListComputeCapacityTopologyComputeHpcIslands.ts.html |here} to see how to use ListComputeCapacityTopologyComputeHpcIslands API. */ listComputeCapacityTopologyComputeHpcIslands(listComputeCapacityTopologyComputeHpcIslandsRequest: requests.ListComputeCapacityTopologyComputeHpcIslandsRequest): Promise; /** * Lists compute network blocks in the specified compute capacity topology. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListComputeCapacityTopologyComputeNetworkBlocksRequest * @return ListComputeCapacityTopologyComputeNetworkBlocksResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListComputeCapacityTopologyComputeNetworkBlocks.ts.html |here} to see how to use ListComputeCapacityTopologyComputeNetworkBlocks API. */ listComputeCapacityTopologyComputeNetworkBlocks(listComputeCapacityTopologyComputeNetworkBlocksRequest: requests.ListComputeCapacityTopologyComputeNetworkBlocksRequest): Promise; /** * Lists the compute clusters in the specified compartment. * A [compute cluster](https://docs.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory access (RDMA) network group. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListComputeClustersRequest * @return ListComputeClustersResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListComputeClusters.ts.html |here} to see how to use ListComputeClusters API. */ listComputeClusters(listComputeClustersRequest: requests.ListComputeClustersRequest): Promise; /** * Lists Compute Global Image Capability Schema versions in the specified compartment. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListComputeGlobalImageCapabilitySchemaVersionsRequest * @return ListComputeGlobalImageCapabilitySchemaVersionsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListComputeGlobalImageCapabilitySchemaVersions.ts.html |here} to see how to use ListComputeGlobalImageCapabilitySchemaVersions API. */ listComputeGlobalImageCapabilitySchemaVersions(listComputeGlobalImageCapabilitySchemaVersionsRequest: requests.ListComputeGlobalImageCapabilitySchemaVersionsRequest): Promise; /** * NOTE: This function is deprecated in favor of listComputeGlobalImageCapabilitySchemaVersionsRecordIterator function. * Creates a new async iterator which will iterate over the models.ComputeGlobalImageCapabilitySchemaVersionSummary objects * contained in responses from the listComputeGlobalImageCapabilitySchemaVersions operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllComputeGlobalImageCapabilitySchemaVersions(request: requests.ListComputeGlobalImageCapabilitySchemaVersionsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listComputeGlobalImageCapabilitySchemaVersionsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listComputeGlobalImageCapabilitySchemaVersions operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllComputeGlobalImageCapabilitySchemaVersionsResponses(request: requests.ListComputeGlobalImageCapabilitySchemaVersionsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.ComputeGlobalImageCapabilitySchemaVersionSummary objects * contained in responses from the listComputeGlobalImageCapabilitySchemaVersions operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listComputeGlobalImageCapabilitySchemaVersionsRecordIterator(request: requests.ListComputeGlobalImageCapabilitySchemaVersionsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listComputeGlobalImageCapabilitySchemaVersions operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listComputeGlobalImageCapabilitySchemaVersionsResponseIterator(request: requests.ListComputeGlobalImageCapabilitySchemaVersionsRequest): AsyncIterableIterator; /** * Lists Compute Global Image Capability Schema in the specified compartment. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListComputeGlobalImageCapabilitySchemasRequest * @return ListComputeGlobalImageCapabilitySchemasResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListComputeGlobalImageCapabilitySchemas.ts.html |here} to see how to use ListComputeGlobalImageCapabilitySchemas API. */ listComputeGlobalImageCapabilitySchemas(listComputeGlobalImageCapabilitySchemasRequest: requests.ListComputeGlobalImageCapabilitySchemasRequest): Promise; /** * NOTE: This function is deprecated in favor of listComputeGlobalImageCapabilitySchemasRecordIterator function. * Creates a new async iterator which will iterate over the models.ComputeGlobalImageCapabilitySchemaSummary objects * contained in responses from the listComputeGlobalImageCapabilitySchemas operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllComputeGlobalImageCapabilitySchemas(request: requests.ListComputeGlobalImageCapabilitySchemasRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listComputeGlobalImageCapabilitySchemasResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listComputeGlobalImageCapabilitySchemas operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllComputeGlobalImageCapabilitySchemasResponses(request: requests.ListComputeGlobalImageCapabilitySchemasRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.ComputeGlobalImageCapabilitySchemaSummary objects * contained in responses from the listComputeGlobalImageCapabilitySchemas operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listComputeGlobalImageCapabilitySchemasRecordIterator(request: requests.ListComputeGlobalImageCapabilitySchemasRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listComputeGlobalImageCapabilitySchemas operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listComputeGlobalImageCapabilitySchemasResponseIterator(request: requests.ListComputeGlobalImageCapabilitySchemasRequest): AsyncIterableIterator; /** * List all of the GPU memory cluster instances. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListComputeGpuMemoryClusterInstancesRequest * @return ListComputeGpuMemoryClusterInstancesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListComputeGpuMemoryClusterInstances.ts.html |here} to see how to use ListComputeGpuMemoryClusterInstances API. */ listComputeGpuMemoryClusterInstances(listComputeGpuMemoryClusterInstancesRequest: requests.ListComputeGpuMemoryClusterInstancesRequest): Promise; /** * List all of the compute GPU memory clusters. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListComputeGpuMemoryClustersRequest * @return ListComputeGpuMemoryClustersResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListComputeGpuMemoryClusters.ts.html |here} to see how to use ListComputeGpuMemoryClusters API. */ listComputeGpuMemoryClusters(listComputeGpuMemoryClustersRequest: requests.ListComputeGpuMemoryClustersRequest): Promise; /** * Lists the compute GPU memory fabrics that match the specified criteria and compartmentId. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListComputeGpuMemoryFabricsRequest * @return ListComputeGpuMemoryFabricsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListComputeGpuMemoryFabrics.ts.html |here} to see how to use ListComputeGpuMemoryFabrics API. */ listComputeGpuMemoryFabrics(listComputeGpuMemoryFabricsRequest: requests.ListComputeGpuMemoryFabricsRequest): Promise; /** * Lists the compute host groups that match the specified criteria and compartment. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListComputeHostGroupsRequest * @return ListComputeHostGroupsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListComputeHostGroups.ts.html |here} to see how to use ListComputeHostGroups API. */ listComputeHostGroups(listComputeHostGroupsRequest: requests.ListComputeHostGroupsRequest): Promise; /** * Generates a list of summary host details * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListComputeHostsRequest * @return ListComputeHostsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListComputeHosts.ts.html |here} to see how to use ListComputeHosts API. */ listComputeHosts(listComputeHostsRequest: requests.ListComputeHostsRequest): Promise; /** * Lists Compute Image Capability Schema in the specified compartment. You can also query by a specific imageId. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListComputeImageCapabilitySchemasRequest * @return ListComputeImageCapabilitySchemasResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListComputeImageCapabilitySchemas.ts.html |here} to see how to use ListComputeImageCapabilitySchemas API. */ listComputeImageCapabilitySchemas(listComputeImageCapabilitySchemasRequest: requests.ListComputeImageCapabilitySchemasRequest): Promise; /** * NOTE: This function is deprecated in favor of listComputeImageCapabilitySchemasRecordIterator function. * Creates a new async iterator which will iterate over the models.ComputeImageCapabilitySchemaSummary objects * contained in responses from the listComputeImageCapabilitySchemas operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllComputeImageCapabilitySchemas(request: requests.ListComputeImageCapabilitySchemasRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listComputeImageCapabilitySchemasResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listComputeImageCapabilitySchemas operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllComputeImageCapabilitySchemasResponses(request: requests.ListComputeImageCapabilitySchemasRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.ComputeImageCapabilitySchemaSummary objects * contained in responses from the listComputeImageCapabilitySchemas operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listComputeImageCapabilitySchemasRecordIterator(request: requests.ListComputeImageCapabilitySchemasRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listComputeImageCapabilitySchemas operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listComputeImageCapabilitySchemasResponseIterator(request: requests.ListComputeImageCapabilitySchemasRequest): AsyncIterableIterator; /** * Lists the console history metadata for the specified compartment or instance. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListConsoleHistoriesRequest * @return ListConsoleHistoriesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListConsoleHistories.ts.html |here} to see how to use ListConsoleHistories API. */ listConsoleHistories(listConsoleHistoriesRequest: requests.ListConsoleHistoriesRequest): Promise; /** * NOTE: This function is deprecated in favor of listConsoleHistoriesRecordIterator function. * Creates a new async iterator which will iterate over the models.ConsoleHistory objects * contained in responses from the listConsoleHistories operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllConsoleHistories(request: requests.ListConsoleHistoriesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listConsoleHistoriesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listConsoleHistories operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllConsoleHistoriesResponses(request: requests.ListConsoleHistoriesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.ConsoleHistory objects * contained in responses from the listConsoleHistories operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listConsoleHistoriesRecordIterator(request: requests.ListConsoleHistoriesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listConsoleHistories operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listConsoleHistoriesResponseIterator(request: requests.ListConsoleHistoriesRequest): AsyncIterableIterator; /** * Lists the shapes that can be used to launch a virtual machine instance on a dedicated virtual machine host within the specified compartment. * You can filter the list by compatibility with a specific dedicated virtual machine host shape. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListDedicatedVmHostInstanceShapesRequest * @return ListDedicatedVmHostInstanceShapesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListDedicatedVmHostInstanceShapes.ts.html |here} to see how to use ListDedicatedVmHostInstanceShapes API. */ listDedicatedVmHostInstanceShapes(listDedicatedVmHostInstanceShapesRequest: requests.ListDedicatedVmHostInstanceShapesRequest): Promise; /** * NOTE: This function is deprecated in favor of listDedicatedVmHostInstanceShapesRecordIterator function. * Creates a new async iterator which will iterate over the models.DedicatedVmHostInstanceShapeSummary objects * contained in responses from the listDedicatedVmHostInstanceShapes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllDedicatedVmHostInstanceShapes(request: requests.ListDedicatedVmHostInstanceShapesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listDedicatedVmHostInstanceShapesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listDedicatedVmHostInstanceShapes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllDedicatedVmHostInstanceShapesResponses(request: requests.ListDedicatedVmHostInstanceShapesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.DedicatedVmHostInstanceShapeSummary objects * contained in responses from the listDedicatedVmHostInstanceShapes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listDedicatedVmHostInstanceShapesRecordIterator(request: requests.ListDedicatedVmHostInstanceShapesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listDedicatedVmHostInstanceShapes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listDedicatedVmHostInstanceShapesResponseIterator(request: requests.ListDedicatedVmHostInstanceShapesRequest): AsyncIterableIterator; /** * Returns the list of instances on the dedicated virtual machine hosts that match the specified criteria. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListDedicatedVmHostInstancesRequest * @return ListDedicatedVmHostInstancesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListDedicatedVmHostInstances.ts.html |here} to see how to use ListDedicatedVmHostInstances API. */ listDedicatedVmHostInstances(listDedicatedVmHostInstancesRequest: requests.ListDedicatedVmHostInstancesRequest): Promise; /** * NOTE: This function is deprecated in favor of listDedicatedVmHostInstancesRecordIterator function. * Creates a new async iterator which will iterate over the models.DedicatedVmHostInstanceSummary objects * contained in responses from the listDedicatedVmHostInstances operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllDedicatedVmHostInstances(request: requests.ListDedicatedVmHostInstancesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listDedicatedVmHostInstancesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listDedicatedVmHostInstances operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllDedicatedVmHostInstancesResponses(request: requests.ListDedicatedVmHostInstancesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.DedicatedVmHostInstanceSummary objects * contained in responses from the listDedicatedVmHostInstances operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listDedicatedVmHostInstancesRecordIterator(request: requests.ListDedicatedVmHostInstancesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listDedicatedVmHostInstances operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listDedicatedVmHostInstancesResponseIterator(request: requests.ListDedicatedVmHostInstancesRequest): AsyncIterableIterator; /** * Lists the shapes that can be used to launch a dedicated virtual machine host within the specified compartment. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListDedicatedVmHostShapesRequest * @return ListDedicatedVmHostShapesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListDedicatedVmHostShapes.ts.html |here} to see how to use ListDedicatedVmHostShapes API. */ listDedicatedVmHostShapes(listDedicatedVmHostShapesRequest: requests.ListDedicatedVmHostShapesRequest): Promise; /** * NOTE: This function is deprecated in favor of listDedicatedVmHostShapesRecordIterator function. * Creates a new async iterator which will iterate over the models.DedicatedVmHostShapeSummary objects * contained in responses from the listDedicatedVmHostShapes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllDedicatedVmHostShapes(request: requests.ListDedicatedVmHostShapesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listDedicatedVmHostShapesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listDedicatedVmHostShapes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllDedicatedVmHostShapesResponses(request: requests.ListDedicatedVmHostShapesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.DedicatedVmHostShapeSummary objects * contained in responses from the listDedicatedVmHostShapes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listDedicatedVmHostShapesRecordIterator(request: requests.ListDedicatedVmHostShapesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listDedicatedVmHostShapes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listDedicatedVmHostShapesResponseIterator(request: requests.ListDedicatedVmHostShapesRequest): AsyncIterableIterator; /** * Returns the list of dedicated virtual machine hosts that match the specified criteria in the specified compartment. *

You can limit the list by specifying a dedicated virtual machine host display name. The list will include all the identically-named * dedicated virtual machine hosts in the compartment. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListDedicatedVmHostsRequest * @return ListDedicatedVmHostsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListDedicatedVmHosts.ts.html |here} to see how to use ListDedicatedVmHosts API. */ listDedicatedVmHosts(listDedicatedVmHostsRequest: requests.ListDedicatedVmHostsRequest): Promise; /** * NOTE: This function is deprecated in favor of listDedicatedVmHostsRecordIterator function. * Creates a new async iterator which will iterate over the models.DedicatedVmHostSummary objects * contained in responses from the listDedicatedVmHosts operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllDedicatedVmHosts(request: requests.ListDedicatedVmHostsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listDedicatedVmHostsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listDedicatedVmHosts operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllDedicatedVmHostsResponses(request: requests.ListDedicatedVmHostsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.DedicatedVmHostSummary objects * contained in responses from the listDedicatedVmHosts operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listDedicatedVmHostsRecordIterator(request: requests.ListDedicatedVmHostsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listDedicatedVmHosts operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listDedicatedVmHostsResponseIterator(request: requests.ListDedicatedVmHostsRequest): AsyncIterableIterator; /** * Gets a list of all Firmware Bundles in a compartment for specified platform. Can filter results to include * only the default (recommended) Firmware Bundle for the given platform. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListFirmwareBundlesRequest * @return ListFirmwareBundlesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListFirmwareBundles.ts.html |here} to see how to use ListFirmwareBundles API. */ listFirmwareBundles(listFirmwareBundlesRequest: requests.ListFirmwareBundlesRequest): Promise; /** * Lists the compatible shapes for the specified image. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListImageShapeCompatibilityEntriesRequest * @return ListImageShapeCompatibilityEntriesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListImageShapeCompatibilityEntries.ts.html |here} to see how to use ListImageShapeCompatibilityEntries API. */ listImageShapeCompatibilityEntries(listImageShapeCompatibilityEntriesRequest: requests.ListImageShapeCompatibilityEntriesRequest): Promise; /** * NOTE: This function is deprecated in favor of listImageShapeCompatibilityEntriesRecordIterator function. * Creates a new async iterator which will iterate over the models.ImageShapeCompatibilitySummary objects * contained in responses from the listImageShapeCompatibilityEntries operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllImageShapeCompatibilityEntries(request: requests.ListImageShapeCompatibilityEntriesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listImageShapeCompatibilityEntriesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listImageShapeCompatibilityEntries operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllImageShapeCompatibilityEntriesResponses(request: requests.ListImageShapeCompatibilityEntriesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.ImageShapeCompatibilitySummary objects * contained in responses from the listImageShapeCompatibilityEntries operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listImageShapeCompatibilityEntriesRecordIterator(request: requests.ListImageShapeCompatibilityEntriesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listImageShapeCompatibilityEntries operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listImageShapeCompatibilityEntriesResponseIterator(request: requests.ListImageShapeCompatibilityEntriesRequest): AsyncIterableIterator; /** * Lists a subset of images available in the specified compartment, including * [platform images](https://docs.oracle.com/iaas/Content/Compute/References/images.htm) and * [custom images](https://docs.oracle.com/iaas/Content/Compute/Tasks/managingcustomimages.htm). * The list of platform images includes the three most recently published versions * of each major distribution. The list does not support filtering based on image tags. *

The list of images returned is ordered to first show the recent platform images, * then all of the custom images. *

**Caution:** Platform images are refreshed regularly. When new images are released, older versions are replaced. * The image OCIDs remain available, but when the platform image is replaced, the image OCIDs are no longer returned as part of the platform image list. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListImagesRequest * @return ListImagesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListImages.ts.html |here} to see how to use ListImages API. */ listImages(listImagesRequest: requests.ListImagesRequest): Promise; /** * NOTE: This function is deprecated in favor of listImagesRecordIterator function. * Creates a new async iterator which will iterate over the models.Image objects * contained in responses from the listImages operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllImages(request: requests.ListImagesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listImagesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listImages operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllImagesResponses(request: requests.ListImagesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.Image objects * contained in responses from the listImages operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listImagesRecordIterator(request: requests.ListImagesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listImages operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listImagesResponseIterator(request: requests.ListImagesRequest): AsyncIterableIterator; /** * Lists the console connections for the specified compartment or instance. *

For more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](https://docs.oracle.com/iaas/Content/Compute/References/serialconsole.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListInstanceConsoleConnectionsRequest * @return ListInstanceConsoleConnectionsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListInstanceConsoleConnections.ts.html |here} to see how to use ListInstanceConsoleConnections API. */ listInstanceConsoleConnections(listInstanceConsoleConnectionsRequest: requests.ListInstanceConsoleConnectionsRequest): Promise; /** * NOTE: This function is deprecated in favor of listInstanceConsoleConnectionsRecordIterator function. * Creates a new async iterator which will iterate over the models.InstanceConsoleConnection objects * contained in responses from the listInstanceConsoleConnections operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllInstanceConsoleConnections(request: requests.ListInstanceConsoleConnectionsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listInstanceConsoleConnectionsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listInstanceConsoleConnections operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllInstanceConsoleConnectionsResponses(request: requests.ListInstanceConsoleConnectionsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.InstanceConsoleConnection objects * contained in responses from the listInstanceConsoleConnections operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listInstanceConsoleConnectionsRecordIterator(request: requests.ListInstanceConsoleConnectionsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listInstanceConsoleConnections operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listInstanceConsoleConnectionsResponseIterator(request: requests.ListInstanceConsoleConnectionsRequest): AsyncIterableIterator; /** * Gets a list of all the devices for given instance. You can optionally filter results by device availability. * This operation does not retry by default if the user has not defined a retry configuration. * @param ListInstanceDevicesRequest * @return ListInstanceDevicesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListInstanceDevices.ts.html |here} to see how to use ListInstanceDevices API. */ listInstanceDevices(listInstanceDevicesRequest: requests.ListInstanceDevicesRequest): Promise; /** * NOTE: This function is deprecated in favor of listInstanceDevicesRecordIterator function. * Creates a new async iterator which will iterate over the models.Device objects * contained in responses from the listInstanceDevices operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllInstanceDevices(request: requests.ListInstanceDevicesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listInstanceDevicesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listInstanceDevices operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllInstanceDevicesResponses(request: requests.ListInstanceDevicesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.Device objects * contained in responses from the listInstanceDevices operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listInstanceDevicesRecordIterator(request: requests.ListInstanceDevicesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listInstanceDevices operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listInstanceDevicesResponseIterator(request: requests.ListInstanceDevicesRequest): AsyncIterableIterator; /** * Gets a list of all the maintenance events for the given compartment. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListInstanceMaintenanceEventsRequest * @return ListInstanceMaintenanceEventsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListInstanceMaintenanceEvents.ts.html |here} to see how to use ListInstanceMaintenanceEvents API. */ listInstanceMaintenanceEvents(listInstanceMaintenanceEventsRequest: requests.ListInstanceMaintenanceEventsRequest): Promise; /** * NOTE: This function is deprecated in favor of listInstanceMaintenanceEventsRecordIterator function. * Creates a new async iterator which will iterate over the models.InstanceMaintenanceEventSummary objects * contained in responses from the listInstanceMaintenanceEvents operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllInstanceMaintenanceEvents(request: requests.ListInstanceMaintenanceEventsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listInstanceMaintenanceEventsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listInstanceMaintenanceEvents operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllInstanceMaintenanceEventsResponses(request: requests.ListInstanceMaintenanceEventsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.InstanceMaintenanceEventSummary objects * contained in responses from the listInstanceMaintenanceEvents operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listInstanceMaintenanceEventsRecordIterator(request: requests.ListInstanceMaintenanceEventsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listInstanceMaintenanceEvents operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listInstanceMaintenanceEventsResponseIterator(request: requests.ListInstanceMaintenanceEventsRequest): AsyncIterableIterator; /** * Lists the instances in the specified compartment and the specified availability domain. * You can filter the results by specifying an instance name (the list will include all the identically-named * instances in the compartment). *

**Note:** To retrieve public and private IP addresses for an instance, use the {@link #listVnicAttachments(ListVnicAttachmentsRequest) listVnicAttachments} * operation to get the VNIC ID for the instance, and then call {@link #getVnic(GetVnicRequest) getVnic} with the VNIC ID. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListInstancesRequest * @return ListInstancesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListInstances.ts.html |here} to see how to use ListInstances API. */ listInstances(listInstancesRequest: requests.ListInstancesRequest): Promise; /** * NOTE: This function is deprecated in favor of listInstancesRecordIterator function. * Creates a new async iterator which will iterate over the models.Instance objects * contained in responses from the listInstances operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllInstances(request: requests.ListInstancesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listInstancesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listInstances operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllInstancesResponses(request: requests.ListInstancesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.Instance objects * contained in responses from the listInstances operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listInstancesRecordIterator(request: requests.ListInstancesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listInstances operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listInstancesResponseIterator(request: requests.ListInstancesRequest): AsyncIterableIterator; /** * Lists the shapes that can be used to launch an instance within the specified compartment. You can * filter the list by compatibility with a specific image. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListShapesRequest * @return ListShapesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListShapes.ts.html |here} to see how to use ListShapes API. */ listShapes(listShapesRequest: requests.ListShapesRequest): Promise; /** * NOTE: This function is deprecated in favor of listShapesRecordIterator function. * Creates a new async iterator which will iterate over the models.Shape objects * contained in responses from the listShapes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllShapes(request: requests.ListShapesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listShapesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listShapes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllShapesResponses(request: requests.ListShapesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.Shape objects * contained in responses from the listShapes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listShapesRecordIterator(request: requests.ListShapesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listShapes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listShapesResponseIterator(request: requests.ListShapesRequest): AsyncIterableIterator; /** * Lists the VNIC attachments in the specified compartment. A VNIC attachment * resides in the same compartment as the attached instance. The list can be * filtered by instance, VNIC, or availability domain. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListVnicAttachmentsRequest * @return ListVnicAttachmentsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListVnicAttachments.ts.html |here} to see how to use ListVnicAttachments API. */ listVnicAttachments(listVnicAttachmentsRequest: requests.ListVnicAttachmentsRequest): Promise; /** * NOTE: This function is deprecated in favor of listVnicAttachmentsRecordIterator function. * Creates a new async iterator which will iterate over the models.VnicAttachment objects * contained in responses from the listVnicAttachments operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllVnicAttachments(request: requests.ListVnicAttachmentsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listVnicAttachmentsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listVnicAttachments operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllVnicAttachmentsResponses(request: requests.ListVnicAttachmentsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.VnicAttachment objects * contained in responses from the listVnicAttachments operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listVnicAttachmentsRecordIterator(request: requests.ListVnicAttachmentsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listVnicAttachments operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listVnicAttachmentsResponseIterator(request: requests.ListVnicAttachmentsRequest): AsyncIterableIterator; /** * Lists the volume attachments in the specified compartment. You can filter the * list by specifying an instance OCID, volume OCID, or both. *

Currently, the only supported volume attachment type are {@link IScsiVolumeAttachment} and * {@link ParavirtualizedVolumeAttachment}. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListVolumeAttachmentsRequest * @return ListVolumeAttachmentsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListVolumeAttachments.ts.html |here} to see how to use ListVolumeAttachments API. */ listVolumeAttachments(listVolumeAttachmentsRequest: requests.ListVolumeAttachmentsRequest): Promise; /** * NOTE: This function is deprecated in favor of listVolumeAttachmentsRecordIterator function. * Creates a new async iterator which will iterate over the models.VolumeAttachment objects * contained in responses from the listVolumeAttachments operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllVolumeAttachments(request: requests.ListVolumeAttachmentsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listVolumeAttachmentsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listVolumeAttachments operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllVolumeAttachmentsResponses(request: requests.ListVolumeAttachmentsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.VolumeAttachment objects * contained in responses from the listVolumeAttachments operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listVolumeAttachmentsRecordIterator(request: requests.ListVolumeAttachmentsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listVolumeAttachments operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listVolumeAttachmentsResponseIterator(request: requests.ListVolumeAttachmentsRequest): AsyncIterableIterator; /** * Removes a shape from the compatible shapes list for the image. * This operation does not retry by default if the user has not defined a retry configuration. * @param RemoveImageShapeCompatibilityEntryRequest * @return RemoveImageShapeCompatibilityEntryResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/RemoveImageShapeCompatibilityEntry.ts.html |here} to see how to use RemoveImageShapeCompatibilityEntry API. */ removeImageShapeCompatibilityEntry(removeImageShapeCompatibilityEntryRequest: requests.RemoveImageShapeCompatibilityEntryRequest): Promise; /** * Permanently terminates (deletes) the specified instance. Any attached VNICs and volumes are automatically detached * when the instance terminates. *

To preserve the boot volume associated with the instance, specify `true` for `PreserveBootVolumeQueryParam`. * To delete the boot volume when the instance is deleted, specify `false` or do not specify a value for `PreserveBootVolumeQueryParam`. *

To preserve data volumes created with the instance, specify `true` or do not specify a value for `PreserveDataVolumesQueryParam`. * To delete the data volumes when the instance itself is deleted, specify `false` for `PreserveDataVolumesQueryParam`. *

This is an asynchronous operation. The instance's `lifecycleState` changes to TERMINATING temporarily * until the instance is completely deleted. After the instance is deleted, the record remains visible in the list of instances * with the state TERMINATED for at least 12 hours, but no further action is needed. * * This operation does not retry by default if the user has not defined a retry configuration. * @param TerminateInstanceRequest * @return TerminateInstanceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/TerminateInstance.ts.html |here} to see how to use TerminateInstance API. */ terminateInstance(terminateInstanceRequest: requests.TerminateInstanceRequest): Promise; /** * Updates the specified capacity reservation and its associated capacity configurations. * Fields that are not provided in the request will not be updated. Capacity configurations that are not included will be deleted. * Avoid entering confidential information. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateComputeCapacityReservationRequest * @return UpdateComputeCapacityReservationResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateComputeCapacityReservation.ts.html |here} to see how to use UpdateComputeCapacityReservation API. */ updateComputeCapacityReservation(updateComputeCapacityReservationRequest: requests.UpdateComputeCapacityReservationRequest): Promise; /** * Updates the specified compute capacity topology. Fields that are not provided in the request will not be updated. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateComputeCapacityTopologyRequest * @return UpdateComputeCapacityTopologyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateComputeCapacityTopology.ts.html |here} to see how to use UpdateComputeCapacityTopology API. */ updateComputeCapacityTopology(updateComputeCapacityTopologyRequest: requests.UpdateComputeCapacityTopologyRequest): Promise; /** * Updates a compute cluster. A [compute cluster](https://docs.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm) is a * remote direct memory access (RDMA) network group. *

To create instances within a compute cluster, use the {@link #launchInstance(LaunchInstanceRequest) launchInstance} * operation. *

To delete instances from a compute cluster, use the {@link #terminateInstance(TerminateInstanceRequest) terminateInstance} * operation. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateComputeClusterRequest * @return UpdateComputeClusterResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateComputeCluster.ts.html |here} to see how to use UpdateComputeCluster API. */ updateComputeCluster(updateComputeClusterRequest: requests.UpdateComputeClusterRequest): Promise; /** * Updates a compute gpu memory cluster resource. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateComputeGpuMemoryClusterRequest * @return UpdateComputeGpuMemoryClusterResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateComputeGpuMemoryCluster.ts.html |here} to see how to use UpdateComputeGpuMemoryCluster API. */ updateComputeGpuMemoryCluster(updateComputeGpuMemoryClusterRequest: requests.UpdateComputeGpuMemoryClusterRequest): Promise; /** * Customer can update displayName, tags and desired firmware bundle, recycle level for * compute GPU memory fabric record * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateComputeGpuMemoryFabricRequest * @return UpdateComputeGpuMemoryFabricResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateComputeGpuMemoryFabric.ts.html |here} to see how to use UpdateComputeGpuMemoryFabric API. */ updateComputeGpuMemoryFabric(updateComputeGpuMemoryFabricRequest: requests.UpdateComputeGpuMemoryFabricRequest): Promise; /** * Customer can update the some fields for ComputeHost record * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateComputeHostRequest * @return UpdateComputeHostResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateComputeHost.ts.html |here} to see how to use UpdateComputeHost API. */ updateComputeHost(updateComputeHostRequest: requests.UpdateComputeHostRequest): Promise; /** * Updates the specified compute host group details. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateComputeHostGroupRequest * @return UpdateComputeHostGroupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateComputeHostGroup.ts.html |here} to see how to use UpdateComputeHostGroup API. */ updateComputeHostGroup(updateComputeHostGroupRequest: requests.UpdateComputeHostGroupRequest): Promise; /** * Updates the specified Compute Image Capability Schema * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateComputeImageCapabilitySchemaRequest * @return UpdateComputeImageCapabilitySchemaResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateComputeImageCapabilitySchema.ts.html |here} to see how to use UpdateComputeImageCapabilitySchema API. */ updateComputeImageCapabilitySchema(updateComputeImageCapabilitySchemaRequest: requests.UpdateComputeImageCapabilitySchemaRequest): Promise; /** * Updates the specified console history metadata. * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateConsoleHistoryRequest * @return UpdateConsoleHistoryResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateConsoleHistory.ts.html |here} to see how to use UpdateConsoleHistory API. */ updateConsoleHistory(updateConsoleHistoryRequest: requests.UpdateConsoleHistoryRequest): Promise; /** * Updates the displayName, freeformTags, and definedTags attributes for the specified dedicated virtual machine host. * If an attribute value is not included, it will not be updated. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateDedicatedVmHostRequest * @return UpdateDedicatedVmHostResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateDedicatedVmHost.ts.html |here} to see how to use UpdateDedicatedVmHost API. */ updateDedicatedVmHost(updateDedicatedVmHostRequest: requests.UpdateDedicatedVmHostRequest): Promise; /** * Updates the display name of the image. Avoid entering confidential information. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateImageRequest * @return UpdateImageResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateImage.ts.html |here} to see how to use UpdateImage API. */ updateImage(updateImageRequest: requests.UpdateImageRequest): Promise; /** * Updates certain fields on the specified instance. Fields that are not provided in the * request will not be updated. Avoid entering confidential information. *

Changes to metadata fields will be reflected in the instance metadata service (this may take * up to a minute). *

The OCID of the instance remains the same. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateInstanceRequest * @return UpdateInstanceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateInstance.ts.html |here} to see how to use UpdateInstance API. */ updateInstance(updateInstanceRequest: requests.UpdateInstanceRequest): Promise; /** * Updates the defined tags and free-form tags for the specified instance console connection. * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateInstanceConsoleConnectionRequest * @return UpdateInstanceConsoleConnectionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateInstanceConsoleConnection.ts.html |here} to see how to use UpdateInstanceConsoleConnection API. */ updateInstanceConsoleConnection(updateInstanceConsoleConnectionRequest: requests.UpdateInstanceConsoleConnectionRequest): Promise; /** * Updates the maintenance event for the given instance. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateInstanceMaintenanceEventRequest * @return UpdateInstanceMaintenanceEventResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateInstanceMaintenanceEvent.ts.html |here} to see how to use UpdateInstanceMaintenanceEvent API. */ updateInstanceMaintenanceEvent(updateInstanceMaintenanceEventRequest: requests.UpdateInstanceMaintenanceEventRequest): Promise; /** * Updates information about the specified volume attachment. * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateVolumeAttachmentRequest * @return UpdateVolumeAttachmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateVolumeAttachment.ts.html |here} to see how to use UpdateVolumeAttachment API. */ updateVolumeAttachment(updateVolumeAttachmentRequest: requests.UpdateVolumeAttachmentRequest): Promise; } export declare enum ComputeManagementApiKeys { } /** * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user. */ export declare class ComputeManagementClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_waiters": ComputeManagementWaiter; protected "_clientConfiguration": common.ClientConfiguration; protected _circuitBreaker: typeof Breaker | null; protected _httpOptions: any; protected _bodyDuplexMode: any; targetService: string; protected _regionId: string; protected "_region": common.Region; protected _lastSetRegionOrRegionId: string; protected _enableDualstackEndpoint: boolean | undefined; protected _serviceUsesDualStackByDefault: boolean; protected _httpClient: common.HttpClient; protected _authProvider: common.AuthenticationDetailsProvider | undefined; constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration); /** * Get the endpoint that is being used to call (ex, https://www.example.com). */ get endpoint(): string; /** * Sets the endpoint to call (ex, https://www.example.com). * @param endpoint The endpoint of the service. */ set endpoint(endpoint: string); get logger(): import("oci-common/lib/log").Logger; /** * Determines whether realm specific endpoint should be used or not. * Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false" * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template */ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean); /** * Sets the region to call (ex, Region.US_PHOENIX_1). * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint. * @param region The region of the service. */ set region(region: common.Region); /** * Sets the regionId to call (ex, 'us-phoenix-1'). * * Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. * If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 * and then call {@link #endpoint(String) endpoint}. * @param regionId The public region ID. */ set regionId(regionId: string); set enableDualstackEndpoint(enableDualstackEndpoint: boolean); /** * Creates a new ComputeManagementWaiter for resources for this service. * * @param workRequestClient The work request service client used to query for work request status * @param config The waiter configuration for termination and delay strategy * @return The service waiters. */ createWaiters(workRequestClient: WorkRequestClient, config?: common.WaiterConfiguration): ComputeManagementWaiter; /** * Gets the waiters available for resources for this service. * * @return The service waiters. */ getWaiters(): ComputeManagementWaiter; /** * Shutdown the circuit breaker used by the client when it is no longer needed */ shutdownCircuitBreaker(): void; /** * Close the provider if possible which in turn shuts down any associated circuit breaker */ closeProvider(): void; /** * Close the client once it is no longer needed */ close(): void; /** * Attaches an instance to an instance pool. For information about the prerequisites * that an instance must meet before you can attach it to a pool, see * [Attaching an Instance to an Instance Pool](https://docs.oracle.com/iaas/Content/Compute/Tasks/updatinginstancepool.htm#attach-instance). * * This operation does not retry by default if the user has not defined a retry configuration. * @param AttachInstancePoolInstanceRequest * @return AttachInstancePoolInstanceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/AttachInstancePoolInstance.ts.html |here} to see how to use AttachInstancePoolInstance API. */ attachInstancePoolInstance(attachInstancePoolInstanceRequest: requests.AttachInstancePoolInstanceRequest): Promise; /** * Attach a load balancer to the instance pool. * * This operation does not retry by default if the user has not defined a retry configuration. * @param AttachLoadBalancerRequest * @return AttachLoadBalancerResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/AttachLoadBalancer.ts.html |here} to see how to use AttachLoadBalancer API. */ attachLoadBalancer(attachLoadBalancerRequest: requests.AttachLoadBalancerRequest): Promise; /** * Moves a [cluster network with instance pools](https://docs.oracle.com/iaas/Content/Compute/Tasks/managingclusternetworks.htm) * into a different compartment within the same tenancy. For * information about moving resources between compartments, see * [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). *

When you move a cluster network to a different compartment, associated resources such as the instances * in the cluster network, boot volumes, and VNICs are not moved. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeClusterNetworkCompartmentRequest * @return ChangeClusterNetworkCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeClusterNetworkCompartment.ts.html |here} to see how to use ChangeClusterNetworkCompartment API. */ changeClusterNetworkCompartment(changeClusterNetworkCompartmentRequest: requests.ChangeClusterNetworkCompartmentRequest): Promise; /** * Moves an instance configuration into a different compartment within the same tenancy. * For information about moving resources between compartments, see * [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). *

When you move an instance configuration to a different compartment, associated resources such as * instance pools are not moved. *

**Important:** Most of the properties for an existing instance configuration, including the compartment, * cannot be modified after you create the instance configuration. Although you can move an instance configuration * to a different compartment, you will not be able to use the instance configuration to manage instance pools * in the new compartment. If you want to update an instance configuration to point to a different compartment, * you should instead create a new instance configuration in the target compartment using * [CreateInstanceConfiguration](https://docs.oracle.com/iaas/api/#/en/iaas/20160918/InstanceConfiguration/CreateInstanceConfiguration). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeInstanceConfigurationCompartmentRequest * @return ChangeInstanceConfigurationCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeInstanceConfigurationCompartment.ts.html |here} to see how to use ChangeInstanceConfigurationCompartment API. */ changeInstanceConfigurationCompartment(changeInstanceConfigurationCompartmentRequest: requests.ChangeInstanceConfigurationCompartmentRequest): Promise; /** * Moves an instance pool into a different compartment within the same tenancy. For * information about moving resources between compartments, see * [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). *

When you move an instance pool to a different compartment, associated resources such as the instances in * the pool, boot volumes, VNICs, and autoscaling configurations are not moved. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeInstancePoolCompartmentRequest * @return ChangeInstancePoolCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeInstancePoolCompartment.ts.html |here} to see how to use ChangeInstancePoolCompartment API. */ changeInstancePoolCompartment(changeInstancePoolCompartmentRequest: requests.ChangeInstancePoolCompartmentRequest): Promise; /** * Creates a [cluster network with instance pools](https://docs.oracle.com/iaas/Content/Compute/Tasks/managingclusternetworks.htm). * A cluster network is a group of high performance computing (HPC), GPU, or optimized bare metal * instances that are connected with an ultra low-latency remote direct memory access (RDMA) network. * Cluster networks with instance pools use instance pools to manage groups of identical instances. *

Use cluster networks with instance pools when you want predictable capacity for a specific number of identical * instances that are managed as a group. *

If you want to manage instances in the RDMA network independently of each other or use different types of instances * in the network group, create a compute cluster by using the {@link #createComputeCluster(CreateComputeClusterRequest) createComputeCluster} * operation. *

To determine whether capacity is available for a specific shape before you create a cluster network, * use the {@link #createComputeCapacityReport(CreateComputeCapacityReportRequest) createComputeCapacityReport} * operation. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateClusterNetworkRequest * @return CreateClusterNetworkResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateClusterNetwork.ts.html |here} to see how to use CreateClusterNetwork API. */ createClusterNetwork(createClusterNetworkRequest: requests.CreateClusterNetworkRequest): Promise; /** * Creates an instance configuration. An instance configuration is a template that defines the * settings to use when creating Compute instances or GPU Memory Clusters. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateInstanceConfigurationRequest * @return CreateInstanceConfigurationResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateInstanceConfiguration.ts.html |here} to see how to use CreateInstanceConfiguration API. */ createInstanceConfiguration(createInstanceConfigurationRequest: requests.CreateInstanceConfigurationRequest): Promise; /** * Creates an instance pool. *

To determine whether capacity is available for a specific shape before you create an instance pool, * use the {@link #createComputeCapacityReport(CreateComputeCapacityReportRequest) createComputeCapacityReport} * operation. * You can optionally include `overridePolicy` to define availability domain-scoped * launch overrides for future launches. Existing pool members are not modified. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateInstancePoolRequest * @return CreateInstancePoolResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateInstancePool.ts.html |here} to see how to use CreateInstancePool API. */ createInstancePool(createInstancePoolRequest: requests.CreateInstancePoolRequest): Promise; /** * Deletes an instance configuration. * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteInstanceConfigurationRequest * @return DeleteInstanceConfigurationResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteInstanceConfiguration.ts.html |here} to see how to use DeleteInstanceConfiguration API. */ deleteInstanceConfiguration(deleteInstanceConfigurationRequest: requests.DeleteInstanceConfigurationRequest): Promise; /** * Detaches an instance from an instance pool. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DetachInstancePoolInstanceRequest * @return DetachInstancePoolInstanceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DetachInstancePoolInstance.ts.html |here} to see how to use DetachInstancePoolInstance API. */ detachInstancePoolInstance(detachInstancePoolInstanceRequest: requests.DetachInstancePoolInstanceRequest): Promise; /** * Detach a load balancer from the instance pool. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DetachLoadBalancerRequest * @return DetachLoadBalancerResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DetachLoadBalancer.ts.html |here} to see how to use DetachLoadBalancer API. */ detachLoadBalancer(detachLoadBalancerRequest: requests.DetachLoadBalancerRequest): Promise; /** * Gets information about a [cluster network with instance pools](https://docs.oracle.com/iaas/Content/Compute/Tasks/managingclusternetworks.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetClusterNetworkRequest * @return GetClusterNetworkResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetClusterNetwork.ts.html |here} to see how to use GetClusterNetwork API. */ getClusterNetwork(getClusterNetworkRequest: requests.GetClusterNetworkRequest): Promise; /** * Gets the specified instance configuration * This operation does not retry by default if the user has not defined a retry configuration. * @param GetInstanceConfigurationRequest * @return GetInstanceConfigurationResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetInstanceConfiguration.ts.html |here} to see how to use GetInstanceConfiguration API. */ getInstanceConfiguration(getInstanceConfigurationRequest: requests.GetInstanceConfigurationRequest): Promise; /** * Gets the specified instance pool * This operation does not retry by default if the user has not defined a retry configuration. * @param GetInstancePoolRequest * @return GetInstancePoolResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetInstancePool.ts.html |here} to see how to use GetInstancePool API. */ getInstancePool(getInstancePoolRequest: requests.GetInstancePoolRequest): Promise; /** * Gets information about an instance that belongs to an instance pool. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetInstancePoolInstanceRequest * @return GetInstancePoolInstanceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetInstancePoolInstance.ts.html |here} to see how to use GetInstancePoolInstance API. */ getInstancePoolInstance(getInstancePoolInstanceRequest: requests.GetInstancePoolInstanceRequest): Promise; /** * Gets information about a load balancer that is attached to the specified instance pool. * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetInstancePoolLoadBalancerAttachmentRequest * @return GetInstancePoolLoadBalancerAttachmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetInstancePoolLoadBalancerAttachment.ts.html |here} to see how to use GetInstancePoolLoadBalancerAttachment API. */ getInstancePoolLoadBalancerAttachment(getInstancePoolLoadBalancerAttachmentRequest: requests.GetInstancePoolLoadBalancerAttachmentRequest): Promise; /** * Creates an instance from an instance configuration. *

If the instance configuration does not include all of the parameters that are * required to create an instance, such as the availability domain and subnet ID, you must * provide these parameters when you create an instance from the instance configuration. * For more information, see the {@link InstanceConfiguration} * resource. *

To determine whether capacity is available for a specific shape before you create an instance, * use the {@link #createComputeCapacityReport(CreateComputeCapacityReportRequest) createComputeCapacityReport} * operation. * * This operation does not retry by default if the user has not defined a retry configuration. * @param LaunchInstanceConfigurationRequest * @return LaunchInstanceConfigurationResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/LaunchInstanceConfiguration.ts.html |here} to see how to use LaunchInstanceConfiguration API. */ launchInstanceConfiguration(launchInstanceConfigurationRequest: requests.LaunchInstanceConfigurationRequest): Promise; /** * Lists the instances in a [cluster network with instance pools](https://docs.oracle.com/iaas/Content/Compute/Tasks/managingclusternetworks.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListClusterNetworkInstancesRequest * @return ListClusterNetworkInstancesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListClusterNetworkInstances.ts.html |here} to see how to use ListClusterNetworkInstances API. */ listClusterNetworkInstances(listClusterNetworkInstancesRequest: requests.ListClusterNetworkInstancesRequest): Promise; /** * NOTE: This function is deprecated in favor of listClusterNetworkInstancesRecordIterator function. * Creates a new async iterator which will iterate over the models.InstanceSummary objects * contained in responses from the listClusterNetworkInstances operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllClusterNetworkInstances(request: requests.ListClusterNetworkInstancesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listClusterNetworkInstancesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listClusterNetworkInstances operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllClusterNetworkInstancesResponses(request: requests.ListClusterNetworkInstancesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.InstanceSummary objects * contained in responses from the listClusterNetworkInstances operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listClusterNetworkInstancesRecordIterator(request: requests.ListClusterNetworkInstancesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listClusterNetworkInstances operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listClusterNetworkInstancesResponseIterator(request: requests.ListClusterNetworkInstancesRequest): AsyncIterableIterator; /** * Lists the [cluster networks with instance pools](https://docs.oracle.com/iaas/Content/Compute/Tasks/managingclusternetworks.htm) * in the specified compartment. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListClusterNetworksRequest * @return ListClusterNetworksResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListClusterNetworks.ts.html |here} to see how to use ListClusterNetworks API. */ listClusterNetworks(listClusterNetworksRequest: requests.ListClusterNetworksRequest): Promise; /** * NOTE: This function is deprecated in favor of listClusterNetworksRecordIterator function. * Creates a new async iterator which will iterate over the models.ClusterNetworkSummary objects * contained in responses from the listClusterNetworks operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllClusterNetworks(request: requests.ListClusterNetworksRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listClusterNetworksResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listClusterNetworks operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllClusterNetworksResponses(request: requests.ListClusterNetworksRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.ClusterNetworkSummary objects * contained in responses from the listClusterNetworks operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listClusterNetworksRecordIterator(request: requests.ListClusterNetworksRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listClusterNetworks operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listClusterNetworksResponseIterator(request: requests.ListClusterNetworksRequest): AsyncIterableIterator; /** * Lists the instance configurations in the specified compartment. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListInstanceConfigurationsRequest * @return ListInstanceConfigurationsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListInstanceConfigurations.ts.html |here} to see how to use ListInstanceConfigurations API. */ listInstanceConfigurations(listInstanceConfigurationsRequest: requests.ListInstanceConfigurationsRequest): Promise; /** * NOTE: This function is deprecated in favor of listInstanceConfigurationsRecordIterator function. * Creates a new async iterator which will iterate over the models.InstanceConfigurationSummary objects * contained in responses from the listInstanceConfigurations operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllInstanceConfigurations(request: requests.ListInstanceConfigurationsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listInstanceConfigurationsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listInstanceConfigurations operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllInstanceConfigurationsResponses(request: requests.ListInstanceConfigurationsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.InstanceConfigurationSummary objects * contained in responses from the listInstanceConfigurations operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listInstanceConfigurationsRecordIterator(request: requests.ListInstanceConfigurationsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listInstanceConfigurations operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listInstanceConfigurationsResponseIterator(request: requests.ListInstanceConfigurationsRequest): AsyncIterableIterator; /** * List the instances in the specified instance pool. * This operation does not retry by default if the user has not defined a retry configuration. * @param ListInstancePoolInstancesRequest * @return ListInstancePoolInstancesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListInstancePoolInstances.ts.html |here} to see how to use ListInstancePoolInstances API. */ listInstancePoolInstances(listInstancePoolInstancesRequest: requests.ListInstancePoolInstancesRequest): Promise; /** * NOTE: This function is deprecated in favor of listInstancePoolInstancesRecordIterator function. * Creates a new async iterator which will iterate over the models.InstanceSummary objects * contained in responses from the listInstancePoolInstances operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllInstancePoolInstances(request: requests.ListInstancePoolInstancesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listInstancePoolInstancesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listInstancePoolInstances operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllInstancePoolInstancesResponses(request: requests.ListInstancePoolInstancesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.InstanceSummary objects * contained in responses from the listInstancePoolInstances operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listInstancePoolInstancesRecordIterator(request: requests.ListInstancePoolInstancesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listInstancePoolInstances operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listInstancePoolInstancesResponseIterator(request: requests.ListInstancePoolInstancesRequest): AsyncIterableIterator; /** * Lists the instance pools in the specified compartment. * This operation does not retry by default if the user has not defined a retry configuration. * @param ListInstancePoolsRequest * @return ListInstancePoolsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListInstancePools.ts.html |here} to see how to use ListInstancePools API. */ listInstancePools(listInstancePoolsRequest: requests.ListInstancePoolsRequest): Promise; /** * NOTE: This function is deprecated in favor of listInstancePoolsRecordIterator function. * Creates a new async iterator which will iterate over the models.InstancePoolSummary objects * contained in responses from the listInstancePools operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllInstancePools(request: requests.ListInstancePoolsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listInstancePoolsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listInstancePools operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllInstancePoolsResponses(request: requests.ListInstancePoolsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.InstancePoolSummary objects * contained in responses from the listInstancePools operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listInstancePoolsRecordIterator(request: requests.ListInstancePoolsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listInstancePools operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listInstancePoolsResponseIterator(request: requests.ListInstancePoolsRequest): AsyncIterableIterator; /** * Performs the reset (immediate power off and power on) action on the specified instance pool, * which performs the action on all the instances in the pool. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ResetInstancePoolRequest * @return ResetInstancePoolResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ResetInstancePool.ts.html |here} to see how to use ResetInstancePool API. */ resetInstancePool(resetInstancePoolRequest: requests.ResetInstancePoolRequest): Promise; /** * Performs the softreset (ACPI shutdown and power on) action on the specified instance pool, * which performs the action on all the instances in the pool. *

Softreset gracefully reboots the instances by sending a shutdown command to the operating systems. * After waiting 15 minutes for the OS to shut down, the instances are powered off and then powered back on. * * This operation does not retry by default if the user has not defined a retry configuration. * @param SoftresetInstancePoolRequest * @return SoftresetInstancePoolResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/SoftresetInstancePool.ts.html |here} to see how to use SoftresetInstancePool API. */ softresetInstancePool(softresetInstancePoolRequest: requests.SoftresetInstancePoolRequest): Promise; /** * Performs the softstop (ACPI shutdown and power on) action on the specified instance pool, * which performs the action on all the instances in the pool. *

Softstop gracefully reboots the instances by sending a shutdown command to the operating systems. * After waiting 15 minutes for the OS to shutdown, the instances are powered off and then powered back on. * * This operation does not retry by default if the user has not defined a retry configuration. * @param SoftstopInstancePoolRequest * @return SoftstopInstancePoolResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/SoftstopInstancePool.ts.html |here} to see how to use SoftstopInstancePool API. */ softstopInstancePool(softstopInstancePoolRequest: requests.SoftstopInstancePoolRequest): Promise; /** * Performs the start (power on) action on the specified instance pool, * which performs the action on all the instances in the pool. * * This operation does not retry by default if the user has not defined a retry configuration. * @param StartInstancePoolRequest * @return StartInstancePoolResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/StartInstancePool.ts.html |here} to see how to use StartInstancePool API. */ startInstancePool(startInstancePoolRequest: requests.StartInstancePoolRequest): Promise; /** * Performs the stop (immediate power off) action on the specified instance pool, * which performs the action on all the instances in the pool. * * This operation does not retry by default if the user has not defined a retry configuration. * @param StopInstancePoolRequest * @return StopInstancePoolResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/StopInstancePool.ts.html |here} to see how to use StopInstancePool API. */ stopInstancePool(stopInstancePoolRequest: requests.StopInstancePoolRequest): Promise; /** * Deletes (terminates) a [cluster network with instance pools](https://docs.oracle.com/iaas/Content/Compute/Tasks/managingclusternetworks.htm). *

When you delete a cluster network, all of its resources are permanently deleted, * including associated instances and instance pools. * * This operation does not retry by default if the user has not defined a retry configuration. * @param TerminateClusterNetworkRequest * @return TerminateClusterNetworkResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/TerminateClusterNetwork.ts.html |here} to see how to use TerminateClusterNetwork API. */ terminateClusterNetwork(terminateClusterNetworkRequest: requests.TerminateClusterNetworkRequest): Promise; /** * Terminate the specified instance pool. *

**Warning:** When you delete an instance pool, the resources that were created by the pool are permanently * deleted, including associated instances, attached boot volumes, and block volumes. *

If an autoscaling configuration applies to the instance pool, the autoscaling configuration will be deleted * asynchronously after the pool is deleted. You can also manually delete the autoscaling configuration using * the `DeleteAutoScalingConfiguration` operation in the Autoscaling API. * * This operation does not retry by default if the user has not defined a retry configuration. * @param TerminateInstancePoolRequest * @return TerminateInstancePoolResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/TerminateInstancePool.ts.html |here} to see how to use TerminateInstancePool API. */ terminateInstancePool(terminateInstancePoolRequest: requests.TerminateInstancePoolRequest): Promise; /** * Marks an instance in an instance pool to be ready for termination. * * This operation does not retry by default if the user has not defined a retry configuration. * @param TerminationProceedInstancePoolInstanceRequest * @return TerminationProceedInstancePoolInstanceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/TerminationProceedInstancePoolInstance.ts.html |here} to see how to use TerminationProceedInstancePoolInstance API. */ terminationProceedInstancePoolInstance(terminationProceedInstancePoolInstanceRequest: requests.TerminationProceedInstancePoolInstanceRequest): Promise; /** * Updates a [cluster network with instance pools](https://docs.oracle.com/iaas/Content/Compute/Tasks/managingclusternetworks.htm). * The OCID of the cluster network remains the same. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateClusterNetworkRequest * @return UpdateClusterNetworkResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateClusterNetwork.ts.html |here} to see how to use UpdateClusterNetwork API. */ updateClusterNetwork(updateClusterNetworkRequest: requests.UpdateClusterNetworkRequest): Promise; /** * Updates the free-form tags, defined tags, and display name of an instance configuration. * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateInstanceConfigurationRequest * @return UpdateInstanceConfigurationResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateInstanceConfiguration.ts.html |here} to see how to use UpdateInstanceConfiguration API. */ updateInstanceConfiguration(updateInstanceConfigurationRequest: requests.UpdateInstanceConfigurationRequest): Promise; /** * Update the specified instance pool. *

The OCID of the instance pool remains the same. *

If `overridePolicy` is omitted, the stored policy remains unchanged. * Provide a non-null `overridePolicy` to replace the stored policy as a whole. * Provide `null` to clear the stored policy for future launches. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateInstancePoolRequest * @return UpdateInstancePoolResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateInstancePool.ts.html |here} to see how to use UpdateInstancePool API. */ updateInstancePool(updateInstancePoolRequest: requests.UpdateInstancePoolRequest): Promise; } export declare enum VirtualNetworkApiKeys { } /** * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user. */ export declare class VirtualNetworkClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_waiters": VirtualNetworkWaiter; protected "_clientConfiguration": common.ClientConfiguration; protected _circuitBreaker: typeof Breaker | null; protected _httpOptions: any; protected _bodyDuplexMode: any; targetService: string; protected _regionId: string; protected "_region": common.Region; protected _lastSetRegionOrRegionId: string; protected _enableDualstackEndpoint: boolean | undefined; protected _serviceUsesDualStackByDefault: boolean; protected _httpClient: common.HttpClient; protected _authProvider: common.AuthenticationDetailsProvider | undefined; constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration); /** * Get the endpoint that is being used to call (ex, https://www.example.com). */ get endpoint(): string; /** * Sets the endpoint to call (ex, https://www.example.com). * @param endpoint The endpoint of the service. */ set endpoint(endpoint: string); get logger(): import("oci-common/lib/log").Logger; /** * Determines whether realm specific endpoint should be used or not. * Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false" * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template */ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean); /** * Sets the region to call (ex, Region.US_PHOENIX_1). * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint. * @param region The region of the service. */ set region(region: common.Region); /** * Sets the regionId to call (ex, 'us-phoenix-1'). * * Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. * If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 * and then call {@link #endpoint(String) endpoint}. * @param regionId The public region ID. */ set regionId(regionId: string); set enableDualstackEndpoint(enableDualstackEndpoint: boolean); /** * Creates a new VirtualNetworkWaiter for resources for this service. * * @param workRequestClient The work request service client used to query for work request status * @param config The waiter configuration for termination and delay strategy * @return The service waiters. */ createWaiters(workRequestClient: WorkRequestClient, config?: common.WaiterConfiguration): VirtualNetworkWaiter; /** * Gets the waiters available for resources for this service. * * @return The service waiters. */ getWaiters(): VirtualNetworkWaiter; /** * Shutdown the circuit breaker used by the client when it is no longer needed */ shutdownCircuitBreaker(): void; /** * Close the provider if possible which in turn shuts down any associated circuit breaker */ closeProvider(): void; /** * Close the client once it is no longer needed */ close(): void; /** * Adds DRG NAT rules to the specified DRG NAT policy. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param AddDrgNatRulesRequest * @return AddDrgNatRulesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/AddDrgNatRules.ts.html |here} to see how to use AddDrgNatRules API. */ addDrgNatRules(addDrgNatRulesRequest: requests.AddDrgNatRulesRequest): Promise; /** * Adds one or more route distribution statements to the specified route distribution. * * This operation does not retry by default if the user has not defined a retry configuration. * @param AddDrgRouteDistributionStatementsRequest * @return AddDrgRouteDistributionStatementsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/AddDrgRouteDistributionStatements.ts.html |here} to see how to use AddDrgRouteDistributionStatements API. */ addDrgRouteDistributionStatements(addDrgRouteDistributionStatementsRequest: requests.AddDrgRouteDistributionStatementsRequest): Promise; /** * Adds one or more static route rules to the specified DRG route table. * * This operation does not retry by default if the user has not defined a retry configuration. * @param AddDrgRouteRulesRequest * @return AddDrgRouteRulesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/AddDrgRouteRules.ts.html |here} to see how to use AddDrgRouteRules API. */ addDrgRouteRules(addDrgRouteRulesRequest: requests.AddDrgRouteRulesRequest): Promise; /** * Add an IPv4 prefix to a subnet. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param AddIpv4SubnetCidrRequest * @return AddIpv4SubnetCidrResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/AddIpv4SubnetCidr.ts.html |here} to see how to use AddIpv4SubnetCidr API. */ addIpv4SubnetCidr(addIpv4SubnetCidrRequest: requests.AddIpv4SubnetCidrRequest): Promise; /** * Add an IPv6 prefix to a subnet. * * This operation does not retry by default if the user has not defined a retry configuration. * @param AddIpv6SubnetCidrRequest * @return AddIpv6SubnetCidrResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/AddIpv6SubnetCidr.ts.html |here} to see how to use AddIpv6SubnetCidr API. */ addIpv6SubnetCidr(addIpv6SubnetCidrRequest: requests.AddIpv6SubnetCidrRequest): Promise; /** * 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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param AddIpv6VcnCidrRequest * @return AddIpv6VcnCidrResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/AddIpv6VcnCidr.ts.html |here} to see how to use AddIpv6VcnCidr API. */ addIpv6VcnCidr(addIpv6VcnCidrRequest: requests.AddIpv6VcnCidrRequest): Promise; /** * Adds up to 25 security rules to the specified network security group. Adding more than 25 rules requires multiple operations. * * This operation does not retry by default if the user has not defined a retry configuration. * @param AddNetworkSecurityGroupSecurityRulesRequest * @return AddNetworkSecurityGroupSecurityRulesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/AddNetworkSecurityGroupSecurityRules.ts.html |here} to see how to use AddNetworkSecurityGroupSecurityRules API. */ addNetworkSecurityGroupSecurityRules(addNetworkSecurityGroupSecurityRulesRequest: requests.AddNetworkSecurityGroupSecurityRulesRequest): Promise; /** * Adds some or all of a CIDR block to a public IP pool. *

The CIDR block (or subrange) must not overlap with any other CIDR block already added to this or any other public IP pool. * * This operation does not retry by default if the user has not defined a retry configuration. * @param AddPublicIpPoolCapacityRequest * @return AddPublicIpPoolCapacityResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/AddPublicIpPoolCapacity.ts.html |here} to see how to use AddPublicIpPoolCapacity API. */ addPublicIpPoolCapacity(addPublicIpPoolCapacityRequest: requests.AddPublicIpPoolCapacityRequest): Promise; /** * Adds a CIDR block to a VCN. The CIDR block you add: *

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

**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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param AddVcnCidrRequest * @return AddVcnCidrResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/AddVcnCidr.ts.html |here} to see how to use AddVcnCidr API. */ addVcnCidr(addVcnCidrRequest: requests.AddVcnCidrRequest): Promise; /** * 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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param AdvertiseByoipRangeRequest * @return AdvertiseByoipRangeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/AdvertiseByoipRange.ts.html |here} to see how to use AdvertiseByoipRange API. */ advertiseByoipRange(advertiseByoipRangeRequest: requests.AdvertiseByoipRangeRequest): Promise; /** * 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}. *

**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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param AttachServiceIdRequest * @return AttachServiceIdResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/AttachServiceId.ts.html |here} to see how to use AttachServiceId API. */ attachServiceId(attachServiceIdRequest: requests.AttachServiceIdRequest): Promise; /** * 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. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param BulkAddVirtualCircuitPublicPrefixesRequest * @return BulkAddVirtualCircuitPublicPrefixesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/BulkAddVirtualCircuitPublicPrefixes.ts.html |here} to see how to use BulkAddVirtualCircuitPublicPrefixes API. */ bulkAddVirtualCircuitPublicPrefixes(bulkAddVirtualCircuitPublicPrefixesRequest: requests.BulkAddVirtualCircuitPublicPrefixesRequest): Promise; /** * Create new IPv6s in bulk for a VNIC or subnet. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param BulkCreateIpv6sRequest * @return BulkCreateIpv6sResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/BulkCreateIpv6s.ts.html |here} to see how to use BulkCreateIpv6s API. */ bulkCreateIpv6s(bulkCreateIpv6sRequest: requests.BulkCreateIpv6sRequest): Promise; /** * Create secondary private IPv4 addresses. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param BulkCreatePrivateIpsRequest * @return BulkCreatePrivateIpsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/BulkCreatePrivateIps.ts.html |here} to see how to use BulkCreatePrivateIps API. */ bulkCreatePrivateIps(bulkCreatePrivateIpsRequest: requests.BulkCreatePrivateIpsRequest): Promise; /** * Unassign and delete IPv6s for a VNIC in bulk. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param BulkDeleteIpv6sRequest * @return BulkDeleteIpv6sResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/BulkDeleteIpv6s.ts.html |here} to see how to use BulkDeleteIpv6s API. */ bulkDeleteIpv6s(bulkDeleteIpv6sRequest: requests.BulkDeleteIpv6sRequest): Promise; /** * Unassign and delete secondary private IPv4s for a VNIC. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param BulkDeletePrivateIpsRequest * @return BulkDeletePrivateIpsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/BulkDeletePrivateIps.ts.html |here} to see how to use BulkDeletePrivateIps API. */ bulkDeletePrivateIps(bulkDeletePrivateIpsRequest: requests.BulkDeletePrivateIpsRequest): Promise; /** * 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. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param BulkDeleteVirtualCircuitPublicPrefixesRequest * @return BulkDeleteVirtualCircuitPublicPrefixesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/BulkDeleteVirtualCircuitPublicPrefixes.ts.html |here} to see how to use BulkDeleteVirtualCircuitPublicPrefixes API. */ bulkDeleteVirtualCircuitPublicPrefixes(bulkDeleteVirtualCircuitPublicPrefixesRequest: requests.BulkDeleteVirtualCircuitPublicPrefixesRequest): Promise; /** * Detach the specified IPv6s. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param BulkDetachIpv6sRequest * @return BulkDetachIpv6sResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/BulkDetachIpv6s.ts.html |here} to see how to use BulkDetachIpv6s API. */ bulkDetachIpv6s(bulkDetachIpv6sRequest: requests.BulkDetachIpv6sRequest): Promise; /** * Unassign the specified private IP addresses from the Virtual Network Interface Card (VNIC). You must specify the PrivateIP object's [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param BulkDetachPrivateIpsRequest * @return BulkDetachPrivateIpsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/BulkDetachPrivateIps.ts.html |here} to see how to use BulkDetachPrivateIps API. */ bulkDetachPrivateIps(bulkDetachPrivateIpsRequest: requests.BulkDetachPrivateIpsRequest): Promise; /** * Updates the specified IPv6s in bulk. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param BulkUpdateIpv6sRequest * @return BulkUpdateIpv6sResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/BulkUpdateIpv6s.ts.html |here} to see how to use BulkUpdateIpv6s API. */ bulkUpdateIpv6s(bulkUpdateIpv6sRequest: requests.BulkUpdateIpv6sRequest): Promise; /** * Update existing secondary private IPv4s for a VNIC. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param BulkUpdatePrivateIpsRequest * @return BulkUpdatePrivateIpsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/BulkUpdatePrivateIps.ts.html |here} to see how to use BulkUpdatePrivateIps API. */ bulkUpdatePrivateIps(bulkUpdatePrivateIpsRequest: requests.BulkUpdatePrivateIpsRequest): Promise; /** * Moves a BYOASN Resource to a different compartment. For information * about moving resources between compartments, see * [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ChangeByoasnCompartmentRequest * @return ChangeByoasnCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeByoasnCompartment.ts.html |here} to see how to use ChangeByoasnCompartment API. */ changeByoasnCompartment(changeByoasnCompartmentRequest: requests.ChangeByoasnCompartmentRequest): Promise; /** * Moves a BYOIP CIDR block to a different compartment. For information * about moving resources between compartments, see * [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeByoipRangeCompartmentRequest * @return ChangeByoipRangeCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeByoipRangeCompartment.ts.html |here} to see how to use ChangeByoipRangeCompartment API. */ changeByoipRangeCompartment(changeByoipRangeCompartmentRequest: requests.ChangeByoipRangeCompartmentRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeCaptureFilterCompartmentRequest * @return ChangeCaptureFilterCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeCaptureFilterCompartment.ts.html |here} to see how to use ChangeCaptureFilterCompartment API. */ changeCaptureFilterCompartment(changeCaptureFilterCompartmentRequest: requests.ChangeCaptureFilterCompartmentRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ChangeCpeCompartmentRequest * @return ChangeCpeCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeCpeCompartment.ts.html |here} to see how to use ChangeCpeCompartment API. */ changeCpeCompartment(changeCpeCompartmentRequest: requests.ChangeCpeCompartmentRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ChangeCrossConnectCompartmentRequest * @return ChangeCrossConnectCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeCrossConnectCompartment.ts.html |here} to see how to use ChangeCrossConnectCompartment API. */ changeCrossConnectCompartment(changeCrossConnectCompartmentRequest: requests.ChangeCrossConnectCompartmentRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ChangeCrossConnectGroupCompartmentRequest * @return ChangeCrossConnectGroupCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeCrossConnectGroupCompartment.ts.html |here} to see how to use ChangeCrossConnectGroupCompartment API. */ changeCrossConnectGroupCompartment(changeCrossConnectGroupCompartmentRequest: requests.ChangeCrossConnectGroupCompartmentRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeDhcpOptionsCompartmentRequest * @return ChangeDhcpOptionsCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeDhcpOptionsCompartment.ts.html |here} to see how to use ChangeDhcpOptionsCompartment API. */ changeDhcpOptionsCompartment(changeDhcpOptionsCompartmentRequest: requests.ChangeDhcpOptionsCompartmentRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeDrgCompartmentRequest * @return ChangeDrgCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeDrgCompartment.ts.html |here} to see how to use ChangeDrgCompartment API. */ changeDrgCompartment(changeDrgCompartmentRequest: requests.ChangeDrgCompartmentRequest): Promise; /** * Moves a DrgNatPolicy into a different compartment within the same tenancy. For information * about moving resources between compartments, see * [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeDrgNatPolicyCompartmentRequest * @return ChangeDrgNatPolicyCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeDrgNatPolicyCompartment.ts.html |here} to see how to use ChangeDrgNatPolicyCompartment API. */ changeDrgNatPolicyCompartment(changeDrgNatPolicyCompartmentRequest: requests.ChangeDrgNatPolicyCompartmentRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ChangeIPSecConnectionCompartmentRequest * @return ChangeIPSecConnectionCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeIPSecConnectionCompartment.ts.html |here} to see how to use ChangeIPSecConnectionCompartment API. */ changeIPSecConnectionCompartment(changeIPSecConnectionCompartmentRequest: requests.ChangeIPSecConnectionCompartmentRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeInternetGatewayCompartmentRequest * @return ChangeInternetGatewayCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeInternetGatewayCompartment.ts.html |here} to see how to use ChangeInternetGatewayCompartment API. */ changeInternetGatewayCompartment(changeInternetGatewayCompartmentRequest: requests.ChangeInternetGatewayCompartmentRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeLocalPeeringGatewayCompartmentRequest * @return ChangeLocalPeeringGatewayCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeLocalPeeringGatewayCompartment.ts.html |here} to see how to use ChangeLocalPeeringGatewayCompartment API. */ changeLocalPeeringGatewayCompartment(changeLocalPeeringGatewayCompartmentRequest: requests.ChangeLocalPeeringGatewayCompartmentRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeNatGatewayCompartmentRequest * @return ChangeNatGatewayCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeNatGatewayCompartment.ts.html |here} to see how to use ChangeNatGatewayCompartment API. */ changeNatGatewayCompartment(changeNatGatewayCompartmentRequest: requests.ChangeNatGatewayCompartmentRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeNetworkSecurityGroupCompartmentRequest * @return ChangeNetworkSecurityGroupCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeNetworkSecurityGroupCompartment.ts.html |here} to see how to use ChangeNetworkSecurityGroupCompartment API. */ changeNetworkSecurityGroupCompartment(changeNetworkSecurityGroupCompartmentRequest: requests.ChangeNetworkSecurityGroupCompartmentRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). *

This operation applies only to reserved public IPs. Ephemeral public IPs always belong to the * same compartment as their VNIC and move accordingly. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangePublicIpCompartmentRequest * @return ChangePublicIpCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangePublicIpCompartment.ts.html |here} to see how to use ChangePublicIpCompartment API. */ changePublicIpCompartment(changePublicIpCompartmentRequest: requests.ChangePublicIpCompartmentRequest): Promise; /** * Moves a public IP pool to a different compartment. For information * about moving resources between compartments, see * [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangePublicIpPoolCompartmentRequest * @return ChangePublicIpPoolCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangePublicIpPoolCompartment.ts.html |here} to see how to use ChangePublicIpPoolCompartment API. */ changePublicIpPoolCompartment(changePublicIpPoolCompartmentRequest: requests.ChangePublicIpPoolCompartmentRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ChangeRemotePeeringConnectionCompartmentRequest * @return ChangeRemotePeeringConnectionCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeRemotePeeringConnectionCompartment.ts.html |here} to see how to use ChangeRemotePeeringConnectionCompartment API. */ changeRemotePeeringConnectionCompartment(changeRemotePeeringConnectionCompartmentRequest: requests.ChangeRemotePeeringConnectionCompartmentRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeRouteTableCompartmentRequest * @return ChangeRouteTableCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeRouteTableCompartment.ts.html |here} to see how to use ChangeRouteTableCompartment API. */ changeRouteTableCompartment(changeRouteTableCompartmentRequest: requests.ChangeRouteTableCompartmentRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeSecurityListCompartmentRequest * @return ChangeSecurityListCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeSecurityListCompartment.ts.html |here} to see how to use ChangeSecurityListCompartment API. */ changeSecurityListCompartment(changeSecurityListCompartmentRequest: requests.ChangeSecurityListCompartmentRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeServiceGatewayCompartmentRequest * @return ChangeServiceGatewayCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeServiceGatewayCompartment.ts.html |here} to see how to use ChangeServiceGatewayCompartment API. */ changeServiceGatewayCompartment(changeServiceGatewayCompartmentRequest: requests.ChangeServiceGatewayCompartmentRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeSubnetCompartmentRequest * @return ChangeSubnetCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeSubnetCompartment.ts.html |here} to see how to use ChangeSubnetCompartment API. */ changeSubnetCompartment(changeSubnetCompartmentRequest: requests.ChangeSubnetCompartmentRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeVcnCompartmentRequest * @return ChangeVcnCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeVcnCompartment.ts.html |here} to see how to use ChangeVcnCompartment API. */ changeVcnCompartment(changeVcnCompartmentRequest: requests.ChangeVcnCompartmentRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ChangeVirtualCircuitCompartmentRequest * @return ChangeVirtualCircuitCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeVirtualCircuitCompartment.ts.html |here} to see how to use ChangeVirtualCircuitCompartment API. */ changeVirtualCircuitCompartment(changeVirtualCircuitCompartmentRequest: requests.ChangeVirtualCircuitCompartmentRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeVlanCompartmentRequest * @return ChangeVlanCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeVlanCompartment.ts.html |here} to see how to use ChangeVlanCompartment API. */ changeVlanCompartment(changeVlanCompartmentRequest: requests.ChangeVlanCompartmentRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeVtapCompartmentRequest * @return ChangeVtapCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ChangeVtapCompartment.ts.html |here} to see how to use ChangeVtapCompartment API. */ changeVtapCompartment(changeVtapCompartmentRequest: requests.ChangeVtapCompartmentRequest): Promise; /** * Connects this local peering gateway (LPG) to another one in the same region. *

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](https://docs.oracle.com/iaas/Content/Network/Tasks/VCNpeering.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ConnectLocalPeeringGatewaysRequest * @return ConnectLocalPeeringGatewaysResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ConnectLocalPeeringGateways.ts.html |here} to see how to use ConnectLocalPeeringGateways API. */ connectLocalPeeringGateways(connectLocalPeeringGatewaysRequest: requests.ConnectLocalPeeringGatewaysRequest): Promise; /** * Connects this RPC to another one in a different region. *

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](https://docs.oracle.com/iaas/Content/Network/Tasks/VCNpeering.htm). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ConnectRemotePeeringConnectionsRequest * @return ConnectRemotePeeringConnectionsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ConnectRemotePeeringConnections.ts.html |here} to see how to use ConnectRemotePeeringConnections API. */ connectRemotePeeringConnections(connectRemotePeeringConnectionsRequest: requests.ConnectRemotePeeringConnectionsRequest): Promise; /** * Creates a BYOASN Resource * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateByoasnRequest * @return CreateByoasnResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateByoasn.ts.html |here} to see how to use CreateByoasn API. */ createByoasn(createByoasnRequest: requests.CreateByoasnRequest): Promise; /** * Creates a subrange of the BYOIP CIDR block. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateByoipRangeRequest * @return CreateByoipRangeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateByoipRange.ts.html |here} to see how to use CreateByoipRange API. */ createByoipRange(createByoipRangeRequest: requests.CreateByoipRangeRequest): Promise; /** * Creates a virtual test access point (VTAP) capture filter in the specified compartment. *

For the purposes of access control, you must provide the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains * the VTAP. For more information about compartments and access control, see * [Overview of the IAM Service](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). * For information about OCIDs, see [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). *

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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateCaptureFilterRequest * @return CreateCaptureFilterResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateCaptureFilter.ts.html |here} to see how to use CreateCaptureFilter API. */ createCaptureFilter(createCaptureFilterRequest: requests.CreateCaptureFilterRequest): Promise; /** * Creates a new virtual customer-premises equipment (CPE) object in the specified compartment. For * more information, see [Site-to-Site VPN Overview](https://docs.oracle.com/iaas/Content/Network/Tasks/overviewIPsec.htm). *

For the purposes of access control, you must provide the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). * For information about OCIDs, see [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). *

You must provide the public IP address of your on-premises router. See * [CPE Configuration](https://docs.oracle.com/iaas/Content/Network/Tasks/configuringCPE.htm). *

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. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateCpeRequest * @return CreateCpeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateCpe.ts.html |here} to see how to use CreateCpe API. */ createCpe(createCpeRequest: requests.CreateCpeRequest): Promise; /** * 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. *

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](https://docs.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm). *

For the purposes of access control, you must provide the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). * For information about OCIDs, see * [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). *

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. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateCrossConnectRequest * @return CreateCrossConnectResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateCrossConnect.ts.html |here} to see how to use CreateCrossConnect API. */ createCrossConnect(createCrossConnectRequest: requests.CreateCrossConnectRequest): Promise; /** * Creates a new cross-connect group to use with Oracle Cloud Infrastructure * FastConnect. For more information, see * [FastConnect Overview](https://docs.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm). *

For the purposes of access control, you must provide the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). * For information about OCIDs, see * [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). *

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. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateCrossConnectGroupRequest * @return CreateCrossConnectGroupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateCrossConnectGroup.ts.html |here} to see how to use CreateCrossConnectGroup API. */ createCrossConnectGroup(createCrossConnectGroupRequest: requests.CreateCrossConnectGroupRequest): Promise; /** * Creates a new set of DHCP options for the specified VCN. For more information, see * {@link DhcpOptions}. *

For the purposes of access control, you must provide the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see * [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). *

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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateDhcpOptionsRequest * @return CreateDhcpOptionsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateDhcpOptions.ts.html |here} to see how to use CreateDhcpOptions API. */ createDhcpOptions(createDhcpOptionsRequest: requests.CreateDhcpOptionsRequest): Promise; /** * Creates a new dynamic routing gateway (DRG) in the specified compartment. For more information, * see [Dynamic Routing Gateways (DRGs)](https://docs.oracle.com/iaas/Content/Network/Tasks/managingDRGs.htm). *

For the purposes of access control, you must provide the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). * For information about OCIDs, see [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). *

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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateDrgRequest * @return CreateDrgResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateDrg.ts.html |here} to see how to use CreateDrg API. */ createDrg(createDrgRequest: requests.CreateDrgRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). For more information about DRGs, see * [Dynamic Routing Gateways (DRGs)](https://docs.oracle.com/iaas/Content/Network/Tasks/managingDRGs.htm). *

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

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](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateDrgAttachmentRequest * @return CreateDrgAttachmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateDrgAttachment.ts.html |here} to see how to use CreateDrgAttachment API. */ createDrgAttachment(createDrgAttachmentRequest: requests.CreateDrgAttachmentRequest): Promise; /** * Creates a new DRG NAT policy. Assign the DRG NAT policy to a DRG attachment * using the `UpdateDrgAttachment` or `CreateDrgAttachment` operations. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateDrgNatPolicyRequest * @return CreateDrgNatPolicyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateDrgNatPolicy.ts.html |here} to see how to use CreateDrgNatPolicy API. */ createDrgNatPolicy(createDrgNatPolicyRequest: requests.CreateDrgNatPolicyRequest): Promise; /** * 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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateDrgRouteDistributionRequest * @return CreateDrgRouteDistributionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateDrgRouteDistribution.ts.html |here} to see how to use CreateDrgRouteDistribution API. */ createDrgRouteDistribution(createDrgRouteDistributionRequest: requests.CreateDrgRouteDistributionRequest): Promise; /** * 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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateDrgRouteTableRequest * @return CreateDrgRouteTableResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateDrgRouteTable.ts.html |here} to see how to use CreateDrgRouteTable API. */ createDrgRouteTable(createDrgRouteTableRequest: requests.CreateDrgRouteTableRequest): Promise; /** * Creates a new IPSec connection between the specified DRG and CPE. For more information, see * [Site-to-Site VPN Overview](https://docs.oracle.com/iaas/Content/Network/Tasks/overviewIPsec.htm). *

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}. *

For the purposes of access control, you must provide the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). *

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

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: *

* {@link IPSecConnectionTunnel} * * {@link IPSecConnectionTunnelSharedSecret} *

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](https://docs.oracle.com/iaas/Content/Network/Tasks/configuringCPE.htm). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateIPSecConnectionRequest * @return CreateIPSecConnectionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateIPSecConnection.ts.html |here} to see how to use CreateIPSecConnection API. */ createIPSecConnection(createIPSecConnectionRequest: requests.CreateIPSecConnectionRequest): Promise; /** * Creates a new internet gateway for the specified VCN. For more information, see * [Access to the Internet](https://docs.oracle.com/iaas/Content/Network/Tasks/managingIGs.htm). *

For the purposes of access control, you must provide the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). *

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

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}. *

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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateInternetGatewayRequest * @return CreateInternetGatewayResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateInternetGateway.ts.html |here} to see how to use CreateInternetGateway API. */ createInternetGateway(createInternetGatewayRequest: requests.CreateInternetGatewayRequest): Promise; /** * Creates an IPv6 for the specified VNIC. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateIpv6Request * @return CreateIpv6Response * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateIpv6.ts.html |here} to see how to use CreateIpv6 API. */ createIpv6(createIpv6Request: requests.CreateIpv6Request): Promise; /** * Creates a new local peering gateway (LPG) for the specified VCN. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateLocalPeeringGatewayRequest * @return CreateLocalPeeringGatewayResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateLocalPeeringGateway.ts.html |here} to see how to use CreateLocalPeeringGateway API. */ createLocalPeeringGateway(createLocalPeeringGatewayRequest: requests.CreateLocalPeeringGatewayRequest): Promise; /** * 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}. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateNatGatewayRequest * @return CreateNatGatewayResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateNatGateway.ts.html |here} to see how to use CreateNatGateway API. */ createNatGateway(createNatGatewayRequest: requests.CreateNatGatewayRequest): Promise; /** * Creates a new network security group for the specified VCN. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateNetworkSecurityGroupRequest * @return CreateNetworkSecurityGroupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateNetworkSecurityGroup.ts.html |here} to see how to use CreateNetworkSecurityGroup API. */ createNetworkSecurityGroup(createNetworkSecurityGroupRequest: requests.CreateNetworkSecurityGroupRequest): Promise; /** * Creates a private IP. * For more information about private IPs, see * [IP Addresses](https://docs.oracle.com/iaas/Content/Network/Tasks/managingIPaddresses.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreatePrivateIpRequest * @return CreatePrivateIpResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreatePrivateIp.ts.html |here} to see how to use CreatePrivateIp API. */ createPrivateIp(createPrivateIpRequest: requests.CreatePrivateIpRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Network/Tasks/managingpublicIPs.htm). *

* **For an ephemeral public IP assigned to a private IP:** You must also specify a `privateIpId` * with the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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. *

* **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}. *

**Note:** When assigning a public IP to a private IP, the private IP must not already have * a public IP with `lifecycleState` = ASSIGNING or ASSIGNED. If it does, an error is returned. *

Also, for reserved public IPs, the optional assignment part of this operation is * asynchronous. Poll the public IP's `lifecycleState` to determine if the assignment * succeeded. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreatePublicIpRequest * @return CreatePublicIpResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreatePublicIp.ts.html |here} to see how to use CreatePublicIp API. */ createPublicIp(createPublicIpRequest: requests.CreatePublicIpRequest): Promise; /** * Creates a public IP pool. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreatePublicIpPoolRequest * @return CreatePublicIpPoolResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreatePublicIpPool.ts.html |here} to see how to use CreatePublicIpPool API. */ createPublicIpPool(createPublicIpPoolRequest: requests.CreatePublicIpPoolRequest): Promise; /** * Creates a new remote peering connection (RPC) for the specified DRG. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateRemotePeeringConnectionRequest * @return CreateRemotePeeringConnectionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateRemotePeeringConnection.ts.html |here} to see how to use CreateRemotePeeringConnection API. */ createRemotePeeringConnection(createRemotePeeringConnectionRequest: requests.CreateRemotePeeringConnectionRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/General/Concepts/servicelimits.htm). For general information about route * tables in your VCN and the types of targets you can use in route rules, * see [Route Tables](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm). *

For the purposes of access control, you must provide the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see * [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). *

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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateRouteTableRequest * @return CreateRouteTableResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateRouteTable.ts.html |here} to see how to use CreateRouteTable API. */ createRouteTable(createRouteTableRequest: requests.CreateRouteTableRequest): Promise; /** * Creates a new security list for the specified VCN. For more information * about security lists, see [Security Lists](https://docs.oracle.com/iaas/Content/Network/Concepts/securitylists.htm). * For information on the number of rules you can have in a security list, see * [Service Limits](https://docs.oracle.com/iaas/Content/General/Concepts/servicelimits.htm). *

For the purposes of access control, you must provide the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see * [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). *

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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateSecurityListRequest * @return CreateSecurityListResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateSecurityList.ts.html |here} to see how to use CreateSecurityList API. */ createSecurityList(createSecurityListRequest: requests.CreateSecurityListRequest): Promise; /** * Creates a new service gateway in the specified compartment. *

For the purposes of access control, you must provide the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). * For information about OCIDs, see [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). *

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

Use the {@link #listServices(ListServicesRequest) listServices} operation to find service CIDR labels * available in the region. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateServiceGatewayRequest * @return CreateServiceGatewayResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateServiceGateway.ts.html |here} to see how to use CreateServiceGateway API. */ createServiceGateway(createServiceGatewayRequest: requests.CreateServiceGatewayRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Network/Tasks/managingVCNs.htm). * For information on the number of subnets you can have in a VCN, see * [Service Limits](https://docs.oracle.com/iaas/Content/General/Concepts/servicelimits.htm). *

For the purposes of access control, you must provide the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, * see [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). *

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](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm). *

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](https://docs.oracle.com/iaas/Content/Network/Concepts/securitylists.htm). *

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](https://docs.oracle.com/iaas/Content/Network/Tasks/managingDHCP.htm). *

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

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](https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateSubnetRequest * @return CreateSubnetResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateSubnet.ts.html |here} to see how to use CreateSubnet API. */ createSubnet(createSubnetRequest: requests.CreateSubnetRequest): Promise; /** * Creates a new virtual cloud network (VCN). For more information, see * [VCNs and Subnets](https://docs.oracle.com/iaas/Content/Network/Tasks/managingVCNs.htm). *

For the VCN, you specify a list of one or more IPv4 CIDR blocks that meet the following criteria: *

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

For a CIDR block, Oracle recommends that you use one of the private IP address ranges specified in [RFC 1918](https://tools.ietf.org/html/rfc1918) (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. *

For the purposes of access control, you must provide the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see * [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). *

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

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](https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm). *

The VCN automatically comes with a default route table, default security list, and default set of DHCP options. * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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). *

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](https://docs.oracle.com/iaas/Content/Network/Concepts/overview.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateVcnRequest * @return CreateVcnResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateVcn.ts.html |here} to see how to use CreateVcn API. */ createVcn(createVcnRequest: requests.CreateVcnRequest): Promise; /** * Creates a new virtual circuit to use with Oracle Cloud * Infrastructure FastConnect. For more information, see * [FastConnect Overview](https://docs.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm). *

For the purposes of access control, you must provide the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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.oracle.com/iaas/Content/Identity/Concepts/overview.htm). * For information about OCIDs, see * [Resource Identifiers](https://docs.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.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateVirtualCircuitRequest * @return CreateVirtualCircuitResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateVirtualCircuit.ts.html |here} to see how to use CreateVirtualCircuit API. */ createVirtualCircuit(createVirtualCircuitRequest: requests.CreateVirtualCircuitRequest): Promise; /** * Creates a VLAN in the specified VCN and the specified compartment. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateVlanRequest * @return CreateVlanResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateVlan.ts.html |here} to see how to use CreateVlan API. */ createVlan(createVlanRequest: requests.CreateVlanRequest): Promise; /** * Creates a virtual test access point (VTAP) in the specified compartment. *

For the purposes of access control, you must provide the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the VTAP. * For more information about compartments and access control, see * [Overview of the IAM Service](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). * For information about OCIDs, see [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). *

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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateVtapRequest * @return CreateVtapResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/CreateVtap.ts.html |here} to see how to use CreateVtap API. */ createVtap(createVtapRequest: requests.CreateVtapRequest): Promise; /** * Deletes the specified `Byoasn` resource. * The resource must be in one of the following states: CREATING, ACTIVE or FAILED. * It must not be in use by any of the byoipRanges or deletion will fail. * You must specify the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteByoasnRequest * @return DeleteByoasnResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteByoasn.ts.html |here} to see how to use DeleteByoasn API. */ deleteByoasn(deleteByoasnRequest: requests.DeleteByoasnRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * If the `ByoipRange` resource is currently in the PROVISIONED or ACTIVE state, it will be de-provisioned and then deleted. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteByoipRangeRequest * @return DeleteByoipRangeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteByoipRange.ts.html |here} to see how to use DeleteByoipRange API. */ deleteByoipRange(deleteByoipRangeRequest: requests.DeleteByoipRangeRequest): Promise; /** * 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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteCaptureFilterRequest * @return DeleteCaptureFilterResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteCaptureFilter.ts.html |here} to see how to use DeleteCaptureFilter API. */ deleteCaptureFilter(deleteCaptureFilterRequest: requests.DeleteCaptureFilterRequest): Promise; /** * 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. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param DeleteCpeRequest * @return DeleteCpeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteCpe.ts.html |here} to see how to use DeleteCpe API. */ deleteCpe(deleteCpeRequest: requests.DeleteCpeRequest): Promise; /** * Deletes the specified cross-connect. It must not be mapped to a * {@link VirtualCircuit}. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param DeleteCrossConnectRequest * @return DeleteCrossConnectResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteCrossConnect.ts.html |here} to see how to use DeleteCrossConnect API. */ deleteCrossConnect(deleteCrossConnectRequest: requests.DeleteCrossConnectRequest): Promise; /** * Deletes the specified cross-connect group. It must not contain any * cross-connects, and it cannot be mapped to a * {@link VirtualCircuit}. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param DeleteCrossConnectGroupRequest * @return DeleteCrossConnectGroupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteCrossConnectGroup.ts.html |here} to see how to use DeleteCrossConnectGroup API. */ deleteCrossConnectGroup(deleteCrossConnectGroupRequest: requests.DeleteCrossConnectGroupRequest): Promise; /** * 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. *

This is an asynchronous operation. The state of the set of options will switch to TERMINATING temporarily * until the set is completely removed. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteDhcpOptionsRequest * @return DeleteDhcpOptionsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteDhcpOptions.ts.html |here} to see how to use DeleteDhcpOptions API. */ deleteDhcpOptions(deleteDhcpOptionsRequest: requests.DeleteDhcpOptionsRequest): Promise; /** * 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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteDrgRequest * @return DeleteDrgResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteDrg.ts.html |here} to see how to use DeleteDrg API. */ deleteDrg(deleteDrgRequest: requests.DeleteDrgRequest): Promise; /** * 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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteDrgAttachmentRequest * @return DeleteDrgAttachmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteDrgAttachment.ts.html |here} to see how to use DeleteDrgAttachment API. */ deleteDrgAttachment(deleteDrgAttachmentRequest: requests.DeleteDrgAttachmentRequest): Promise; /** * Deletes the specified DRG NAT policy. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param DeleteDrgNatPolicyRequest * @return DeleteDrgNatPolicyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteDrgNatPolicy.ts.html |here} to see how to use DeleteDrgNatPolicy API. */ deleteDrgNatPolicy(deleteDrgNatPolicyRequest: requests.DeleteDrgNatPolicyRequest): Promise; /** * Deletes the specified route distribution. You can't delete a route distribution currently in use by a DRG attachment or DRG route table. *

Remove the DRG route distribution from a DRG attachment or DRG route table by using the \"RemoveExportDrgRouteDistribution\" or \"RemoveImportDrgRouteDistribution' operations. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteDrgRouteDistributionRequest * @return DeleteDrgRouteDistributionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteDrgRouteDistribution.ts.html |here} to see how to use DeleteDrgRouteDistribution API. */ deleteDrgRouteDistribution(deleteDrgRouteDistributionRequest: requests.DeleteDrgRouteDistributionRequest): Promise; /** * Deletes the specified DRG route table. There must not be any DRG attachments assigned. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteDrgRouteTableRequest * @return DeleteDrgRouteTableResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteDrgRouteTable.ts.html |here} to see how to use DeleteDrgRouteTable API. */ deleteDrgRouteTable(deleteDrgRouteTableRequest: requests.DeleteDrgRouteTableRequest): Promise; /** * 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}. *

This is an asynchronous operation. The connection's `lifecycleState` will change to TERMINATING temporarily * until the connection is completely removed. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param DeleteIPSecConnectionRequest * @return DeleteIPSecConnectionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteIPSecConnection.ts.html |here} to see how to use DeleteIPSecConnection API. */ deleteIPSecConnection(deleteIPSecConnectionRequest: requests.DeleteIPSecConnectionRequest): Promise; /** * 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. *

This is an asynchronous operation. The gateway's `lifecycleState` will change to TERMINATING temporarily * until the gateway is completely removed. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteInternetGatewayRequest * @return DeleteInternetGatewayResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteInternetGateway.ts.html |here} to see how to use DeleteInternetGateway API. */ deleteInternetGateway(deleteInternetGatewayRequest: requests.DeleteInternetGatewayRequest): Promise; /** * Unassigns and deletes the specified IPv6. You must specify the object's [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * The IPv6 address is returned to the subnet's pool of available addresses. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteIpv6Request * @return DeleteIpv6Response * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteIpv6.ts.html |here} to see how to use DeleteIpv6 API. */ deleteIpv6(deleteIpv6Request: requests.DeleteIpv6Request): Promise; /** * Deletes the specified local peering gateway (LPG). *

This is an asynchronous operation; the local peering gateway's `lifecycleState` changes to TERMINATING temporarily * until the local peering gateway is completely removed. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteLocalPeeringGatewayRequest * @return DeleteLocalPeeringGatewayResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteLocalPeeringGateway.ts.html |here} to see how to use DeleteLocalPeeringGateway API. */ deleteLocalPeeringGateway(deleteLocalPeeringGatewayRequest: requests.DeleteLocalPeeringGatewayRequest): Promise; /** * 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. *

This is an asynchronous operation. The NAT gateway's `lifecycleState` will change to * TERMINATING temporarily until the NAT gateway is completely removed. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteNatGatewayRequest * @return DeleteNatGatewayResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteNatGateway.ts.html |here} to see how to use DeleteNatGateway API. */ deleteNatGateway(deleteNatGatewayRequest: requests.DeleteNatGatewayRequest): Promise; /** * Deletes the specified network security group. The group must not contain any VNICs. *

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](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC and the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC's parent resource (for example, * the Compute instance that the VNIC is attached to). * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteNetworkSecurityGroupRequest * @return DeleteNetworkSecurityGroupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteNetworkSecurityGroup.ts.html |here} to see how to use DeleteNetworkSecurityGroup API. */ deleteNetworkSecurityGroup(deleteNetworkSecurityGroupRequest: requests.DeleteNetworkSecurityGroupRequest): Promise; /** * Unassigns and deletes the specified private IP. You must * specify the object's [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). The private IP address is returned to * the subnet's pool of available addresses. *

This operation cannot be used with primary private IPs, which are * automatically unassigned and deleted when the VNIC is terminated. *

**Important:** If a secondary private IP is the * [target of a route rule](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip), * unassigning it from the VNIC causes that route rule to blackhole and the traffic * will be dropped. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeletePrivateIpRequest * @return DeletePrivateIpResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeletePrivateIp.ts.html |here} to see how to use DeletePrivateIp API. */ deletePrivateIp(deletePrivateIpRequest: requests.DeletePrivateIpRequest): Promise; /** * Unassigns and deletes the specified public IP (either ephemeral or reserved). * You must specify the object's [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). The public IP address is returned to the * Oracle Cloud Infrastructure public IP pool. *

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

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

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}. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeletePublicIpRequest * @return DeletePublicIpResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeletePublicIp.ts.html |here} to see how to use DeletePublicIp API. */ deletePublicIp(deletePublicIpRequest: requests.DeletePublicIpRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) when deleting an IP pool. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeletePublicIpPoolRequest * @return DeletePublicIpPoolResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeletePublicIpPool.ts.html |here} to see how to use DeletePublicIpPool API. */ deletePublicIpPool(deletePublicIpPoolRequest: requests.DeletePublicIpPoolRequest): Promise; /** * Deletes the remote peering connection (RPC). *

This is an asynchronous operation; the RPC's `lifecycleState` changes to TERMINATING temporarily * until the RPC is completely removed. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param DeleteRemotePeeringConnectionRequest * @return DeleteRemotePeeringConnectionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteRemotePeeringConnection.ts.html |here} to see how to use DeleteRemotePeeringConnection API. */ deleteRemotePeeringConnection(deleteRemotePeeringConnectionRequest: requests.DeleteRemotePeeringConnectionRequest): Promise; /** * 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. *

This is an asynchronous operation. The route table's `lifecycleState` will change to TERMINATING temporarily * until the route table is completely removed. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteRouteTableRequest * @return DeleteRouteTableResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteRouteTable.ts.html |here} to see how to use DeleteRouteTable API. */ deleteRouteTable(deleteRouteTableRequest: requests.DeleteRouteTableRequest): Promise; /** * 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. *

This is an asynchronous operation. The security list's `lifecycleState` will change to TERMINATING temporarily * until the security list is completely removed. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteSecurityListRequest * @return DeleteSecurityListResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteSecurityList.ts.html |here} to see how to use DeleteSecurityList API. */ deleteSecurityList(deleteSecurityListRequest: requests.DeleteSecurityListRequest): Promise; /** * Deletes the specified service gateway. There must not be a route table that lists the service * gateway as a target. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteServiceGatewayRequest * @return DeleteServiceGatewayResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteServiceGateway.ts.html |here} to see how to use DeleteServiceGateway API. */ deleteServiceGateway(deleteServiceGatewayRequest: requests.DeleteServiceGatewayRequest): Promise; /** * 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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteSubnetRequest * @return DeleteSubnetResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteSubnet.ts.html |here} to see how to use DeleteSubnet API. */ deleteSubnet(deleteSubnetRequest: requests.DeleteSubnetRequest): Promise; /** * Deletes the specified VCN. The VCN must be completely empty and have no attached gateways. This is an asynchronous * operation. *

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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteVcnRequest * @return DeleteVcnResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteVcn.ts.html |here} to see how to use DeleteVcn API. */ deleteVcn(deleteVcnRequest: requests.DeleteVcnRequest): Promise; /** * Deletes the specified virtual circuit. *

**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. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param DeleteVirtualCircuitRequest * @return DeleteVirtualCircuitResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteVirtualCircuit.ts.html |here} to see how to use DeleteVirtualCircuit API. */ deleteVirtualCircuit(deleteVirtualCircuitRequest: requests.DeleteVirtualCircuitRequest): Promise; /** * Deletes the specified VLAN, but only if there are no VNICs in the VLAN. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteVlanRequest * @return DeleteVlanResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteVlan.ts.html |here} to see how to use DeleteVlan API. */ deleteVlan(deleteVlanRequest: requests.DeleteVlanRequest): Promise; /** * Deletes the specified VTAP. This is an asynchronous operation. The VTAP's `lifecycleState` will change to * TERMINATING temporarily until the VTAP is completely removed. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteVtapRequest * @return DeleteVtapResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DeleteVtap.ts.html |here} to see how to use DeleteVtap API. */ deleteVtap(deleteVtapRequest: requests.DeleteVtapRequest): Promise; /** * 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. *

**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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DetachServiceIdRequest * @return DetachServiceIdResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/DetachServiceId.ts.html |here} to see how to use DetachServiceId API. */ detachServiceId(detachServiceIdRequest: requests.DetachServiceIdRequest): Promise; /** * Returns a complete list of DRG attachments that belong to a particular DRG. * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetAllDrgAttachmentsRequest * @return GetAllDrgAttachmentsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetAllDrgAttachments.ts.html |here} to see how to use GetAllDrgAttachments API. */ getAllDrgAttachments(getAllDrgAttachmentsRequest: requests.GetAllDrgAttachmentsRequest): Promise; /** * NOTE: This function is deprecated in favor of getAllDrgAttachmentsRecordIterator function. * Creates a new async iterator which will iterate over the models.DrgAttachmentInfo objects * contained in responses from the getAllDrgAttachments operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ getAllAllDrgAttachments(request: requests.GetAllDrgAttachmentsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of getAllDrgAttachmentsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the getAllDrgAttachments operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ getAllAllDrgAttachmentsResponses(request: requests.GetAllDrgAttachmentsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.DrgAttachmentInfo objects * contained in responses from the getAllDrgAttachments operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ getAllDrgAttachmentsRecordIterator(request: requests.GetAllDrgAttachmentsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the getAllDrgAttachments operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ getAllDrgAttachmentsResponseIterator(request: requests.GetAllDrgAttachmentsRequest): AsyncIterableIterator; /** * The parameters allowed for IKE IPSec tunnels. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetAllowedIkeIPSecParametersRequest * @return GetAllowedIkeIPSecParametersResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetAllowedIkeIPSecParameters.ts.html |here} to see how to use GetAllowedIkeIPSecParameters API. */ getAllowedIkeIPSecParameters(getAllowedIkeIPSecParametersRequest: requests.GetAllowedIkeIPSecParametersRequest): Promise; /** * Gets the `Byoasn` resource. You must specify the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetByoasnRequest * @return GetByoasnResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetByoasn.ts.html |here} to see how to use GetByoasn API. */ getByoasn(getByoasnRequest: requests.GetByoasnRequest): Promise; /** * Gets the `ByoipRange` resource. You must specify the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetByoipRangeRequest * @return GetByoipRangeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetByoipRange.ts.html |here} to see how to use GetByoipRange API. */ getByoipRange(getByoipRangeRequest: requests.GetByoipRangeRequest): Promise; /** * Gets information about the specified VTAP capture filter. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetCaptureFilterRequest * @return GetCaptureFilterResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetCaptureFilter.ts.html |here} to see how to use GetCaptureFilter API. */ getCaptureFilter(getCaptureFilterRequest: requests.GetCaptureFilterRequest): Promise; /** * Gets the specified CPE's information. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetCpeRequest * @return GetCpeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetCpe.ts.html |here} to see how to use GetCpe API. */ getCpe(getCpeRequest: requests.GetCpeRequest): Promise; /** * 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. *

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

The operation returns configuration information for *all* of the * {@link IPSecConnection} objects that use the specified CPE. * Here are similar operations: *

* {@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. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetCpeDeviceConfigContentRequest * @return GetCpeDeviceConfigContentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetCpeDeviceConfigContent.ts.html |here} to see how to use GetCpeDeviceConfigContent API. */ getCpeDeviceConfigContent(getCpeDeviceConfigContentRequest: requests.GetCpeDeviceConfigContentRequest): Promise; /** * 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: *

* {@link #getCpeDeviceConfigContent(GetCpeDeviceConfigContentRequest) getCpeDeviceConfigContent} * * {@link #getIpsecCpeDeviceConfigContent(GetIpsecCpeDeviceConfigContentRequest) getIpsecCpeDeviceConfigContent} * * {@link #getTunnelCpeDeviceConfigContent(GetTunnelCpeDeviceConfigContentRequest) getTunnelCpeDeviceConfigContent} * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetCpeDeviceShapeRequest * @return GetCpeDeviceShapeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetCpeDeviceShape.ts.html |here} to see how to use GetCpeDeviceShape API. */ getCpeDeviceShape(getCpeDeviceShapeRequest: requests.GetCpeDeviceShapeRequest): Promise; /** * Gets the specified cross-connect's information. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetCrossConnectRequest * @return GetCrossConnectResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetCrossConnect.ts.html |here} to see how to use GetCrossConnect API. */ getCrossConnect(getCrossConnectRequest: requests.GetCrossConnectRequest): Promise; /** * Gets the specified cross-connect group's information. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetCrossConnectGroupRequest * @return GetCrossConnectGroupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetCrossConnectGroup.ts.html |here} to see how to use GetCrossConnectGroup API. */ getCrossConnectGroup(getCrossConnectGroupRequest: requests.GetCrossConnectGroupRequest): Promise; /** * Gets the Letter of Authority for the specified cross-connect. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetCrossConnectLetterOfAuthorityRequest * @return GetCrossConnectLetterOfAuthorityResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetCrossConnectLetterOfAuthority.ts.html |here} to see how to use GetCrossConnectLetterOfAuthority API. */ getCrossConnectLetterOfAuthority(getCrossConnectLetterOfAuthorityRequest: requests.GetCrossConnectLetterOfAuthorityRequest): Promise; /** * Gets the status of the specified cross-connect. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetCrossConnectStatusRequest * @return GetCrossConnectStatusResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetCrossConnectStatus.ts.html |here} to see how to use GetCrossConnectStatus API. */ getCrossConnectStatus(getCrossConnectStatusRequest: requests.GetCrossConnectStatusRequest): Promise; /** * Gets the specified set of DHCP options. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetDhcpOptionsRequest * @return GetDhcpOptionsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetDhcpOptions.ts.html |here} to see how to use GetDhcpOptions API. */ getDhcpOptions(getDhcpOptionsRequest: requests.GetDhcpOptionsRequest): Promise; /** * Gets the specified DRG's information. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetDrgRequest * @return GetDrgResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetDrg.ts.html |here} to see how to use GetDrg API. */ getDrg(getDrgRequest: requests.GetDrgRequest): Promise; /** * Gets the `DrgAttachment` resource. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetDrgAttachmentRequest * @return GetDrgAttachmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetDrgAttachment.ts.html |here} to see how to use GetDrgAttachment API. */ getDrgAttachment(getDrgAttachmentRequest: requests.GetDrgAttachmentRequest): Promise; /** * Gets the specified DRG NAT policy's information. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetDrgNatPolicyRequest * @return GetDrgNatPolicyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetDrgNatPolicy.ts.html |here} to see how to use GetDrgNatPolicy API. */ getDrgNatPolicy(getDrgNatPolicyRequest: requests.GetDrgNatPolicyRequest): Promise; /** * Gets the redundancy status for the specified DRG. For more information, see * [Redundancy Remedies](https://docs.oracle.com/iaas/Content/Network/Troubleshoot/drgredundancy.htm). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetDrgRedundancyStatusRequest * @return GetDrgRedundancyStatusResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetDrgRedundancyStatus.ts.html |here} to see how to use GetDrgRedundancyStatus API. */ getDrgRedundancyStatus(getDrgRedundancyStatusRequest: requests.GetDrgRedundancyStatusRequest): Promise; /** * Gets the specified route distribution's information. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetDrgRouteDistributionRequest * @return GetDrgRouteDistributionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetDrgRouteDistribution.ts.html |here} to see how to use GetDrgRouteDistribution API. */ getDrgRouteDistribution(getDrgRouteDistributionRequest: requests.GetDrgRouteDistributionRequest): Promise; /** * Gets the specified DRG route table's information. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetDrgRouteTableRequest * @return GetDrgRouteTableResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetDrgRouteTable.ts.html |here} to see how to use GetDrgRouteTable API. */ getDrgRouteTable(getDrgRouteTableRequest: requests.GetDrgRouteTableRequest): Promise; /** * Gets the specified provider service. * For more information, see [FastConnect Overview](https://docs.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetFastConnectProviderServiceRequest * @return GetFastConnectProviderServiceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetFastConnectProviderService.ts.html |here} to see how to use GetFastConnectProviderService API. */ getFastConnectProviderService(getFastConnectProviderServiceRequest: requests.GetFastConnectProviderServiceRequest): Promise; /** * Gets the specified provider service key's information. Use this operation to validate a * provider service key. An invalid key returns a 404 error. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetFastConnectProviderServiceKeyRequest * @return GetFastConnectProviderServiceKeyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetFastConnectProviderServiceKey.ts.html |here} to see how to use GetFastConnectProviderServiceKey API. */ getFastConnectProviderServiceKey(getFastConnectProviderServiceKeyRequest: requests.GetFastConnectProviderServiceKeyRequest): Promise; /** * 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}. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetIPSecConnectionRequest * @return GetIPSecConnectionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetIPSecConnection.ts.html |here} to see how to use GetIPSecConnection API. */ getIPSecConnection(getIPSecConnectionRequest: requests.GetIPSecConnectionRequest): Promise; /** * Deprecated. To get tunnel information, instead use: *

* {@link #getIPSecConnectionTunnel(GetIPSecConnectionTunnelRequest) getIPSecConnectionTunnel} * * {@link #getIPSecConnectionTunnelSharedSecret(GetIPSecConnectionTunnelSharedSecretRequest) getIPSecConnectionTunnelSharedSecret} * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetIPSecConnectionDeviceConfigRequest * @return GetIPSecConnectionDeviceConfigResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetIPSecConnectionDeviceConfig.ts.html |here} to see how to use GetIPSecConnectionDeviceConfig API. */ getIPSecConnectionDeviceConfig(getIPSecConnectionDeviceConfigRequest: requests.GetIPSecConnectionDeviceConfigRequest): Promise; /** * Deprecated. To get the tunnel status, instead use * {@link #getIPSecConnectionTunnel(GetIPSecConnectionTunnelRequest) getIPSecConnectionTunnel}. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetIPSecConnectionDeviceStatusRequest * @return GetIPSecConnectionDeviceStatusResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetIPSecConnectionDeviceStatus.ts.html |here} to see how to use GetIPSecConnectionDeviceStatus API. */ getIPSecConnectionDeviceStatus(getIPSecConnectionDeviceStatusRequest: requests.GetIPSecConnectionDeviceStatusRequest): Promise; /** * 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}. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetIPSecConnectionTunnelRequest * @return GetIPSecConnectionTunnelResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetIPSecConnectionTunnel.ts.html |here} to see how to use GetIPSecConnectionTunnel API. */ getIPSecConnectionTunnel(getIPSecConnectionTunnelRequest: requests.GetIPSecConnectionTunnelRequest): Promise; /** * Gets the identified error for the specified IPSec tunnel ID. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetIPSecConnectionTunnelErrorRequest * @return GetIPSecConnectionTunnelErrorResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetIPSecConnectionTunnelError.ts.html |here} to see how to use GetIPSecConnectionTunnelError API. */ getIPSecConnectionTunnelError(getIPSecConnectionTunnelErrorRequest: requests.GetIPSecConnectionTunnelErrorRequest): Promise; /** * Gets the specified tunnel's shared secret (pre-shared key). To get other information * about the tunnel, use {@link #getIPSecConnectionTunnel(GetIPSecConnectionTunnelRequest) getIPSecConnectionTunnel}. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetIPSecConnectionTunnelSharedSecretRequest * @return GetIPSecConnectionTunnelSharedSecretResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetIPSecConnectionTunnelSharedSecret.ts.html |here} to see how to use GetIPSecConnectionTunnelSharedSecret API. */ getIPSecConnectionTunnelSharedSecret(getIPSecConnectionTunnelSharedSecretRequest: requests.GetIPSecConnectionTunnelSharedSecretRequest): Promise; /** * Gets the specified internet gateway's information. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetInternetGatewayRequest * @return GetInternetGatewayResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetInternetGateway.ts.html |here} to see how to use GetInternetGateway API. */ getInternetGateway(getInternetGatewayRequest: requests.GetInternetGatewayRequest): Promise; /** * 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. *

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

The operation returns configuration information for all tunnels in the single specified * {@link IPSecConnection} object. Here are other similar * operations: *

* {@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. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetIpsecCpeDeviceConfigContentRequest * @return GetIpsecCpeDeviceConfigContentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetIpsecCpeDeviceConfigContent.ts.html |here} to see how to use GetIpsecCpeDeviceConfigContent API. */ getIpsecCpeDeviceConfigContent(getIpsecCpeDeviceConfigContentRequest: requests.GetIpsecCpeDeviceConfigContentRequest): Promise; /** * Gets the specified IPv6. You must specify the object's [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * 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](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetIpv6Request * @return GetIpv6Response * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetIpv6.ts.html |here} to see how to use GetIpv6 API. */ getIpv6(getIpv6Request: requests.GetIpv6Request): Promise; /** * Gets the specified local peering gateway's information. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetLocalPeeringGatewayRequest * @return GetLocalPeeringGatewayResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetLocalPeeringGateway.ts.html |here} to see how to use GetLocalPeeringGateway API. */ getLocalPeeringGateway(getLocalPeeringGatewayRequest: requests.GetLocalPeeringGatewayRequest): Promise; /** * Gets the specified NAT gateway's information. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetNatGatewayRequest * @return GetNatGatewayResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetNatGateway.ts.html |here} to see how to use GetNatGateway API. */ getNatGateway(getNatGatewayRequest: requests.GetNatGatewayRequest): Promise; /** * Gets the specified network security group's information. *

To list the VNICs in an NSG, see * {@link #listNetworkSecurityGroupVnics(ListNetworkSecurityGroupVnicsRequest) listNetworkSecurityGroupVnics}. *

To list the security rules in an NSG, see * {@link #listNetworkSecurityGroupSecurityRules(ListNetworkSecurityGroupSecurityRulesRequest) listNetworkSecurityGroupSecurityRules}. * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetNetworkSecurityGroupRequest * @return GetNetworkSecurityGroupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetNetworkSecurityGroup.ts.html |here} to see how to use GetNetworkSecurityGroup API. */ getNetworkSecurityGroup(getNetworkSecurityGroupRequest: requests.GetNetworkSecurityGroupRequest): Promise; /** * Gets a virtual networking topology for the current region. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetNetworkingTopologyRequest * @return GetNetworkingTopologyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetNetworkingTopology.ts.html |here} to see how to use GetNetworkingTopology API. */ getNetworkingTopology(getNetworkingTopologyRequest: requests.GetNetworkingTopologyRequest): Promise; /** * Gets the specified private IP. You must specify the object's [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * 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](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetPrivateIpRequest * @return GetPrivateIpResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetPrivateIp.ts.html |here} to see how to use GetPrivateIp API. */ getPrivateIp(getPrivateIpRequest: requests.GetPrivateIpRequest): Promise; /** * Gets the specified public IP. You must specify the object's [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). *

Alternatively, you can get the object by using {@link #getPublicIpByIpAddress(GetPublicIpByIpAddressRequest) getPublicIpByIpAddress} * with the public IP address (for example, 203.0.113.2). *

Or you can use {@link #getPublicIpByPrivateIpId(GetPublicIpByPrivateIpIdRequest) getPublicIpByPrivateIpId} * with the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private IP that the public IP is assigned to. *

**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](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target private IP. * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetPublicIpRequest * @return GetPublicIpResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetPublicIp.ts.html |here} to see how to use GetPublicIp API. */ getPublicIp(getPublicIpRequest: requests.GetPublicIpRequest): Promise; /** * Gets the public IP based on the public IP address (for example, 203.0.113.2). *

**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](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target private IP. * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetPublicIpByIpAddressRequest * @return GetPublicIpByIpAddressResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetPublicIpByIpAddress.ts.html |here} to see how to use GetPublicIpByIpAddress API. */ getPublicIpByIpAddress(getPublicIpByIpAddressRequest: requests.GetPublicIpByIpAddressRequest): Promise; /** * 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. *

**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](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the original private * IP, this operation returns a 404. If you instead provide the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target private IP. * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetPublicIpByPrivateIpIdRequest * @return GetPublicIpByPrivateIpIdResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetPublicIpByPrivateIpId.ts.html |here} to see how to use GetPublicIpByPrivateIpId API. */ getPublicIpByPrivateIpId(getPublicIpByPrivateIpIdRequest: requests.GetPublicIpByPrivateIpIdRequest): Promise; /** * Gets the specified `PublicIpPool` object. You must specify the object's [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetPublicIpPoolRequest * @return GetPublicIpPoolResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetPublicIpPool.ts.html |here} to see how to use GetPublicIpPool API. */ getPublicIpPool(getPublicIpPoolRequest: requests.GetPublicIpPoolRequest): Promise; /** * Get the specified remote peering connection's information. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetRemotePeeringConnectionRequest * @return GetRemotePeeringConnectionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetRemotePeeringConnection.ts.html |here} to see how to use GetRemotePeeringConnection API. */ getRemotePeeringConnection(getRemotePeeringConnectionRequest: requests.GetRemotePeeringConnectionRequest): Promise; /** * Gets the `IpInventory` resource. * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetResourceIpInventoryRequest * @return GetResourceIpInventoryResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetResourceIpInventory.ts.html |here} to see how to use GetResourceIpInventory API. */ getResourceIpInventory(getResourceIpInventoryRequest: requests.GetResourceIpInventoryRequest): Promise; /** * Gets the specified route table's information. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetRouteTableRequest * @return GetRouteTableResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetRouteTable.ts.html |here} to see how to use GetRouteTable API. */ getRouteTable(getRouteTableRequest: requests.GetRouteTableRequest): Promise; /** * Gets the specified security list's information. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetSecurityListRequest * @return GetSecurityListResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetSecurityList.ts.html |here} to see how to use GetSecurityList API. */ getSecurityList(getSecurityListRequest: requests.GetSecurityListRequest): Promise; /** * Gets the specified {@link Service} object. * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetServiceRequest * @return GetServiceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetService.ts.html |here} to see how to use GetService API. */ getService(getServiceRequest: requests.GetServiceRequest): Promise; /** * Gets the specified service gateway's information. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetServiceGatewayRequest * @return GetServiceGatewayResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetServiceGateway.ts.html |here} to see how to use GetServiceGateway API. */ getServiceGateway(getServiceGatewayRequest: requests.GetServiceGatewayRequest): Promise; /** * Gets the specified subnet's information. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetSubnetRequest * @return GetSubnetResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetSubnet.ts.html |here} to see how to use GetSubnet API. */ getSubnet(getSubnetRequest: requests.GetSubnetRequest): Promise; /** * Gets the CIDR utilization data of the specified subnet. Specify the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetSubnetCidrUtilizationRequest * @return GetSubnetCidrUtilizationResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetSubnetCidrUtilization.ts.html |here} to see how to use GetSubnetCidrUtilization API. */ getSubnetCidrUtilization(getSubnetCidrUtilizationRequest: requests.GetSubnetCidrUtilizationRequest): Promise; /** * Gets the IP Inventory data of the specified subnet. Specify the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetSubnetIpInventoryRequest * @return GetSubnetIpInventoryResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetSubnetIpInventory.ts.html |here} to see how to use GetSubnetIpInventory API. */ getSubnetIpInventory(getSubnetIpInventoryRequest: requests.GetSubnetIpInventoryRequest): Promise; /** * Gets a topology for a given subnet. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetSubnetTopologyRequest * @return GetSubnetTopologyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetSubnetTopology.ts.html |here} to see how to use GetSubnetTopology API. */ getSubnetTopology(getSubnetTopologyRequest: requests.GetSubnetTopologyRequest): Promise; /** * 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}. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetTunnelCpeDeviceConfigRequest * @return GetTunnelCpeDeviceConfigResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetTunnelCpeDeviceConfig.ts.html |here} to see how to use GetTunnelCpeDeviceConfig API. */ getTunnelCpeDeviceConfig(getTunnelCpeDeviceConfigRequest: requests.GetTunnelCpeDeviceConfigRequest): Promise; /** * 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. *

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

The operation returns configuration information for only the specified IPSec tunnel. * Here are other similar operations: *

* {@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. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetTunnelCpeDeviceConfigContentRequest * @return GetTunnelCpeDeviceConfigContentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetTunnelCpeDeviceConfigContent.ts.html |here} to see how to use GetTunnelCpeDeviceConfigContent API. */ getTunnelCpeDeviceConfigContent(getTunnelCpeDeviceConfigContentRequest: requests.GetTunnelCpeDeviceConfigContentRequest): Promise; /** * Returns the DRG upgrade status. The status can be not updated, in progress, or updated. Also indicates how much of the upgrade is completed. * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetUpgradeStatusRequest * @return GetUpgradeStatusResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetUpgradeStatus.ts.html |here} to see how to use GetUpgradeStatus API. */ getUpgradeStatus(getUpgradeStatusRequest: requests.GetUpgradeStatusRequest): Promise; /** * Gets the specified VCN's information. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetVcnRequest * @return GetVcnResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetVcn.ts.html |here} to see how to use GetVcn API. */ getVcn(getVcnRequest: requests.GetVcnRequest): Promise; /** * Get the associated DNS resolver information with a vcn * This operation does not retry by default if the user has not defined a retry configuration. * @param GetVcnDnsResolverAssociationRequest * @return GetVcnDnsResolverAssociationResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetVcnDnsResolverAssociation.ts.html |here} to see how to use GetVcnDnsResolverAssociation API. */ getVcnDnsResolverAssociation(getVcnDnsResolverAssociationRequest: requests.GetVcnDnsResolverAssociationRequest): Promise; /** * Gets the CIDR overlap information of the specified VCN in selected compartments. Specify the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetVcnOverlapRequest * @return GetVcnOverlapResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetVcnOverlap.ts.html |here} to see how to use GetVcnOverlap API. */ getVcnOverlap(getVcnOverlapRequest: requests.GetVcnOverlapRequest): Promise; /** * Gets a virtual network topology for a given VCN. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetVcnTopologyRequest * @return GetVcnTopologyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetVcnTopology.ts.html |here} to see how to use GetVcnTopology API. */ getVcnTopology(getVcnTopologyRequest: requests.GetVcnTopologyRequest): Promise; /** * Gets the specified virtual circuit's information. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetVirtualCircuitRequest * @return GetVirtualCircuitResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetVirtualCircuit.ts.html |here} to see how to use GetVirtualCircuit API. */ getVirtualCircuit(getVirtualCircuitRequest: requests.GetVirtualCircuitRequest): Promise; /** * Gets the specified VLAN's information. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetVlanRequest * @return GetVlanResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetVlan.ts.html |here} to see how to use GetVlan API. */ getVlan(getVlanRequest: requests.GetVlanRequest): Promise; /** * Gets the information for the specified virtual network interface card (VNIC). * You can get the VNIC [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) from the * {@link #listVnicAttachments(ListVnicAttachmentsRequest) listVnicAttachments} * operation. * * This operation does not retry by default if the user has not defined a retry configuration. * @param GetVnicRequest * @return GetVnicResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetVnic.ts.html |here} to see how to use GetVnic API. */ getVnic(getVnicRequest: requests.GetVnicRequest): Promise; /** * Gets the specified `Vtap` resource. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetVtapRequest * @return GetVtapResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/GetVtap.ts.html |here} to see how to use GetVtap API. */ getVtap(getVtapRequest: requests.GetVtapRequest): Promise; /** * Unassign the specified IPv6 address from Virtual Network Interface Card (VNIC). You must specify the IPv6 [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param Ipv6VnicDetachRequest * @return Ipv6VnicDetachResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/Ipv6VnicDetach.ts.html |here} to see how to use Ipv6VnicDetach API. */ ipv6VnicDetach(ipv6VnicDetachRequest: requests.Ipv6VnicDetachRequest): Promise; /** * Lists the regions that support remote VCN peering (which is peering across regions). * For more information, see [VCN Peering](https://docs.oracle.com/iaas/Content/Network/Tasks/VCNpeering.htm). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListAllowedPeerRegionsForRemotePeeringRequest * @return ListAllowedPeerRegionsForRemotePeeringResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListAllowedPeerRegionsForRemotePeering.ts.html |here} to see how to use ListAllowedPeerRegionsForRemotePeering API. */ listAllowedPeerRegionsForRemotePeering(listAllowedPeerRegionsForRemotePeeringRequest: requests.ListAllowedPeerRegionsForRemotePeeringRequest): Promise; /** * Lists the `Byoasn` resources in the specified compartment. * You can filter the list using query parameters. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListByoasnsRequest * @return ListByoasnsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListByoasns.ts.html |here} to see how to use ListByoasns API. */ listByoasns(listByoasnsRequest: requests.ListByoasnsRequest): Promise; /** * 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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListByoipAllocatedRangesRequest * @return ListByoipAllocatedRangesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListByoipAllocatedRanges.ts.html |here} to see how to use ListByoipAllocatedRanges API. */ listByoipAllocatedRanges(listByoipAllocatedRangesRequest: requests.ListByoipAllocatedRangesRequest): Promise; /** * Lists the `ByoipRange` resources in the specified compartment. * You can filter the list using query parameters. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListByoipRangesRequest * @return ListByoipRangesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListByoipRanges.ts.html |here} to see how to use ListByoipRanges API. */ listByoipRanges(listByoipRangesRequest: requests.ListByoipRangesRequest): Promise; /** * Lists the capture filters in the specified compartment. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListCaptureFiltersRequest * @return ListCaptureFiltersResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListCaptureFilters.ts.html |here} to see how to use ListCaptureFilters API. */ listCaptureFilters(listCaptureFiltersRequest: requests.ListCaptureFiltersRequest): Promise; /** * NOTE: This function is deprecated in favor of listCaptureFiltersRecordIterator function. * Creates a new async iterator which will iterate over the models.CaptureFilter objects * contained in responses from the listCaptureFilters operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllCaptureFilters(request: requests.ListCaptureFiltersRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listCaptureFiltersResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listCaptureFilters operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllCaptureFiltersResponses(request: requests.ListCaptureFiltersRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.CaptureFilter objects * contained in responses from the listCaptureFilters operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listCaptureFiltersRecordIterator(request: requests.ListCaptureFiltersRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listCaptureFilters operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listCaptureFiltersResponseIterator(request: requests.ListCaptureFiltersRequest): AsyncIterableIterator; /** * 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. *

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](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) (returned by this operation). *

For information about generating CPE configuration content, see these operations: *

* {@link #getCpeDeviceConfigContent(GetCpeDeviceConfigContentRequest) getCpeDeviceConfigContent} * * {@link #getIpsecCpeDeviceConfigContent(GetIpsecCpeDeviceConfigContentRequest) getIpsecCpeDeviceConfigContent} * * {@link #getTunnelCpeDeviceConfigContent(GetTunnelCpeDeviceConfigContentRequest) getTunnelCpeDeviceConfigContent} * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListCpeDeviceShapesRequest * @return ListCpeDeviceShapesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListCpeDeviceShapes.ts.html |here} to see how to use ListCpeDeviceShapes API. */ listCpeDeviceShapes(listCpeDeviceShapesRequest: requests.ListCpeDeviceShapesRequest): Promise; /** * NOTE: This function is deprecated in favor of listCpeDeviceShapesRecordIterator function. * Creates a new async iterator which will iterate over the models.CpeDeviceShapeSummary objects * contained in responses from the listCpeDeviceShapes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllCpeDeviceShapes(request: requests.ListCpeDeviceShapesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listCpeDeviceShapesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listCpeDeviceShapes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllCpeDeviceShapesResponses(request: requests.ListCpeDeviceShapesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.CpeDeviceShapeSummary objects * contained in responses from the listCpeDeviceShapes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listCpeDeviceShapesRecordIterator(request: requests.ListCpeDeviceShapesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listCpeDeviceShapes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listCpeDeviceShapesResponseIterator(request: requests.ListCpeDeviceShapesRequest): AsyncIterableIterator; /** * Lists the customer-premises equipment objects (CPEs) in the specified compartment. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListCpesRequest * @return ListCpesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListCpes.ts.html |here} to see how to use ListCpes API. */ listCpes(listCpesRequest: requests.ListCpesRequest): Promise; /** * NOTE: This function is deprecated in favor of listCpesRecordIterator function. * Creates a new async iterator which will iterate over the models.Cpe objects * contained in responses from the listCpes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllCpes(request: requests.ListCpesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listCpesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listCpes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllCpesResponses(request: requests.ListCpesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.Cpe objects * contained in responses from the listCpes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listCpesRecordIterator(request: requests.ListCpesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listCpes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listCpesResponseIterator(request: requests.ListCpesRequest): AsyncIterableIterator; /** * Lists the cross-connect groups in the specified compartment. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListCrossConnectGroupsRequest * @return ListCrossConnectGroupsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListCrossConnectGroups.ts.html |here} to see how to use ListCrossConnectGroups API. */ listCrossConnectGroups(listCrossConnectGroupsRequest: requests.ListCrossConnectGroupsRequest): Promise; /** * NOTE: This function is deprecated in favor of listCrossConnectGroupsRecordIterator function. * Creates a new async iterator which will iterate over the models.CrossConnectGroup objects * contained in responses from the listCrossConnectGroups operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllCrossConnectGroups(request: requests.ListCrossConnectGroupsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listCrossConnectGroupsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listCrossConnectGroups operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllCrossConnectGroupsResponses(request: requests.ListCrossConnectGroupsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.CrossConnectGroup objects * contained in responses from the listCrossConnectGroups operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listCrossConnectGroupsRecordIterator(request: requests.ListCrossConnectGroupsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listCrossConnectGroups operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listCrossConnectGroupsResponseIterator(request: requests.ListCrossConnectGroupsRequest): AsyncIterableIterator; /** * 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. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListCrossConnectLocationsRequest * @return ListCrossConnectLocationsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListCrossConnectLocations.ts.html |here} to see how to use ListCrossConnectLocations API. */ listCrossConnectLocations(listCrossConnectLocationsRequest: requests.ListCrossConnectLocationsRequest): Promise; /** * NOTE: This function is deprecated in favor of listCrossConnectLocationsRecordIterator function. * Creates a new async iterator which will iterate over the models.CrossConnectLocation objects * contained in responses from the listCrossConnectLocations operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllCrossConnectLocations(request: requests.ListCrossConnectLocationsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listCrossConnectLocationsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listCrossConnectLocations operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllCrossConnectLocationsResponses(request: requests.ListCrossConnectLocationsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.CrossConnectLocation objects * contained in responses from the listCrossConnectLocations operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listCrossConnectLocationsRecordIterator(request: requests.ListCrossConnectLocationsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listCrossConnectLocations operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listCrossConnectLocationsResponseIterator(request: requests.ListCrossConnectLocationsRequest): AsyncIterableIterator; /** * Lists the Cross Connect mapping Details for the specified * virtual circuit. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListCrossConnectMappingsRequest * @return ListCrossConnectMappingsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListCrossConnectMappings.ts.html |here} to see how to use ListCrossConnectMappings API. */ listCrossConnectMappings(listCrossConnectMappingsRequest: requests.ListCrossConnectMappingsRequest): Promise; /** * Lists the cross-connects in the specified compartment. You can filter the list * by specifying the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a cross-connect group. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListCrossConnectsRequest * @return ListCrossConnectsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListCrossConnects.ts.html |here} to see how to use ListCrossConnects API. */ listCrossConnects(listCrossConnectsRequest: requests.ListCrossConnectsRequest): Promise; /** * NOTE: This function is deprecated in favor of listCrossConnectsRecordIterator function. * Creates a new async iterator which will iterate over the models.CrossConnect objects * contained in responses from the listCrossConnects operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllCrossConnects(request: requests.ListCrossConnectsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listCrossConnectsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listCrossConnects operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllCrossConnectsResponses(request: requests.ListCrossConnectsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.CrossConnect objects * contained in responses from the listCrossConnects operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listCrossConnectsRecordIterator(request: requests.ListCrossConnectsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listCrossConnects operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listCrossConnectsResponseIterator(request: requests.ListCrossConnectsRequest): AsyncIterableIterator; /** * 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. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListCrossconnectPortSpeedShapesRequest * @return ListCrossconnectPortSpeedShapesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListCrossconnectPortSpeedShapes.ts.html |here} to see how to use ListCrossconnectPortSpeedShapes API. */ listCrossconnectPortSpeedShapes(listCrossconnectPortSpeedShapesRequest: requests.ListCrossconnectPortSpeedShapesRequest): Promise; /** * NOTE: This function is deprecated in favor of listCrossconnectPortSpeedShapesRecordIterator function. * Creates a new async iterator which will iterate over the models.CrossConnectPortSpeedShape objects * contained in responses from the listCrossconnectPortSpeedShapes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllCrossconnectPortSpeedShapes(request: requests.ListCrossconnectPortSpeedShapesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listCrossconnectPortSpeedShapesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listCrossconnectPortSpeedShapes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllCrossconnectPortSpeedShapesResponses(request: requests.ListCrossconnectPortSpeedShapesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.CrossConnectPortSpeedShape objects * contained in responses from the listCrossconnectPortSpeedShapes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listCrossconnectPortSpeedShapesRecordIterator(request: requests.ListCrossconnectPortSpeedShapesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listCrossconnectPortSpeedShapes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listCrossconnectPortSpeedShapesResponseIterator(request: requests.ListCrossconnectPortSpeedShapesRequest): AsyncIterableIterator; /** * 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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListDhcpOptionsRequest * @return ListDhcpOptionsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListDhcpOptions.ts.html |here} to see how to use ListDhcpOptions API. */ listDhcpOptions(listDhcpOptionsRequest: requests.ListDhcpOptionsRequest): Promise; /** * NOTE: This function is deprecated in favor of listDhcpOptionsRecordIterator function. * Creates a new async iterator which will iterate over the models.DhcpOptions objects * contained in responses from the listDhcpOptions operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllDhcpOptions(request: requests.ListDhcpOptionsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listDhcpOptionsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listDhcpOptions operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllDhcpOptionsResponses(request: requests.ListDhcpOptionsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.DhcpOptions objects * contained in responses from the listDhcpOptions operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listDhcpOptionsRecordIterator(request: requests.ListDhcpOptionsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listDhcpOptions operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listDhcpOptionsResponseIterator(request: requests.ListDhcpOptionsRequest): AsyncIterableIterator; /** * 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. *

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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListDrgAttachmentsRequest * @return ListDrgAttachmentsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListDrgAttachments.ts.html |here} to see how to use ListDrgAttachments API. */ listDrgAttachments(listDrgAttachmentsRequest: requests.ListDrgAttachmentsRequest): Promise; /** * NOTE: This function is deprecated in favor of listDrgAttachmentsRecordIterator function. * Creates a new async iterator which will iterate over the models.DrgAttachment objects * contained in responses from the listDrgAttachments operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllDrgAttachments(request: requests.ListDrgAttachmentsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listDrgAttachmentsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listDrgAttachments operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllDrgAttachmentsResponses(request: requests.ListDrgAttachmentsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.DrgAttachment objects * contained in responses from the listDrgAttachments operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listDrgAttachmentsRecordIterator(request: requests.ListDrgAttachmentsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listDrgAttachments operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listDrgAttachmentsResponseIterator(request: requests.ListDrgAttachmentsRequest): AsyncIterableIterator; /** * The list of DRG NAT policies in the compartment. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListDrgNatPoliciesRequest * @return ListDrgNatPoliciesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListDrgNatPolicies.ts.html |here} to see how to use ListDrgNatPolicies API. */ listDrgNatPolicies(listDrgNatPoliciesRequest: requests.ListDrgNatPoliciesRequest): Promise; /** * NOTE: This function is deprecated in favor of listDrgNatPoliciesRecordIterator function. * Creates a new async iterator which will iterate over the models.DrgNatPolicy objects * contained in responses from the listDrgNatPolicies operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllDrgNatPolicies(request: requests.ListDrgNatPoliciesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listDrgNatPoliciesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listDrgNatPolicies operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllDrgNatPoliciesResponses(request: requests.ListDrgNatPoliciesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.DrgNatPolicy objects * contained in responses from the listDrgNatPolicies operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listDrgNatPoliciesRecordIterator(request: requests.ListDrgNatPoliciesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listDrgNatPolicies operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listDrgNatPoliciesResponseIterator(request: requests.ListDrgNatPoliciesRequest): AsyncIterableIterator; /** * Lists the rules for the specified DRG NAT policy. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListDrgNatRulesRequest * @return ListDrgNatRulesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListDrgNatRules.ts.html |here} to see how to use ListDrgNatRules API. */ listDrgNatRules(listDrgNatRulesRequest: requests.ListDrgNatRulesRequest): Promise; /** * NOTE: This function is deprecated in favor of listDrgNatRulesRecordIterator function. * Creates a new async iterator which will iterate over the models.DrgNatRule objects * contained in responses from the listDrgNatRules operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllDrgNatRules(request: requests.ListDrgNatRulesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listDrgNatRulesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listDrgNatRules operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllDrgNatRulesResponses(request: requests.ListDrgNatRulesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.DrgNatRule objects * contained in responses from the listDrgNatRules operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listDrgNatRulesRecordIterator(request: requests.ListDrgNatRulesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listDrgNatRules operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listDrgNatRulesResponseIterator(request: requests.ListDrgNatRulesRequest): AsyncIterableIterator; /** * Lists the statements for the specified route distribution. * This operation does not retry by default if the user has not defined a retry configuration. * @param ListDrgRouteDistributionStatementsRequest * @return ListDrgRouteDistributionStatementsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListDrgRouteDistributionStatements.ts.html |here} to see how to use ListDrgRouteDistributionStatements API. */ listDrgRouteDistributionStatements(listDrgRouteDistributionStatementsRequest: requests.ListDrgRouteDistributionStatementsRequest): Promise; /** * NOTE: This function is deprecated in favor of listDrgRouteDistributionStatementsRecordIterator function. * Creates a new async iterator which will iterate over the models.DrgRouteDistributionStatement objects * contained in responses from the listDrgRouteDistributionStatements operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllDrgRouteDistributionStatements(request: requests.ListDrgRouteDistributionStatementsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listDrgRouteDistributionStatementsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listDrgRouteDistributionStatements operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllDrgRouteDistributionStatementsResponses(request: requests.ListDrgRouteDistributionStatementsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.DrgRouteDistributionStatement objects * contained in responses from the listDrgRouteDistributionStatements operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listDrgRouteDistributionStatementsRecordIterator(request: requests.ListDrgRouteDistributionStatementsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listDrgRouteDistributionStatements operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listDrgRouteDistributionStatementsResponseIterator(request: requests.ListDrgRouteDistributionStatementsRequest): AsyncIterableIterator; /** * Lists the route distributions in the specified DRG. *

To retrieve the statements in a distribution, use the * ListDrgRouteDistributionStatements operation. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListDrgRouteDistributionsRequest * @return ListDrgRouteDistributionsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListDrgRouteDistributions.ts.html |here} to see how to use ListDrgRouteDistributions API. */ listDrgRouteDistributions(listDrgRouteDistributionsRequest: requests.ListDrgRouteDistributionsRequest): Promise; /** * NOTE: This function is deprecated in favor of listDrgRouteDistributionsRecordIterator function. * Creates a new async iterator which will iterate over the models.DrgRouteDistribution objects * contained in responses from the listDrgRouteDistributions operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllDrgRouteDistributions(request: requests.ListDrgRouteDistributionsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listDrgRouteDistributionsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listDrgRouteDistributions operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllDrgRouteDistributionsResponses(request: requests.ListDrgRouteDistributionsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.DrgRouteDistribution objects * contained in responses from the listDrgRouteDistributions operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listDrgRouteDistributionsRecordIterator(request: requests.ListDrgRouteDistributionsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listDrgRouteDistributions operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listDrgRouteDistributionsResponseIterator(request: requests.ListDrgRouteDistributionsRequest): AsyncIterableIterator; /** * Lists the route rules in the specified DRG route table. * This operation does not retry by default if the user has not defined a retry configuration. * @param ListDrgRouteRulesRequest * @return ListDrgRouteRulesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListDrgRouteRules.ts.html |here} to see how to use ListDrgRouteRules API. */ listDrgRouteRules(listDrgRouteRulesRequest: requests.ListDrgRouteRulesRequest): Promise; /** * NOTE: This function is deprecated in favor of listDrgRouteRulesRecordIterator function. * Creates a new async iterator which will iterate over the models.DrgRouteRule objects * contained in responses from the listDrgRouteRules operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllDrgRouteRules(request: requests.ListDrgRouteRulesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listDrgRouteRulesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listDrgRouteRules operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllDrgRouteRulesResponses(request: requests.ListDrgRouteRulesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.DrgRouteRule objects * contained in responses from the listDrgRouteRules operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listDrgRouteRulesRecordIterator(request: requests.ListDrgRouteRulesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listDrgRouteRules operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listDrgRouteRulesResponseIterator(request: requests.ListDrgRouteRulesRequest): AsyncIterableIterator; /** * Lists the DRG route tables for the specified DRG. *

Use the `ListDrgRouteRules` operation to retrieve the route rules in a table. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListDrgRouteTablesRequest * @return ListDrgRouteTablesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListDrgRouteTables.ts.html |here} to see how to use ListDrgRouteTables API. */ listDrgRouteTables(listDrgRouteTablesRequest: requests.ListDrgRouteTablesRequest): Promise; /** * NOTE: This function is deprecated in favor of listDrgRouteTablesRecordIterator function. * Creates a new async iterator which will iterate over the models.DrgRouteTable objects * contained in responses from the listDrgRouteTables operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllDrgRouteTables(request: requests.ListDrgRouteTablesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listDrgRouteTablesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listDrgRouteTables operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllDrgRouteTablesResponses(request: requests.ListDrgRouteTablesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.DrgRouteTable objects * contained in responses from the listDrgRouteTables operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listDrgRouteTablesRecordIterator(request: requests.ListDrgRouteTablesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listDrgRouteTables operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listDrgRouteTablesResponseIterator(request: requests.ListDrgRouteTablesRequest): AsyncIterableIterator; /** * Lists the DRGs in the specified compartment. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListDrgsRequest * @return ListDrgsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListDrgs.ts.html |here} to see how to use ListDrgs API. */ listDrgs(listDrgsRequest: requests.ListDrgsRequest): Promise; /** * NOTE: This function is deprecated in favor of listDrgsRecordIterator function. * Creates a new async iterator which will iterate over the models.Drg objects * contained in responses from the listDrgs operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllDrgs(request: requests.ListDrgsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listDrgsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listDrgs operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllDrgsResponses(request: requests.ListDrgsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.Drg objects * contained in responses from the listDrgs operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listDrgsRecordIterator(request: requests.ListDrgsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listDrgs operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listDrgsResponseIterator(request: requests.ListDrgsRequest): AsyncIterableIterator; /** * 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. *

For the compartment ID, provide the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of your tenancy (the root compartment). *

For more information, see [FastConnect Overview](https://docs.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListFastConnectProviderServicesRequest * @return ListFastConnectProviderServicesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListFastConnectProviderServices.ts.html |here} to see how to use ListFastConnectProviderServices API. */ listFastConnectProviderServices(listFastConnectProviderServicesRequest: requests.ListFastConnectProviderServicesRequest): Promise; /** * NOTE: This function is deprecated in favor of listFastConnectProviderServicesRecordIterator function. * Creates a new async iterator which will iterate over the models.FastConnectProviderService objects * contained in responses from the listFastConnectProviderServices operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllFastConnectProviderServices(request: requests.ListFastConnectProviderServicesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listFastConnectProviderServicesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listFastConnectProviderServices operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllFastConnectProviderServicesResponses(request: requests.ListFastConnectProviderServicesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.FastConnectProviderService objects * contained in responses from the listFastConnectProviderServices operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listFastConnectProviderServicesRecordIterator(request: requests.ListFastConnectProviderServicesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listFastConnectProviderServices operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listFastConnectProviderServicesResponseIterator(request: requests.ListFastConnectProviderServicesRequest): AsyncIterableIterator; /** * 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. *

For more information about virtual circuits, see [FastConnect Overview](https://docs.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListFastConnectProviderVirtualCircuitBandwidthShapesRequest * @return ListFastConnectProviderVirtualCircuitBandwidthShapesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListFastConnectProviderVirtualCircuitBandwidthShapes.ts.html |here} to see how to use ListFastConnectProviderVirtualCircuitBandwidthShapes API. */ listFastConnectProviderVirtualCircuitBandwidthShapes(listFastConnectProviderVirtualCircuitBandwidthShapesRequest: requests.ListFastConnectProviderVirtualCircuitBandwidthShapesRequest): Promise; /** * NOTE: This function is deprecated in favor of listFastConnectProviderVirtualCircuitBandwidthShapesRecordIterator function. * Creates a new async iterator which will iterate over the models.VirtualCircuitBandwidthShape objects * contained in responses from the listFastConnectProviderVirtualCircuitBandwidthShapes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllFastConnectProviderVirtualCircuitBandwidthShapes(request: requests.ListFastConnectProviderVirtualCircuitBandwidthShapesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listFastConnectProviderVirtualCircuitBandwidthShapesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listFastConnectProviderVirtualCircuitBandwidthShapes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllFastConnectProviderVirtualCircuitBandwidthShapesResponses(request: requests.ListFastConnectProviderVirtualCircuitBandwidthShapesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.VirtualCircuitBandwidthShape objects * contained in responses from the listFastConnectProviderVirtualCircuitBandwidthShapes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listFastConnectProviderVirtualCircuitBandwidthShapesRecordIterator(request: requests.ListFastConnectProviderVirtualCircuitBandwidthShapesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listFastConnectProviderVirtualCircuitBandwidthShapes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listFastConnectProviderVirtualCircuitBandwidthShapesResponseIterator(request: requests.ListFastConnectProviderVirtualCircuitBandwidthShapesRequest): AsyncIterableIterator; /** * The routes advertised to the on-premises network and the routes received from the on-premises network. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListIPSecConnectionTunnelRoutesRequest * @return ListIPSecConnectionTunnelRoutesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListIPSecConnectionTunnelRoutes.ts.html |here} to see how to use ListIPSecConnectionTunnelRoutes API. */ listIPSecConnectionTunnelRoutes(listIPSecConnectionTunnelRoutesRequest: requests.ListIPSecConnectionTunnelRoutesRequest): Promise; /** * NOTE: This function is deprecated in favor of listIPSecConnectionTunnelRoutesRecordIterator function. * Creates a new async iterator which will iterate over the models.TunnelRouteSummary objects * contained in responses from the listIPSecConnectionTunnelRoutes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllIPSecConnectionTunnelRoutes(request: requests.ListIPSecConnectionTunnelRoutesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listIPSecConnectionTunnelRoutesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listIPSecConnectionTunnelRoutes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllIPSecConnectionTunnelRoutesResponses(request: requests.ListIPSecConnectionTunnelRoutesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.TunnelRouteSummary objects * contained in responses from the listIPSecConnectionTunnelRoutes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listIPSecConnectionTunnelRoutesRecordIterator(request: requests.ListIPSecConnectionTunnelRoutesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listIPSecConnectionTunnelRoutes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listIPSecConnectionTunnelRoutesResponseIterator(request: requests.ListIPSecConnectionTunnelRoutesRequest): AsyncIterableIterator; /** * Lists the tunnel security associations information for the specified IPSec tunnel ID. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListIPSecConnectionTunnelSecurityAssociationsRequest * @return ListIPSecConnectionTunnelSecurityAssociationsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListIPSecConnectionTunnelSecurityAssociations.ts.html |here} to see how to use ListIPSecConnectionTunnelSecurityAssociations API. */ listIPSecConnectionTunnelSecurityAssociations(listIPSecConnectionTunnelSecurityAssociationsRequest: requests.ListIPSecConnectionTunnelSecurityAssociationsRequest): Promise; /** * NOTE: This function is deprecated in favor of listIPSecConnectionTunnelSecurityAssociationsRecordIterator function. * Creates a new async iterator which will iterate over the models.TunnelSecurityAssociationSummary objects * contained in responses from the listIPSecConnectionTunnelSecurityAssociations operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllIPSecConnectionTunnelSecurityAssociations(request: requests.ListIPSecConnectionTunnelSecurityAssociationsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listIPSecConnectionTunnelSecurityAssociationsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listIPSecConnectionTunnelSecurityAssociations operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllIPSecConnectionTunnelSecurityAssociationsResponses(request: requests.ListIPSecConnectionTunnelSecurityAssociationsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.TunnelSecurityAssociationSummary objects * contained in responses from the listIPSecConnectionTunnelSecurityAssociations operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listIPSecConnectionTunnelSecurityAssociationsRecordIterator(request: requests.ListIPSecConnectionTunnelSecurityAssociationsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listIPSecConnectionTunnelSecurityAssociations operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listIPSecConnectionTunnelSecurityAssociationsResponseIterator(request: requests.ListIPSecConnectionTunnelSecurityAssociationsRequest): AsyncIterableIterator; /** * Lists the tunnel information for the specified IPSec connection. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListIPSecConnectionTunnelsRequest * @return ListIPSecConnectionTunnelsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListIPSecConnectionTunnels.ts.html |here} to see how to use ListIPSecConnectionTunnels API. */ listIPSecConnectionTunnels(listIPSecConnectionTunnelsRequest: requests.ListIPSecConnectionTunnelsRequest): Promise; /** * NOTE: This function is deprecated in favor of listIPSecConnectionTunnelsRecordIterator function. * Creates a new async iterator which will iterate over the models.IPSecConnectionTunnel objects * contained in responses from the listIPSecConnectionTunnels operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllIPSecConnectionTunnels(request: requests.ListIPSecConnectionTunnelsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listIPSecConnectionTunnelsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listIPSecConnectionTunnels operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllIPSecConnectionTunnelsResponses(request: requests.ListIPSecConnectionTunnelsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.IPSecConnectionTunnel objects * contained in responses from the listIPSecConnectionTunnels operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listIPSecConnectionTunnelsRecordIterator(request: requests.ListIPSecConnectionTunnelsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listIPSecConnectionTunnels operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listIPSecConnectionTunnelsResponseIterator(request: requests.ListIPSecConnectionTunnelsRequest): AsyncIterableIterator; /** * Lists the IPSec connections for the specified compartment. You can filter the * results by DRG or CPE. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListIPSecConnectionsRequest * @return ListIPSecConnectionsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListIPSecConnections.ts.html |here} to see how to use ListIPSecConnections API. */ listIPSecConnections(listIPSecConnectionsRequest: requests.ListIPSecConnectionsRequest): Promise; /** * NOTE: This function is deprecated in favor of listIPSecConnectionsRecordIterator function. * Creates a new async iterator which will iterate over the models.IPSecConnection objects * contained in responses from the listIPSecConnections operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllIPSecConnections(request: requests.ListIPSecConnectionsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listIPSecConnectionsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listIPSecConnections operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllIPSecConnectionsResponses(request: requests.ListIPSecConnectionsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.IPSecConnection objects * contained in responses from the listIPSecConnections operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listIPSecConnectionsRecordIterator(request: requests.ListIPSecConnectionsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listIPSecConnections operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listIPSecConnectionsResponseIterator(request: requests.ListIPSecConnectionsRequest): AsyncIterableIterator; /** * 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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListInternetGatewaysRequest * @return ListInternetGatewaysResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListInternetGateways.ts.html |here} to see how to use ListInternetGateways API. */ listInternetGateways(listInternetGatewaysRequest: requests.ListInternetGatewaysRequest): Promise; /** * NOTE: This function is deprecated in favor of listInternetGatewaysRecordIterator function. * Creates a new async iterator which will iterate over the models.InternetGateway objects * contained in responses from the listInternetGateways operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllInternetGateways(request: requests.ListInternetGatewaysRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listInternetGatewaysResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listInternetGateways operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllInternetGatewaysResponses(request: requests.ListInternetGatewaysRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.InternetGateway objects * contained in responses from the listInternetGateways operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listInternetGatewaysRecordIterator(request: requests.ListInternetGatewaysRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listInternetGateways operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listInternetGatewaysResponseIterator(request: requests.ListInternetGatewaysRequest): AsyncIterableIterator; /** * Lists the IP Inventory information in the selected compartments. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListIpInventoryRequest * @return ListIpInventoryResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListIpInventory.ts.html |here} to see how to use ListIpInventory API. */ listIpInventory(listIpInventoryRequest: requests.ListIpInventoryRequest): Promise; /** * Lists the {@link Ipv6} objects based * on one of these filters: *

* Subnet [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * * VNIC [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * * Both IPv6 address and subnet OCID: This lets you get an `Ipv6` object based on its private * IPv6 address (for example, 2001:0db8:0123:1111:abcd:ef01:2345:6789) and not its [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). For comparison, * {@link #getIpv6(GetIpv6Request) getIpv6} requires the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListIpv6sRequest * @return ListIpv6sResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListIpv6s.ts.html |here} to see how to use ListIpv6s API. */ listIpv6s(listIpv6sRequest: requests.ListIpv6sRequest): Promise; /** * NOTE: This function is deprecated in favor of listIpv6sRecordIterator function. * Creates a new async iterator which will iterate over the models.Ipv6 objects * contained in responses from the listIpv6s operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllIpv6s(request: requests.ListIpv6sRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listIpv6sResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listIpv6s operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllIpv6sResponses(request: requests.ListIpv6sRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.Ipv6 objects * contained in responses from the listIpv6s operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listIpv6sRecordIterator(request: requests.ListIpv6sRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listIpv6s operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listIpv6sResponseIterator(request: requests.ListIpv6sRequest): AsyncIterableIterator; /** * 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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListLocalPeeringGatewaysRequest * @return ListLocalPeeringGatewaysResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListLocalPeeringGateways.ts.html |here} to see how to use ListLocalPeeringGateways API. */ listLocalPeeringGateways(listLocalPeeringGatewaysRequest: requests.ListLocalPeeringGatewaysRequest): Promise; /** * NOTE: This function is deprecated in favor of listLocalPeeringGatewaysRecordIterator function. * Creates a new async iterator which will iterate over the models.LocalPeeringGateway objects * contained in responses from the listLocalPeeringGateways operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllLocalPeeringGateways(request: requests.ListLocalPeeringGatewaysRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listLocalPeeringGatewaysResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listLocalPeeringGateways operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllLocalPeeringGatewaysResponses(request: requests.ListLocalPeeringGatewaysRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.LocalPeeringGateway objects * contained in responses from the listLocalPeeringGateways operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listLocalPeeringGatewaysRecordIterator(request: requests.ListLocalPeeringGatewaysRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listLocalPeeringGateways operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listLocalPeeringGatewaysResponseIterator(request: requests.ListLocalPeeringGatewaysRequest): AsyncIterableIterator; /** * Lists the NAT gateways in the specified compartment. You may optionally specify a VCN OCID * to filter the results by VCN. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListNatGatewaysRequest * @return ListNatGatewaysResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListNatGateways.ts.html |here} to see how to use ListNatGateways API. */ listNatGateways(listNatGatewaysRequest: requests.ListNatGatewaysRequest): Promise; /** * NOTE: This function is deprecated in favor of listNatGatewaysRecordIterator function. * Creates a new async iterator which will iterate over the models.NatGateway objects * contained in responses from the listNatGateways operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllNatGateways(request: requests.ListNatGatewaysRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listNatGatewaysResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listNatGateways operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllNatGatewaysResponses(request: requests.ListNatGatewaysRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.NatGateway objects * contained in responses from the listNatGateways operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listNatGatewaysRecordIterator(request: requests.ListNatGatewaysRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listNatGateways operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listNatGatewaysResponseIterator(request: requests.ListNatGatewaysRequest): AsyncIterableIterator; /** * Lists the security rules in the specified network security group. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListNetworkSecurityGroupSecurityRulesRequest * @return ListNetworkSecurityGroupSecurityRulesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListNetworkSecurityGroupSecurityRules.ts.html |here} to see how to use ListNetworkSecurityGroupSecurityRules API. */ listNetworkSecurityGroupSecurityRules(listNetworkSecurityGroupSecurityRulesRequest: requests.ListNetworkSecurityGroupSecurityRulesRequest): Promise; /** * NOTE: This function is deprecated in favor of listNetworkSecurityGroupSecurityRulesRecordIterator function. * Creates a new async iterator which will iterate over the models.SecurityRule objects * contained in responses from the listNetworkSecurityGroupSecurityRules operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllNetworkSecurityGroupSecurityRules(request: requests.ListNetworkSecurityGroupSecurityRulesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listNetworkSecurityGroupSecurityRulesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listNetworkSecurityGroupSecurityRules operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllNetworkSecurityGroupSecurityRulesResponses(request: requests.ListNetworkSecurityGroupSecurityRulesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.SecurityRule objects * contained in responses from the listNetworkSecurityGroupSecurityRules operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listNetworkSecurityGroupSecurityRulesRecordIterator(request: requests.ListNetworkSecurityGroupSecurityRulesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listNetworkSecurityGroupSecurityRules operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listNetworkSecurityGroupSecurityRulesResponseIterator(request: requests.ListNetworkSecurityGroupSecurityRulesRequest): AsyncIterableIterator; /** * Lists the VNICs in the specified network security group. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListNetworkSecurityGroupVnicsRequest * @return ListNetworkSecurityGroupVnicsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListNetworkSecurityGroupVnics.ts.html |here} to see how to use ListNetworkSecurityGroupVnics API. */ listNetworkSecurityGroupVnics(listNetworkSecurityGroupVnicsRequest: requests.ListNetworkSecurityGroupVnicsRequest): Promise; /** * NOTE: This function is deprecated in favor of listNetworkSecurityGroupVnicsRecordIterator function. * Creates a new async iterator which will iterate over the models.NetworkSecurityGroupVnic objects * contained in responses from the listNetworkSecurityGroupVnics operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllNetworkSecurityGroupVnics(request: requests.ListNetworkSecurityGroupVnicsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listNetworkSecurityGroupVnicsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listNetworkSecurityGroupVnics operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllNetworkSecurityGroupVnicsResponses(request: requests.ListNetworkSecurityGroupVnicsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.NetworkSecurityGroupVnic objects * contained in responses from the listNetworkSecurityGroupVnics operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listNetworkSecurityGroupVnicsRecordIterator(request: requests.ListNetworkSecurityGroupVnicsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listNetworkSecurityGroupVnics operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listNetworkSecurityGroupVnicsResponseIterator(request: requests.ListNetworkSecurityGroupVnicsRequest): AsyncIterableIterator; /** * 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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListNetworkSecurityGroupsRequest * @return ListNetworkSecurityGroupsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListNetworkSecurityGroups.ts.html |here} to see how to use ListNetworkSecurityGroups API. */ listNetworkSecurityGroups(listNetworkSecurityGroupsRequest: requests.ListNetworkSecurityGroupsRequest): Promise; /** * NOTE: This function is deprecated in favor of listNetworkSecurityGroupsRecordIterator function. * Creates a new async iterator which will iterate over the models.NetworkSecurityGroup objects * contained in responses from the listNetworkSecurityGroups operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllNetworkSecurityGroups(request: requests.ListNetworkSecurityGroupsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listNetworkSecurityGroupsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listNetworkSecurityGroups operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllNetworkSecurityGroupsResponses(request: requests.ListNetworkSecurityGroupsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.NetworkSecurityGroup objects * contained in responses from the listNetworkSecurityGroups operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listNetworkSecurityGroupsRecordIterator(request: requests.ListNetworkSecurityGroupsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listNetworkSecurityGroups operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listNetworkSecurityGroupsResponseIterator(request: requests.ListNetworkSecurityGroupsRequest): AsyncIterableIterator; /** * Lists the {@link PrivateIp} objects based * on one of these filters: *

- Subnet [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * - VNIC [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * - 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](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). For comparison, * {@link #getPrivateIp(GetPrivateIpRequest) getPrivateIp} * requires the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). *

If you're listing all the private IPs associated with a given subnet * or VNIC, the response includes both primary and secondary private IPs. *

If you are an Oracle Cloud VMware Solution customer and have VLANs * in your VCN, you can filter the list by VLAN [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). See {@link Vlan}. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListPrivateIpsRequest * @return ListPrivateIpsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListPrivateIps.ts.html |here} to see how to use ListPrivateIps API. */ listPrivateIps(listPrivateIpsRequest: requests.ListPrivateIpsRequest): Promise; /** * NOTE: This function is deprecated in favor of listPrivateIpsRecordIterator function. * Creates a new async iterator which will iterate over the models.PrivateIp objects * contained in responses from the listPrivateIps operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllPrivateIps(request: requests.ListPrivateIpsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listPrivateIpsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listPrivateIps operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllPrivateIpsResponses(request: requests.ListPrivateIpsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.PrivateIp objects * contained in responses from the listPrivateIps operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listPrivateIpsRecordIterator(request: requests.ListPrivateIpsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listPrivateIps operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listPrivateIpsResponseIterator(request: requests.ListPrivateIpsRequest): AsyncIterableIterator; /** * The operation lists available OCI's FastConnect MultiCloud Provider/Partner remote region names associated with an OCI region. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListProviderRemoteRegionsRequest * @return ListProviderRemoteRegionsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListProviderRemoteRegions.ts.html |here} to see how to use ListProviderRemoteRegions API. */ listProviderRemoteRegions(listProviderRemoteRegionsRequest: requests.ListProviderRemoteRegionsRequest): Promise; /** * NOTE: This function is deprecated in favor of listProviderRemoteRegionsRecordIterator function. * Creates a new async iterator which will iterate over the models.ProviderRemoteRegionName objects * contained in responses from the listProviderRemoteRegions operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllProviderRemoteRegions(request: requests.ListProviderRemoteRegionsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listProviderRemoteRegionsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listProviderRemoteRegions operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllProviderRemoteRegionsResponses(request: requests.ListProviderRemoteRegionsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.ProviderRemoteRegionName objects * contained in responses from the listProviderRemoteRegions operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listProviderRemoteRegionsRecordIterator(request: requests.ListProviderRemoteRegionsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listProviderRemoteRegions operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listProviderRemoteRegionsResponseIterator(request: requests.ListProviderRemoteRegionsRequest): AsyncIterableIterator; /** * Lists the public IP pools in the specified compartment. * You can filter the list using query parameters. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListPublicIpPoolsRequest * @return ListPublicIpPoolsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListPublicIpPools.ts.html |here} to see how to use ListPublicIpPools API. */ listPublicIpPools(listPublicIpPoolsRequest: requests.ListPublicIpPoolsRequest): Promise; /** * Lists the {@link PublicIp} objects * in the specified compartment. You can filter the list by using query parameters. *

To list your reserved public IPs: * * Set `scope` = `REGION` (required) * * Leave the `availabilityDomain` parameter empty * * Set `lifetime` = `RESERVED` *

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` *

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` *

**Note:** An ephemeral public IP assigned to a private IP * is always in the same availability domain and compartment as the private IP. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListPublicIpsRequest * @return ListPublicIpsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListPublicIps.ts.html |here} to see how to use ListPublicIps API. */ listPublicIps(listPublicIpsRequest: requests.ListPublicIpsRequest): Promise; /** * NOTE: This function is deprecated in favor of listPublicIpsRecordIterator function. * Creates a new async iterator which will iterate over the models.PublicIp objects * contained in responses from the listPublicIps operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllPublicIps(request: requests.ListPublicIpsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listPublicIpsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listPublicIps operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllPublicIpsResponses(request: requests.ListPublicIpsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.PublicIp objects * contained in responses from the listPublicIps operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listPublicIpsRecordIterator(request: requests.ListPublicIpsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listPublicIps operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listPublicIpsResponseIterator(request: requests.ListPublicIpsRequest): AsyncIterableIterator; /** * Lists the remote peering connections (RPCs) for the specified DRG and compartment * (the RPC's compartment). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListRemotePeeringConnectionsRequest * @return ListRemotePeeringConnectionsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListRemotePeeringConnections.ts.html |here} to see how to use ListRemotePeeringConnections API. */ listRemotePeeringConnections(listRemotePeeringConnectionsRequest: requests.ListRemotePeeringConnectionsRequest): Promise; /** * NOTE: This function is deprecated in favor of listRemotePeeringConnectionsRecordIterator function. * Creates a new async iterator which will iterate over the models.RemotePeeringConnection objects * contained in responses from the listRemotePeeringConnections operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllRemotePeeringConnections(request: requests.ListRemotePeeringConnectionsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listRemotePeeringConnectionsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listRemotePeeringConnections operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllRemotePeeringConnectionsResponses(request: requests.ListRemotePeeringConnectionsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.RemotePeeringConnection objects * contained in responses from the listRemotePeeringConnections operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listRemotePeeringConnectionsRecordIterator(request: requests.ListRemotePeeringConnectionsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listRemotePeeringConnections operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listRemotePeeringConnectionsResponseIterator(request: requests.ListRemotePeeringConnectionsRequest): AsyncIterableIterator; /** * 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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListRouteTablesRequest * @return ListRouteTablesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListRouteTables.ts.html |here} to see how to use ListRouteTables API. */ listRouteTables(listRouteTablesRequest: requests.ListRouteTablesRequest): Promise; /** * NOTE: This function is deprecated in favor of listRouteTablesRecordIterator function. * Creates a new async iterator which will iterate over the models.RouteTable objects * contained in responses from the listRouteTables operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllRouteTables(request: requests.ListRouteTablesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listRouteTablesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listRouteTables operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllRouteTablesResponses(request: requests.ListRouteTablesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.RouteTable objects * contained in responses from the listRouteTables operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listRouteTablesRecordIterator(request: requests.ListRouteTablesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listRouteTables operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listRouteTablesResponseIterator(request: requests.ListRouteTablesRequest): AsyncIterableIterator; /** * 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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListSecurityListsRequest * @return ListSecurityListsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListSecurityLists.ts.html |here} to see how to use ListSecurityLists API. */ listSecurityLists(listSecurityListsRequest: requests.ListSecurityListsRequest): Promise; /** * NOTE: This function is deprecated in favor of listSecurityListsRecordIterator function. * Creates a new async iterator which will iterate over the models.SecurityList objects * contained in responses from the listSecurityLists operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllSecurityLists(request: requests.ListSecurityListsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listSecurityListsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listSecurityLists operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllSecurityListsResponses(request: requests.ListSecurityListsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.SecurityList objects * contained in responses from the listSecurityLists operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listSecurityListsRecordIterator(request: requests.ListSecurityListsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listSecurityLists operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listSecurityListsResponseIterator(request: requests.ListSecurityListsRequest): AsyncIterableIterator; /** * Lists the service gateways in the specified compartment. You may optionally specify a VCN OCID * to filter the results by VCN. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListServiceGatewaysRequest * @return ListServiceGatewaysResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListServiceGateways.ts.html |here} to see how to use ListServiceGateways API. */ listServiceGateways(listServiceGatewaysRequest: requests.ListServiceGatewaysRequest): Promise; /** * NOTE: This function is deprecated in favor of listServiceGatewaysRecordIterator function. * Creates a new async iterator which will iterate over the models.ServiceGateway objects * contained in responses from the listServiceGateways operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllServiceGateways(request: requests.ListServiceGatewaysRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listServiceGatewaysResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listServiceGateways operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllServiceGatewaysResponses(request: requests.ListServiceGatewaysRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.ServiceGateway objects * contained in responses from the listServiceGateways operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listServiceGatewaysRecordIterator(request: requests.ListServiceGatewaysRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listServiceGateways operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listServiceGatewaysResponseIterator(request: requests.ListServiceGatewaysRequest): AsyncIterableIterator; /** * Lists the available {@link Service} objects that you can enable for a * service gateway in this region. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListServicesRequest * @return ListServicesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListServices.ts.html |here} to see how to use ListServices API. */ listServices(listServicesRequest: requests.ListServicesRequest): Promise; /** * NOTE: This function is deprecated in favor of listServicesRecordIterator function. * Creates a new async iterator which will iterate over the models.Service objects * contained in responses from the listServices operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllServices(request: requests.ListServicesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listServicesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listServices operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllServicesResponses(request: requests.ListServicesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.Service objects * contained in responses from the listServices operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listServicesRecordIterator(request: requests.ListServicesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listServices operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listServicesResponseIterator(request: requests.ListServicesRequest): AsyncIterableIterator; /** * 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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListSubnetsRequest * @return ListSubnetsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListSubnets.ts.html |here} to see how to use ListSubnets API. */ listSubnets(listSubnetsRequest: requests.ListSubnetsRequest): Promise; /** * NOTE: This function is deprecated in favor of listSubnetsRecordIterator function. * Creates a new async iterator which will iterate over the models.Subnet objects * contained in responses from the listSubnets operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllSubnets(request: requests.ListSubnetsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listSubnetsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listSubnets operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllSubnetsResponses(request: requests.ListSubnetsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.Subnet objects * contained in responses from the listSubnets operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listSubnetsRecordIterator(request: requests.ListSubnetsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listSubnets operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listSubnetsResponseIterator(request: requests.ListSubnetsRequest): AsyncIterableIterator; /** * Lists the virtual cloud networks (VCNs) in the specified compartment. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListVcnsRequest * @return ListVcnsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListVcns.ts.html |here} to see how to use ListVcns API. */ listVcns(listVcnsRequest: requests.ListVcnsRequest): Promise; /** * NOTE: This function is deprecated in favor of listVcnsRecordIterator function. * Creates a new async iterator which will iterate over the models.Vcn objects * contained in responses from the listVcns operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllVcns(request: requests.ListVcnsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listVcnsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listVcns operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllVcnsResponses(request: requests.ListVcnsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.Vcn objects * contained in responses from the listVcns operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listVcnsRecordIterator(request: requests.ListVcnsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listVcns operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listVcnsResponseIterator(request: requests.ListVcnsRequest): AsyncIterableIterator; /** * Gets the specified virtual circuit's associatedTunnelsInfo. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListVirtualCircuitAssociatedTunnelsRequest * @return ListVirtualCircuitAssociatedTunnelsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListVirtualCircuitAssociatedTunnels.ts.html |here} to see how to use ListVirtualCircuitAssociatedTunnels API. */ listVirtualCircuitAssociatedTunnels(listVirtualCircuitAssociatedTunnelsRequest: requests.ListVirtualCircuitAssociatedTunnelsRequest): Promise; /** * NOTE: This function is deprecated in favor of listVirtualCircuitAssociatedTunnelsRecordIterator function. * Creates a new async iterator which will iterate over the models.VirtualCircuitAssociatedTunnelDetails objects * contained in responses from the listVirtualCircuitAssociatedTunnels operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllVirtualCircuitAssociatedTunnels(request: requests.ListVirtualCircuitAssociatedTunnelsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listVirtualCircuitAssociatedTunnelsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listVirtualCircuitAssociatedTunnels operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllVirtualCircuitAssociatedTunnelsResponses(request: requests.ListVirtualCircuitAssociatedTunnelsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.VirtualCircuitAssociatedTunnelDetails objects * contained in responses from the listVirtualCircuitAssociatedTunnels operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listVirtualCircuitAssociatedTunnelsRecordIterator(request: requests.ListVirtualCircuitAssociatedTunnelsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listVirtualCircuitAssociatedTunnels operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listVirtualCircuitAssociatedTunnelsResponseIterator(request: requests.ListVirtualCircuitAssociatedTunnelsRequest): AsyncIterableIterator; /** * The operation lists available bandwidth levels for virtual circuits. For the compartment ID, provide the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of your tenancy (the root compartment). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListVirtualCircuitBandwidthShapesRequest * @return ListVirtualCircuitBandwidthShapesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListVirtualCircuitBandwidthShapes.ts.html |here} to see how to use ListVirtualCircuitBandwidthShapes API. */ listVirtualCircuitBandwidthShapes(listVirtualCircuitBandwidthShapesRequest: requests.ListVirtualCircuitBandwidthShapesRequest): Promise; /** * NOTE: This function is deprecated in favor of listVirtualCircuitBandwidthShapesRecordIterator function. * Creates a new async iterator which will iterate over the models.VirtualCircuitBandwidthShape objects * contained in responses from the listVirtualCircuitBandwidthShapes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllVirtualCircuitBandwidthShapes(request: requests.ListVirtualCircuitBandwidthShapesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listVirtualCircuitBandwidthShapesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listVirtualCircuitBandwidthShapes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllVirtualCircuitBandwidthShapesResponses(request: requests.ListVirtualCircuitBandwidthShapesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.VirtualCircuitBandwidthShape objects * contained in responses from the listVirtualCircuitBandwidthShapes operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listVirtualCircuitBandwidthShapesRecordIterator(request: requests.ListVirtualCircuitBandwidthShapesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listVirtualCircuitBandwidthShapes operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listVirtualCircuitBandwidthShapesResponseIterator(request: requests.ListVirtualCircuitBandwidthShapesRequest): AsyncIterableIterator; /** * Lists the public IP prefixes and their details for the specified * public virtual circuit. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListVirtualCircuitPublicPrefixesRequest * @return ListVirtualCircuitPublicPrefixesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListVirtualCircuitPublicPrefixes.ts.html |here} to see how to use ListVirtualCircuitPublicPrefixes API. */ listVirtualCircuitPublicPrefixes(listVirtualCircuitPublicPrefixesRequest: requests.ListVirtualCircuitPublicPrefixesRequest): Promise; /** * Lists the virtual circuits in the specified compartment. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListVirtualCircuitsRequest * @return ListVirtualCircuitsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListVirtualCircuits.ts.html |here} to see how to use ListVirtualCircuits API. */ listVirtualCircuits(listVirtualCircuitsRequest: requests.ListVirtualCircuitsRequest): Promise; /** * NOTE: This function is deprecated in favor of listVirtualCircuitsRecordIterator function. * Creates a new async iterator which will iterate over the models.VirtualCircuit objects * contained in responses from the listVirtualCircuits operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllVirtualCircuits(request: requests.ListVirtualCircuitsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listVirtualCircuitsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listVirtualCircuits operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllVirtualCircuitsResponses(request: requests.ListVirtualCircuitsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.VirtualCircuit objects * contained in responses from the listVirtualCircuits operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listVirtualCircuitsRecordIterator(request: requests.ListVirtualCircuitsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listVirtualCircuits operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listVirtualCircuitsResponseIterator(request: requests.ListVirtualCircuitsRequest): AsyncIterableIterator; /** * Lists the VLANs in the specified VCN and the specified compartment. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListVlansRequest * @return ListVlansResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListVlans.ts.html |here} to see how to use ListVlans API. */ listVlans(listVlansRequest: requests.ListVlansRequest): Promise; /** * NOTE: This function is deprecated in favor of listVlansRecordIterator function. * Creates a new async iterator which will iterate over the models.Vlan objects * contained in responses from the listVlans operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllVlans(request: requests.ListVlansRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listVlansResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listVlans operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllVlansResponses(request: requests.ListVlansRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.Vlan objects * contained in responses from the listVlans operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listVlansRecordIterator(request: requests.ListVlansRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listVlans operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listVlansResponseIterator(request: requests.ListVlansRequest): AsyncIterableIterator; /** * Lists the virtual test access points (VTAPs) in the specified compartment. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListVtapsRequest * @return ListVtapsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ListVtaps.ts.html |here} to see how to use ListVtaps API. */ listVtaps(listVtapsRequest: requests.ListVtapsRequest): Promise; /** * NOTE: This function is deprecated in favor of listVtapsRecordIterator function. * Creates a new async iterator which will iterate over the models.Vtap objects * contained in responses from the listVtaps operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllVtaps(request: requests.ListVtapsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listVtapsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listVtaps operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllVtapsResponses(request: requests.ListVtapsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.Vtap objects * contained in responses from the listVtaps operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listVtapsRecordIterator(request: requests.ListVtapsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listVtaps operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listVtapsResponseIterator(request: requests.ListVtapsRequest): AsyncIterableIterator; /** * Updates the specified Ipv4 CIDR block of a Subnet. The new Ipv4 CIDR IP range must meet the following criteria: *

- Must be valid. * - Must not overlap with another Ipv4 CIDR block in the Subnet or the on-premises network CIDR block. * - Must not exceed the limit of Ipv4 CIDR blocks allowed per Subnet. * - 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. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ModifyIpv4SubnetCidrRequest * @return ModifyIpv4SubnetCidrResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ModifyIpv4SubnetCidr.ts.html |here} to see how to use ModifyIpv4SubnetCidr API. */ modifyIpv4SubnetCidr(modifyIpv4SubnetCidrRequest: requests.ModifyIpv4SubnetCidrRequest): Promise; /** * Updates the specified CIDR block of a VCN. The new CIDR IP range must meet the following criteria: *

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

**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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ModifyVcnCidrRequest * @return ModifyVcnCidrResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ModifyVcnCidr.ts.html |here} to see how to use ModifyVcnCidr API. */ modifyVcnCidr(modifyVcnCidrRequest: requests.ModifyVcnCidrRequest): Promise; /** * Updates a Subnet by evaluating a sequence of patch instructions (JSON List Patch). * This operation is restricted to IPv6 CIDR-related fields only. * Supported selections (exact match) are: * - ipv6CidrBlock * - ipv6CidrBlocks * Only the REPLACE operation is supported. * The request must include the If-Match header for optimistic concurrency control. * This is an asynchronous operation. The subnet\u2019s lifecycleState is set to UPDATING while the patch work request * is in progress, and changes back to AVAILABLE after the patch operation is complete. * All patch instructions are applied atomically as a single operation; either all succeed or none are applied. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param PatchSubnetRequest * @return PatchSubnetResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/PatchSubnet.ts.html |here} to see how to use PatchSubnet API. */ patchSubnet(patchSubnetRequest: requests.PatchSubnetRequest): Promise; /** * Updates a VCN by evaluating a sequence of patch instructions (JSON List Patch). * This operation is restricted to IPv6 CIDR-related fields only. * Supported selections (exact match) are: * - ipv6CidrBlock * - ipv6PublicCidrBlock * - ipv6PrivateCidrBlocks * - byoipv6CidrDetails * Only the REPLACE operation is supported. * The request must include the If-Match header for optimistic concurrency control. * This is an asynchronous operation. The VCN\u2019s lifecycleState is set to UPDATING while the patch work request * is in progress, and changes back to AVAILABLE after the patch operation is complete. * All patch instructions are applied atomically as a single operation; either all succeed or none are applied. * NOTE: * `ipv6PublicCidrBlock` represents Oracle provided GUA on VCN. With PATCH API, customer can only remove it if present. * Since this is Oracle provided CIDR, there is no concept of replacing with customer provided CIDR. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param PatchVcnRequest * @return PatchVcnResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/PatchVcn.ts.html |here} to see how to use PatchVcn API. */ patchVcn(patchVcnRequest: requests.PatchVcnRequest): Promise; /** * Unassign the specified PrivateIP address from Virtual Network Interface Card (VNIC). You must specify the PrivateIP [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param PrivateIpVnicDetachRequest * @return PrivateIpVnicDetachResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/PrivateIpVnicDetach.ts.html |here} to see how to use PrivateIpVnicDetach API. */ privateIpVnicDetach(privateIpVnicDetachRequest: requests.PrivateIpVnicDetachRequest): Promise; /** * Dissociates the DRG NAT policy from the DRG attachment so no DRG NAT rules are advertised to it. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param RemoveDrgNatPolicyRequest * @return RemoveDrgNatPolicyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/RemoveDrgNatPolicy.ts.html |here} to see how to use RemoveDrgNatPolicy API. */ removeDrgNatPolicy(removeDrgNatPolicyRequest: requests.RemoveDrgNatPolicyRequest): Promise; /** * Request with DRG NAT rules to remove from the DRG NAT policy. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param RemoveDrgNatRulesRequest * @return RemoveDrgNatRulesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/RemoveDrgNatRules.ts.html |here} to see how to use RemoveDrgNatRules API. */ removeDrgNatRules(removeDrgNatRulesRequest: requests.RemoveDrgNatRulesRequest): Promise; /** * Removes one or more route distribution statements from the specified route distribution's map. * * This operation does not retry by default if the user has not defined a retry configuration. * @param RemoveDrgRouteDistributionStatementsRequest * @return RemoveDrgRouteDistributionStatementsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/RemoveDrgRouteDistributionStatements.ts.html |here} to see how to use RemoveDrgRouteDistributionStatements API. */ removeDrgRouteDistributionStatements(removeDrgRouteDistributionStatementsRequest: requests.RemoveDrgRouteDistributionStatementsRequest): Promise; /** * Removes one or more route rules from the specified DRG route table. * * This operation does not retry by default if the user has not defined a retry configuration. * @param RemoveDrgRouteRulesRequest * @return RemoveDrgRouteRulesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/RemoveDrgRouteRules.ts.html |here} to see how to use RemoveDrgRouteRules API. */ removeDrgRouteRules(removeDrgRouteRulesRequest: requests.RemoveDrgRouteRulesRequest): Promise; /** * Removes the export route distribution from the DRG attachment so no routes are advertised to it. * * This operation does not retry by default if the user has not defined a retry configuration. * @param RemoveExportDrgRouteDistributionRequest * @return RemoveExportDrgRouteDistributionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/RemoveExportDrgRouteDistribution.ts.html |here} to see how to use RemoveExportDrgRouteDistribution API. */ removeExportDrgRouteDistribution(removeExportDrgRouteDistributionRequest: requests.RemoveExportDrgRouteDistributionRequest): Promise; /** * Removes the import route distribution from the DRG route table so no routes are imported * into it. * * This operation does not retry by default if the user has not defined a retry configuration. * @param RemoveImportDrgRouteDistributionRequest * @return RemoveImportDrgRouteDistributionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/RemoveImportDrgRouteDistribution.ts.html |here} to see how to use RemoveImportDrgRouteDistribution API. */ removeImportDrgRouteDistribution(removeImportDrgRouteDistributionRequest: requests.RemoveImportDrgRouteDistributionRequest): Promise; /** * Remove an IPv4 prefix from a subnet * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param RemoveIpv4SubnetCidrRequest * @return RemoveIpv4SubnetCidrResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/RemoveIpv4SubnetCidr.ts.html |here} to see how to use RemoveIpv4SubnetCidr API. */ removeIpv4SubnetCidr(removeIpv4SubnetCidrRequest: requests.RemoveIpv4SubnetCidrRequest): Promise; /** * Remove an IPv6 prefix from a subnet. At least one IPv6 CIDR should remain. * * This operation does not retry by default if the user has not defined a retry configuration. * @param RemoveIpv6SubnetCidrRequest * @return RemoveIpv6SubnetCidrResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/RemoveIpv6SubnetCidr.ts.html |here} to see how to use RemoveIpv6SubnetCidr API. */ removeIpv6SubnetCidr(removeIpv6SubnetCidrRequest: requests.RemoveIpv6SubnetCidrRequest): Promise; /** * Removing an existing IPv6 prefix from a VCN. * * This operation does not retry by default if the user has not defined a retry configuration. * @param RemoveIpv6VcnCidrRequest * @return RemoveIpv6VcnCidrResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/RemoveIpv6VcnCidr.ts.html |here} to see how to use RemoveIpv6VcnCidr API. */ removeIpv6VcnCidr(removeIpv6VcnCidrRequest: requests.RemoveIpv6VcnCidrRequest): Promise; /** * Removes one or more security rules from the specified network security group. * * This operation does not retry by default if the user has not defined a retry configuration. * @param RemoveNetworkSecurityGroupSecurityRulesRequest * @return RemoveNetworkSecurityGroupSecurityRulesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/RemoveNetworkSecurityGroupSecurityRules.ts.html |here} to see how to use RemoveNetworkSecurityGroupSecurityRules API. */ removeNetworkSecurityGroupSecurityRules(removeNetworkSecurityGroupSecurityRulesRequest: requests.RemoveNetworkSecurityGroupSecurityRulesRequest): Promise; /** * Removes a CIDR block from the referenced public IP pool. * * This operation does not retry by default if the user has not defined a retry configuration. * @param RemovePublicIpPoolCapacityRequest * @return RemovePublicIpPoolCapacityResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/RemovePublicIpPoolCapacity.ts.html |here} to see how to use RemovePublicIpPoolCapacity API. */ removePublicIpPoolCapacity(removePublicIpPoolCapacityRequest: requests.RemovePublicIpPoolCapacityRequest): Promise; /** * Removes a specified CIDR block from a VCN. *

**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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param RemoveVcnCidrRequest * @return RemoveVcnCidrResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/RemoveVcnCidr.ts.html |here} to see how to use RemoveVcnCidr API. */ removeVcnCidr(removeVcnCidrRequest: requests.RemoveVcnCidrRequest): Promise; /** * Update BYOIP's origin ASN to byoasn. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param SetOriginAsnRequest * @return SetOriginAsnResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/SetOriginAsn.ts.html |here} to see how to use SetOriginAsn API. */ setOriginAsn(setOriginAsnRequest: requests.SetOriginAsnRequest): Promise; /** * Update prefix's origin ASN to OCI * * This operation does not retry by default if the user has not defined a retry configuration. * @param SetOriginAsnToOracleRequest * @return SetOriginAsnToOracleResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/SetOriginAsnToOracle.ts.html |here} to see how to use SetOriginAsnToOracle API. */ setOriginAsnToOracle(setOriginAsnToOracleRequest: requests.SetOriginAsnToOracleRequest): Promise; /** * Updates the tags or display name associated with the specified BYOASN Resource. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateByoasnRequest * @return UpdateByoasnResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateByoasn.ts.html |here} to see how to use UpdateByoasn API. */ updateByoasn(updateByoasnRequest: requests.UpdateByoasnRequest): Promise; /** * Updates the tags or display name associated to the specified BYOIP CIDR block. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateByoipRangeRequest * @return UpdateByoipRangeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateByoipRange.ts.html |here} to see how to use UpdateByoipRange API. */ updateByoipRange(updateByoipRangeRequest: requests.UpdateByoipRangeRequest): Promise; /** * Updates the specified VTAP capture filter's display name or tags. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateCaptureFilterRequest * @return UpdateCaptureFilterResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateCaptureFilter.ts.html |here} to see how to use UpdateCaptureFilter API. */ updateCaptureFilter(updateCaptureFilterRequest: requests.UpdateCaptureFilterRequest): Promise; /** * Updates the specified CPE's display name or tags. * Avoid entering confidential information. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateCpeRequest * @return UpdateCpeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateCpe.ts.html |here} to see how to use UpdateCpe API. */ updateCpe(updateCpeRequest: requests.UpdateCpeRequest): Promise; /** * Updates the specified cross-connect. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateCrossConnectRequest * @return UpdateCrossConnectResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateCrossConnect.ts.html |here} to see how to use UpdateCrossConnect API. */ updateCrossConnect(updateCrossConnectRequest: requests.UpdateCrossConnectRequest): Promise; /** * Updates the specified cross-connect group's display name. * Avoid entering confidential information. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateCrossConnectGroupRequest * @return UpdateCrossConnectGroupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateCrossConnectGroup.ts.html |here} to see how to use UpdateCrossConnectGroup API. */ updateCrossConnectGroup(updateCrossConnectGroupRequest: requests.UpdateCrossConnectGroupRequest): Promise; /** * Updates the Letter of Authority for the specified cross-connect. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateCrossConnectLetterOfAuthorityRequest * @return UpdateCrossConnectLetterOfAuthorityResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateCrossConnectLetterOfAuthority.ts.html |here} to see how to use UpdateCrossConnectLetterOfAuthority API. */ updateCrossConnectLetterOfAuthority(updateCrossConnectLetterOfAuthorityRequest: requests.UpdateCrossConnectLetterOfAuthorityRequest): Promise; /** * Updates the specified set of DHCP options. You can update the display name or the options * themselves. Avoid entering confidential information. *

Note that the `options` object you provide replaces the entire existing set of options. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateDhcpOptionsRequest * @return UpdateDhcpOptionsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateDhcpOptions.ts.html |here} to see how to use UpdateDhcpOptions API. */ updateDhcpOptions(updateDhcpOptionsRequest: requests.UpdateDhcpOptionsRequest): Promise; /** * Updates the specified DRG's display name or tags. Avoid entering confidential information. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateDrgRequest * @return UpdateDrgResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateDrg.ts.html |here} to see how to use UpdateDrg API. */ updateDrg(updateDrgRequest: requests.UpdateDrgRequest): Promise; /** * Updates the display name and routing information for the specified `DrgAttachment`. * Avoid entering confidential information. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateDrgAttachmentRequest * @return UpdateDrgAttachmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateDrgAttachment.ts.html |here} to see how to use UpdateDrgAttachment API. */ updateDrgAttachment(updateDrgAttachmentRequest: requests.UpdateDrgAttachmentRequest): Promise; /** * Updates the specified DRG NAT policy * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateDrgNatPolicyRequest * @return UpdateDrgNatPolicyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateDrgNatPolicy.ts.html |here} to see how to use UpdateDrgNatPolicy API. */ updateDrgNatPolicy(updateDrgNatPolicyRequest: requests.UpdateDrgNatPolicyRequest): Promise; /** * Updates DRG NAT rules in the specified DRG NAT policy. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateDrgNatRulesRequest * @return UpdateDrgNatRulesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateDrgNatRules.ts.html |here} to see how to use UpdateDrgNatRules API. */ updateDrgNatRules(updateDrgNatRulesRequest: requests.UpdateDrgNatRulesRequest): Promise; /** * Updates the specified route distribution * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateDrgRouteDistributionRequest * @return UpdateDrgRouteDistributionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateDrgRouteDistribution.ts.html |here} to see how to use UpdateDrgRouteDistribution API. */ updateDrgRouteDistribution(updateDrgRouteDistributionRequest: requests.UpdateDrgRouteDistributionRequest): Promise; /** * Updates one or more route distribution statements in the specified route distribution. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateDrgRouteDistributionStatementsRequest * @return UpdateDrgRouteDistributionStatementsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateDrgRouteDistributionStatements.ts.html |here} to see how to use UpdateDrgRouteDistributionStatements API. */ updateDrgRouteDistributionStatements(updateDrgRouteDistributionStatementsRequest: requests.UpdateDrgRouteDistributionStatementsRequest): Promise; /** * Updates one or more route rules in the specified DRG route table. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateDrgRouteRulesRequest * @return UpdateDrgRouteRulesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateDrgRouteRules.ts.html |here} to see how to use UpdateDrgRouteRules API. */ updateDrgRouteRules(updateDrgRouteRulesRequest: requests.UpdateDrgRouteRulesRequest): Promise; /** * Updates the specified DRG route table. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateDrgRouteTableRequest * @return UpdateDrgRouteTableResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateDrgRouteTable.ts.html |here} to see how to use UpdateDrgRouteTable API. */ updateDrgRouteTable(updateDrgRouteTableRequest: requests.UpdateDrgRouteTableRequest): Promise; /** * Updates the specified IPSec connection. *

To update an individual IPSec tunnel's attributes, use * {@link #updateIPSecConnectionTunnel(UpdateIPSecConnectionTunnelRequest) updateIPSecConnectionTunnel}. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateIPSecConnectionRequest * @return UpdateIPSecConnectionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateIPSecConnection.ts.html |here} to see how to use UpdateIPSecConnection API. */ updateIPSecConnection(updateIPSecConnectionRequest: requests.UpdateIPSecConnectionRequest): Promise; /** * 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: *

* If you change the tunnel's routing type or BGP session configuration, the tunnel will go * down while it's reprovisioned. *

* If you want to switch the tunnel's `routing` from `STATIC` to `BGP`, make sure the tunnel's * BGP session configuration attributes have been set ({@link #bgpSessionInfo(BgpSessionInfoRequest) bgpSessionInfo}). *

* If you want to switch the tunnel's `routing` from `BGP` to `STATIC`, make sure the * {@link IPSecConnection} already has at least one valid CIDR * static route. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateIPSecConnectionTunnelRequest * @return UpdateIPSecConnectionTunnelResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateIPSecConnectionTunnel.ts.html |here} to see how to use UpdateIPSecConnectionTunnel API. */ updateIPSecConnectionTunnel(updateIPSecConnectionTunnelRequest: requests.UpdateIPSecConnectionTunnelRequest): Promise; /** * Updates the shared secret (pre-shared key) for the specified tunnel. *

**Important:** If you change the shared secret, the tunnel will go down while it's reprovisioned. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateIPSecConnectionTunnelSharedSecretRequest * @return UpdateIPSecConnectionTunnelSharedSecretResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateIPSecConnectionTunnelSharedSecret.ts.html |here} to see how to use UpdateIPSecConnectionTunnelSharedSecret API. */ updateIPSecConnectionTunnelSharedSecret(updateIPSecConnectionTunnelSharedSecretRequest: requests.UpdateIPSecConnectionTunnelSharedSecretRequest): Promise; /** * Updates the specified internet gateway. You can disable/enable it, or change its display name * or tags. Avoid entering confidential information. *

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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateInternetGatewayRequest * @return UpdateInternetGatewayResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateInternetGateway.ts.html |here} to see how to use UpdateInternetGateway API. */ updateInternetGateway(updateInternetGatewayRequest: requests.UpdateInternetGatewayRequest): Promise; /** * Updates the specified IPv6. You must specify the object's [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * Use this operation if you want to: *

* 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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateIpv6Request * @return UpdateIpv6Response * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateIpv6.ts.html |here} to see how to use UpdateIpv6 API. */ updateIpv6(updateIpv6Request: requests.UpdateIpv6Request): Promise; /** * Updates the specified local peering gateway (LPG). * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateLocalPeeringGatewayRequest * @return UpdateLocalPeeringGatewayResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateLocalPeeringGateway.ts.html |here} to see how to use UpdateLocalPeeringGateway API. */ updateLocalPeeringGateway(updateLocalPeeringGatewayRequest: requests.UpdateLocalPeeringGatewayRequest): Promise; /** * Updates the specified NAT gateway. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateNatGatewayRequest * @return UpdateNatGatewayResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateNatGateway.ts.html |here} to see how to use UpdateNatGateway API. */ updateNatGateway(updateNatGatewayRequest: requests.UpdateNatGatewayRequest): Promise; /** * Updates the specified network security group. *

To add or remove an existing VNIC from the group, use * {@link #updateVnic(UpdateVnicRequest) updateVnic}. *

To add a VNIC to the group *when you create the VNIC*, specify the NSG's [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) during creation. * For example, see the `nsgIds` attribute in {@link #createVnicDetails(CreateVnicDetailsRequest) createVnicDetails}. *

To add or remove security rules from the group, use * {@link #addNetworkSecurityGroupSecurityRules(AddNetworkSecurityGroupSecurityRulesRequest) addNetworkSecurityGroupSecurityRules} * or * {@link #removeNetworkSecurityGroupSecurityRules(RemoveNetworkSecurityGroupSecurityRulesRequest) removeNetworkSecurityGroupSecurityRules}. *

To edit the contents of existing security rules in the group, use * {@link #updateNetworkSecurityGroupSecurityRules(UpdateNetworkSecurityGroupSecurityRulesRequest) updateNetworkSecurityGroupSecurityRules}. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateNetworkSecurityGroupRequest * @return UpdateNetworkSecurityGroupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateNetworkSecurityGroup.ts.html |here} to see how to use UpdateNetworkSecurityGroup API. */ updateNetworkSecurityGroup(updateNetworkSecurityGroupRequest: requests.UpdateNetworkSecurityGroupRequest): Promise; /** * Updates one or more security rules in the specified network security group. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateNetworkSecurityGroupSecurityRulesRequest * @return UpdateNetworkSecurityGroupSecurityRulesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateNetworkSecurityGroupSecurityRules.ts.html |here} to see how to use UpdateNetworkSecurityGroupSecurityRules API. */ updateNetworkSecurityGroupSecurityRules(updateNetworkSecurityGroupSecurityRulesRequest: requests.UpdateNetworkSecurityGroupSecurityRulesRequest): Promise; /** * Updates the specified private IP. You must specify the object's [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * Use this operation if you want to: *

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

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}. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdatePrivateIpRequest * @return UpdatePrivateIpResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdatePrivateIp.ts.html |here} to see how to use UpdatePrivateIp API. */ updatePrivateIp(updatePrivateIpRequest: requests.UpdatePrivateIpRequest): Promise; /** * Updates the specified public IP. You must specify the object's [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Use this operation if you want to: *

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

Assigning, moving, and unassigning a reserved public IP are asynchronous * operations. Poll the public IP's `lifecycleState` to determine if the operation * succeeded. *

**Note:** When moving a reserved public IP, the target private IP * must not already have a public IP with `lifecycleState` = 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 its * `lifecycleState` switches to AVAILABLE (it is not reassigned to its original private IP). * You must poll the public IP's `lifecycleState` to determine if the move succeeded. *

Regarding ephemeral public IPs: *

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

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

**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](https://docs.oracle.com/iaas/Content/Network/Tasks/managingpublicIPs.htm). * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdatePublicIpRequest * @return UpdatePublicIpResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdatePublicIp.ts.html |here} to see how to use UpdatePublicIp API. */ updatePublicIp(updatePublicIpRequest: requests.UpdatePublicIpRequest): Promise; /** * Updates the specified public IP pool. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdatePublicIpPoolRequest * @return UpdatePublicIpPoolResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdatePublicIpPool.ts.html |here} to see how to use UpdatePublicIpPool API. */ updatePublicIpPool(updatePublicIpPoolRequest: requests.UpdatePublicIpPoolRequest): Promise; /** * Updates the specified remote peering connection (RPC). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateRemotePeeringConnectionRequest * @return UpdateRemotePeeringConnectionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateRemotePeeringConnection.ts.html |here} to see how to use UpdateRemotePeeringConnection API. */ updateRemotePeeringConnection(updateRemotePeeringConnectionRequest: requests.UpdateRemotePeeringConnectionRequest): Promise; /** * Updates the specified route table's display name or route rules. * Avoid entering confidential information. *

Note that the `routeRules` object you provide replaces the entire existing set of rules. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateRouteTableRequest * @return UpdateRouteTableResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateRouteTable.ts.html |here} to see how to use UpdateRouteTable API. */ updateRouteTable(updateRouteTableRequest: requests.UpdateRouteTableRequest): Promise; /** * Updates the specified security list's display name or rules. * Avoid entering confidential information. *

Note that the `egressSecurityRules` or `ingressSecurityRules` objects you provide replace the entire * existing objects. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateSecurityListRequest * @return UpdateSecurityListResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateSecurityList.ts.html |here} to see how to use UpdateSecurityList API. */ updateSecurityList(updateSecurityListRequest: requests.UpdateSecurityListRequest): Promise; /** * Updates the specified service gateway. The information you provide overwrites the existing * attributes of the gateway. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateServiceGatewayRequest * @return UpdateServiceGatewayResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateServiceGateway.ts.html |here} to see how to use UpdateServiceGateway API. */ updateServiceGateway(updateServiceGatewayRequest: requests.UpdateServiceGatewayRequest): Promise; /** * Updates the specified subnet. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateSubnetRequest * @return UpdateSubnetResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateSubnet.ts.html |here} to see how to use UpdateSubnet API. */ updateSubnet(updateSubnetRequest: requests.UpdateSubnetRequest): Promise; /** * 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}). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateTunnelCpeDeviceConfigRequest * @return UpdateTunnelCpeDeviceConfigResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateTunnelCpeDeviceConfig.ts.html |here} to see how to use UpdateTunnelCpeDeviceConfig API. */ updateTunnelCpeDeviceConfig(updateTunnelCpeDeviceConfigRequest: requests.UpdateTunnelCpeDeviceConfigRequest): Promise; /** * Updates the specified VCN. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateVcnRequest * @return UpdateVcnResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateVcn.ts.html |here} to see how to use UpdateVcn API. */ updateVcn(updateVcnRequest: requests.UpdateVcnRequest): Promise; /** * 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. *

**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](https://docs.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm). *

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. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateVirtualCircuitRequest * @return UpdateVirtualCircuitResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateVirtualCircuit.ts.html |here} to see how to use UpdateVirtualCircuit API. */ updateVirtualCircuit(updateVirtualCircuitRequest: requests.UpdateVirtualCircuitRequest): Promise; /** * 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. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateVlanRequest * @return UpdateVlanResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateVlan.ts.html |here} to see how to use UpdateVlan API. */ updateVlan(updateVlanRequest: requests.UpdateVlanRequest): Promise; /** * Updates the specified VNIC. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateVnicRequest * @return UpdateVnicResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateVnic.ts.html |here} to see how to use UpdateVnic API. */ updateVnic(updateVnicRequest: requests.UpdateVnicRequest): Promise; /** * Updates the specified VTAP's display name or tags. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateVtapRequest * @return UpdateVtapResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpdateVtap.ts.html |here} to see how to use UpdateVtap API. */ updateVtap(updateVtapRequest: requests.UpdateVtapRequest): Promise; /** * Upgrades the DRG. After upgrade, you can control routing inside your DRG * via DRG attachments, route distributions, and DRG route tables. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpgradeDrgRequest * @return UpgradeDrgResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/UpgradeDrg.ts.html |here} to see how to use UpgradeDrg API. */ upgradeDrg(upgradeDrgRequest: requests.UpgradeDrgRequest): Promise; /** * 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. * See [To import a BYOASN](https://docs.oracle.com/iaas/Content/Network/Concepts/BYOASN.htm) for details. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ValidateByoasnRequest * @return ValidateByoasnResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ValidateByoasn.ts.html |here} to see how to use ValidateByoasn API. */ validateByoasn(validateByoasnRequest: requests.ValidateByoasnRequest): Promise; /** * 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](https://docs.oracle.com/iaas/Content/Network/Concepts/BYOIP.htm#import_cidr) for details. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ValidateByoipRangeRequest * @return ValidateByoipRangeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/ValidateByoipRange.ts.html |here} to see how to use ValidateByoipRange API. */ validateByoipRange(validateByoipRangeRequest: requests.ValidateByoipRangeRequest): Promise; /** * Withdraws BGP route advertisement for the BYOIP CIDR block. * * This operation does not retry by default if the user has not defined a retry configuration. * @param WithdrawByoipRangeRequest * @return WithdrawByoipRangeResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/core/WithdrawByoipRange.ts.html |here} to see how to use WithdrawByoipRange API. */ withdrawByoipRange(withdrawByoipRangeRequest: requests.WithdrawByoipRangeRequest): Promise; } export {};