Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Oracle Cloud Infrastructure
  4. API Docs
  5. Analytics
  6. getAnalyticsInstancePrivateAccessChannel
Viewing docs for Oracle Cloud Infrastructure v4.21.0
published on Monday, Aug 24, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

oci.Analytics.getAnalyticsInstancePrivateAccessChannel

oci logo oci logo
Viewing docs for Oracle Cloud Infrastructure v4.21.0
published on Monday, Aug 24, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

    This data source provides details about a specific Analytics Instance Private Access Channel resource in Oracle Cloud Infrastructure Analytics service.

    Retrieve private access channel for the specified Analytics Instance.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testAnalyticsInstancePrivateAccessChannel = oci.analytics.getAnalyticsInstancePrivateAccessChannel({
    analyticsInstanceId: testAnalyticsInstance.id,
    privateAccessChannelKey: analyticsInstancePrivateAccessChannelPrivateAccessChannelKey,
});

    import pulumi
import pulumi_oci as oci

test_analytics_instance_private_access_channel = oci.analytics.get_analytics_instance_private_access_channel(analytics_instance_id=test_analytics_instance["id"],
    private_access_channel_key=analytics_instance_private_access_channel_private_access_channel_key)

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v4/go/oci/analytics"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := analytics.GetAnalyticsInstancePrivateAccessChannel(ctx, &analytics.GetAnalyticsInstancePrivateAccessChannelArgs{
			AnalyticsInstanceId:     testAnalyticsInstance.Id,
			PrivateAccessChannelKey: analyticsInstancePrivateAccessChannelPrivateAccessChannelKey,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testAnalyticsInstancePrivateAccessChannel = Oci.Analytics.GetAnalyticsInstancePrivateAccessChannel.Invoke(new()
    {
        AnalyticsInstanceId = testAnalyticsInstance.Id,
        PrivateAccessChannelKey = analyticsInstancePrivateAccessChannelPrivateAccessChannelKey,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Analytics.AnalyticsFunctions;
import com.pulumi.oci.Analytics.inputs.GetAnalyticsInstancePrivateAccessChannelArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testAnalyticsInstancePrivateAccessChannel = AnalyticsFunctions.getAnalyticsInstancePrivateAccessChannel(GetAnalyticsInstancePrivateAccessChannelArgs.builder()
            .analyticsInstanceId(testAnalyticsInstance.id())
            .privateAccessChannelKey(analyticsInstancePrivateAccessChannelPrivateAccessChannelKey)
            .build());

    }
}

    variables:
  testAnalyticsInstancePrivateAccessChannel:
    fn::invoke:
      function: oci:Analytics:getAnalyticsInstancePrivateAccessChannel
      arguments:
        analyticsInstanceId: ${testAnalyticsInstance.id}
        privateAccessChannelKey: ${analyticsInstancePrivateAccessChannelPrivateAccessChannelKey}

    pulumi {
  required_providers {
    oci = {
      source = "pulumi/oci"
    }
  }
}

data "oci_analytics_getanalyticsinstanceprivateaccesschannel" "testAnalyticsInstancePrivateAccessChannel" {
  analytics_instance_id      = testAnalyticsInstance.id
  private_access_channel_key = analyticsInstancePrivateAccessChannelPrivateAccessChannelKey
}

    Using getAnalyticsInstancePrivateAccessChannel

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAnalyticsInstancePrivateAccessChannel(args: GetAnalyticsInstancePrivateAccessChannelArgs, opts?: InvokeOptions): Promise<GetAnalyticsInstancePrivateAccessChannelResult>
function getAnalyticsInstancePrivateAccessChannelOutput(args: GetAnalyticsInstancePrivateAccessChannelOutputArgs, opts?: InvokeOutputOptions): Output<GetAnalyticsInstancePrivateAccessChannelResult>
    def get_analytics_instance_private_access_channel(analytics_instance_id: Optional[str] = None,
                                                  private_access_channel_key: Optional[str] = None,
                                                  opts: Optional[InvokeOptions] = None) -> GetAnalyticsInstancePrivateAccessChannelResult
def get_analytics_instance_private_access_channel_output(analytics_instance_id: pulumi.Input[Optional[str]] = None,
                                                  private_access_channel_key: pulumi.Input[Optional[str]] = None,
                                                  opts: Optional[InvokeOutputOptions] = None) -> Output[GetAnalyticsInstancePrivateAccessChannelResult]
    func LookupAnalyticsInstancePrivateAccessChannel(ctx *Context, args *LookupAnalyticsInstancePrivateAccessChannelArgs, opts ...InvokeOption) (*LookupAnalyticsInstancePrivateAccessChannelResult, error)
func LookupAnalyticsInstancePrivateAccessChannelOutput(ctx *Context, args *LookupAnalyticsInstancePrivateAccessChannelOutputArgs, opts ...InvokeOption) LookupAnalyticsInstancePrivateAccessChannelResultOutput

    > Note: This function is named LookupAnalyticsInstancePrivateAccessChannel in the Go SDK.

    public static class GetAnalyticsInstancePrivateAccessChannel 
{
    public static Task<GetAnalyticsInstancePrivateAccessChannelResult> InvokeAsync(GetAnalyticsInstancePrivateAccessChannelArgs args, InvokeOptions? opts = null)
    public static Output<GetAnalyticsInstancePrivateAccessChannelResult> Invoke(GetAnalyticsInstancePrivateAccessChannelInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetAnalyticsInstancePrivateAccessChannelResult> Invoke(GetAnalyticsInstancePrivateAccessChannelInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetAnalyticsInstancePrivateAccessChannelResult> getAnalyticsInstancePrivateAccessChannel(GetAnalyticsInstancePrivateAccessChannelArgs args, InvokeOptions options)
public static Output<GetAnalyticsInstancePrivateAccessChannelResult> getAnalyticsInstancePrivateAccessChannel(GetAnalyticsInstancePrivateAccessChannelArgs args, InvokeOptions options)
public static Output<GetAnalyticsInstancePrivateAccessChannelResult> getAnalyticsInstancePrivateAccessChannel(GetAnalyticsInstancePrivateAccessChannelArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: oci:Analytics/getAnalyticsInstancePrivateAccessChannel:getAnalyticsInstancePrivateAccessChannel
  arguments:
    # arguments dictionary
    data "oci_analytics_get_analytics_instance_private_access_channel" "name" {
    # arguments
}

    The following arguments are supported:

    AnalyticsInstanceId string
    The OCID of the Analytics instance.
    PrivateAccessChannelKey string
    The unique identifier key of the private access channel.
    AnalyticsInstanceId string
    The OCID of the Analytics instance.
    PrivateAccessChannelKey string
    The unique identifier key of the private access channel.
    analytics_instance_id string
    The OCID of the Analytics instance.
    private_access_channel_key string
    The unique identifier key of the private access channel.
    analyticsInstanceId String
    The OCID of the Analytics instance.
    privateAccessChannelKey String
    The unique identifier key of the private access channel.
    analyticsInstanceId string
    The OCID of the Analytics instance.
    privateAccessChannelKey string
    The unique identifier key of the private access channel.
    analytics_instance_id str
    The OCID of the Analytics instance.
    private_access_channel_key str
    The unique identifier key of the private access channel.
    analyticsInstanceId String
    The OCID of the Analytics instance.
    privateAccessChannelKey String
    The unique identifier key of the private access channel.

    getAnalyticsInstancePrivateAccessChannel Result

    The following output properties are available:

    AnalyticsInstanceId string
    DisplayName string
    Display name of the private access channel.
    EgressSourceIpAddresses List<string>
    List of IP addresses from the customer subnet connected to the private access channel, used as a source IP by the private access channel for network traffic from the Analytics instance to the private sources.
    Id string
    IpAddress string
    IP address of the private access channel.
    Key string
    Private access channel unique identifier key.
    NetworkSecurityGroupIds List<string>
    Network Security Group OCIDs for the Analytics instance.
    PrivateAccessChannelKey string
    PrivateSourceDnsZones List<GetAnalyticsInstancePrivateAccessChannelPrivateSourceDnsZone>
    List of private source DNS zones registered with the private access channel. The datasource hostnames from these DNS zones / domains will be resolved in the peered VCN for access from the Analytics instance. Minimum 1 private source is required. Maximum 30 private source DNS zones can be registered.
    PrivateSourceScanHosts List<GetAnalyticsInstancePrivateAccessChannelPrivateSourceScanHost>
    List of private source database SCAN hosts registered with the private access channel for access from the Analytics instance.
    SubnetId string
    OCID of the customer subnet connected to the private access channel.
    VcnId string
    OCID of the customer VCN peered with the private access channel.
    AnalyticsInstanceId string
    DisplayName string
    Display name of the private access channel.
    EgressSourceIpAddresses []string
    List of IP addresses from the customer subnet connected to the private access channel, used as a source IP by the private access channel for network traffic from the Analytics instance to the private sources.
    Id string
    IpAddress string
    IP address of the private access channel.
    Key string
    Private access channel unique identifier key.
    NetworkSecurityGroupIds []string
    Network Security Group OCIDs for the Analytics instance.
    PrivateAccessChannelKey string
    PrivateSourceDnsZones []GetAnalyticsInstancePrivateAccessChannelPrivateSourceDnsZone
    List of private source DNS zones registered with the private access channel. The datasource hostnames from these DNS zones / domains will be resolved in the peered VCN for access from the Analytics instance. Minimum 1 private source is required. Maximum 30 private source DNS zones can be registered.
    PrivateSourceScanHosts []GetAnalyticsInstancePrivateAccessChannelPrivateSourceScanHost
    List of private source database SCAN hosts registered with the private access channel for access from the Analytics instance.
    SubnetId string
    OCID of the customer subnet connected to the private access channel.
    VcnId string
    OCID of the customer VCN peered with the private access channel.
    analytics_instance_id string
    display_name string
    Display name of the private access channel.
    egress_source_ip_addresses list(string)
    List of IP addresses from the customer subnet connected to the private access channel, used as a source IP by the private access channel for network traffic from the Analytics instance to the private sources.
    id string
    ip_address string
    IP address of the private access channel.
    key string
    Private access channel unique identifier key.
    network_security_group_ids list(string)
    Network Security Group OCIDs for the Analytics instance.
    private_access_channel_key string
    private_source_dns_zones list(object)
    List of private source DNS zones registered with the private access channel. The datasource hostnames from these DNS zones / domains will be resolved in the peered VCN for access from the Analytics instance. Minimum 1 private source is required. Maximum 30 private source DNS zones can be registered.
    private_source_scan_hosts list(object)
    List of private source database SCAN hosts registered with the private access channel for access from the Analytics instance.
    subnet_id string
    OCID of the customer subnet connected to the private access channel.
    vcn_id string
    OCID of the customer VCN peered with the private access channel.
    analyticsInstanceId String
    displayName String
    Display name of the private access channel.
    egressSourceIpAddresses List<String>
    List of IP addresses from the customer subnet connected to the private access channel, used as a source IP by the private access channel for network traffic from the Analytics instance to the private sources.
    id String
    ipAddress String
    IP address of the private access channel.
    key String
    Private access channel unique identifier key.
    networkSecurityGroupIds List<String>
    Network Security Group OCIDs for the Analytics instance.
    privateAccessChannelKey String
    privateSourceDnsZones List<GetInstancePrivateAccessChannelPrivateSourceDnsZone>
    List of private source DNS zones registered with the private access channel. The datasource hostnames from these DNS zones / domains will be resolved in the peered VCN for access from the Analytics instance. Minimum 1 private source is required. Maximum 30 private source DNS zones can be registered.
    privateSourceScanHosts List<GetInstancePrivateAccessChannelPrivateSourceScanHost>
    List of private source database SCAN hosts registered with the private access channel for access from the Analytics instance.
    subnetId String
    OCID of the customer subnet connected to the private access channel.
    vcnId String
    OCID of the customer VCN peered with the private access channel.
    analyticsInstanceId string
    displayName string
    Display name of the private access channel.
    egressSourceIpAddresses string[]
    List of IP addresses from the customer subnet connected to the private access channel, used as a source IP by the private access channel for network traffic from the Analytics instance to the private sources.
    id string
    ipAddress string
    IP address of the private access channel.
    key string
    Private access channel unique identifier key.
    networkSecurityGroupIds string[]
    Network Security Group OCIDs for the Analytics instance.
    privateAccessChannelKey string
    privateSourceDnsZones GetAnalyticsInstancePrivateAccessChannelPrivateSourceDnsZone[]
    List of private source DNS zones registered with the private access channel. The datasource hostnames from these DNS zones / domains will be resolved in the peered VCN for access from the Analytics instance. Minimum 1 private source is required. Maximum 30 private source DNS zones can be registered.
    privateSourceScanHosts GetAnalyticsInstancePrivateAccessChannelPrivateSourceScanHost[]
    List of private source database SCAN hosts registered with the private access channel for access from the Analytics instance.
    subnetId string
    OCID of the customer subnet connected to the private access channel.
    vcnId string
    OCID of the customer VCN peered with the private access channel.
    analytics_instance_id str
    display_name str
    Display name of the private access channel.
    egress_source_ip_addresses Sequence[str]
    List of IP addresses from the customer subnet connected to the private access channel, used as a source IP by the private access channel for network traffic from the Analytics instance to the private sources.
    id str
    ip_address str
    IP address of the private access channel.
    key str
    Private access channel unique identifier key.
    network_security_group_ids Sequence[str]
    Network Security Group OCIDs for the Analytics instance.
    private_access_channel_key str
    private_source_dns_zones Sequence[GetAnalyticsInstancePrivateAccessChannelPrivateSourceDnsZone]
    List of private source DNS zones registered with the private access channel. The datasource hostnames from these DNS zones / domains will be resolved in the peered VCN for access from the Analytics instance. Minimum 1 private source is required. Maximum 30 private source DNS zones can be registered.
    private_source_scan_hosts Sequence[GetAnalyticsInstancePrivateAccessChannelPrivateSourceScanHost]
    List of private source database SCAN hosts registered with the private access channel for access from the Analytics instance.
    subnet_id str
    OCID of the customer subnet connected to the private access channel.
    vcn_id str
    OCID of the customer VCN peered with the private access channel.
    analyticsInstanceId String
    displayName String
    Display name of the private access channel.
    egressSourceIpAddresses List<String>
    List of IP addresses from the customer subnet connected to the private access channel, used as a source IP by the private access channel for network traffic from the Analytics instance to the private sources.
    id String
    ipAddress String
    IP address of the private access channel.
    key String
    Private access channel unique identifier key.
    networkSecurityGroupIds List<String>
    Network Security Group OCIDs for the Analytics instance.
    privateAccessChannelKey String
    privateSourceDnsZones List<Property Map>
    List of private source DNS zones registered with the private access channel. The datasource hostnames from these DNS zones / domains will be resolved in the peered VCN for access from the Analytics instance. Minimum 1 private source is required. Maximum 30 private source DNS zones can be registered.
    privateSourceScanHosts List<Property Map>
    List of private source database SCAN hosts registered with the private access channel for access from the Analytics instance.
    subnetId String
    OCID of the customer subnet connected to the private access channel.
    vcnId String
    OCID of the customer VCN peered with the private access channel.

    Supporting Types

    GetAnalyticsInstancePrivateAccessChannelPrivateSourceDnsZone

    Description string
    Description of private source SCAN host zone.
    DnsZone string
    Private source DNS zone. For example: example-vcn.oraclevcn.com, corp.example.com.
    Description string
    Description of private source SCAN host zone.
    DnsZone string
    Private source DNS zone. For example: example-vcn.oraclevcn.com, corp.example.com.
    description string
    Description of private source SCAN host zone.
    dns_zone string
    Private source DNS zone. For example: example-vcn.oraclevcn.com, corp.example.com.
    description String
    Description of private source SCAN host zone.
    dnsZone String
    Private source DNS zone. For example: example-vcn.oraclevcn.com, corp.example.com.
    description string
    Description of private source SCAN host zone.
    dnsZone string
    Private source DNS zone. For example: example-vcn.oraclevcn.com, corp.example.com.
    description str
    Description of private source SCAN host zone.
    dns_zone str
    Private source DNS zone. For example: example-vcn.oraclevcn.com, corp.example.com.
    description String
    Description of private source SCAN host zone.
    dnsZone String
    Private source DNS zone. For example: example-vcn.oraclevcn.com, corp.example.com.

    GetAnalyticsInstancePrivateAccessChannelPrivateSourceScanHost

    Description string
    Description of private source SCAN host zone.
    ScanHostname string
    Private source SCAN hostname. For example: db01-scan.corp.example.com, prd-db01-scan.mycompany.com.
    ScanPort int
    Private source SCAN host port. This is the source port where the SCAN protocol connects (for example, 1521).
    Description string
    Description of private source SCAN host zone.
    ScanHostname string
    Private source SCAN hostname. For example: db01-scan.corp.example.com, prd-db01-scan.mycompany.com.
    ScanPort int
    Private source SCAN host port. This is the source port where the SCAN protocol connects (for example, 1521).
    description string
    Description of private source SCAN host zone.
    scan_hostname string
    Private source SCAN hostname. For example: db01-scan.corp.example.com, prd-db01-scan.mycompany.com.
    scan_port number
    Private source SCAN host port. This is the source port where the SCAN protocol connects (for example, 1521).
    description String
    Description of private source SCAN host zone.
    scanHostname String
    Private source SCAN hostname. For example: db01-scan.corp.example.com, prd-db01-scan.mycompany.com.
    scanPort Integer
    Private source SCAN host port. This is the source port where the SCAN protocol connects (for example, 1521).
    description string
    Description of private source SCAN host zone.
    scanHostname string
    Private source SCAN hostname. For example: db01-scan.corp.example.com, prd-db01-scan.mycompany.com.
    scanPort number
    Private source SCAN host port. This is the source port where the SCAN protocol connects (for example, 1521).
    description str
    Description of private source SCAN host zone.
    scan_hostname str
    Private source SCAN hostname. For example: db01-scan.corp.example.com, prd-db01-scan.mycompany.com.
    scan_port int
    Private source SCAN host port. This is the source port where the SCAN protocol connects (for example, 1521).
    description String
    Description of private source SCAN host zone.
    scanHostname String
    Private source SCAN hostname. For example: db01-scan.corp.example.com, prd-db01-scan.mycompany.com.
    scanPort Number
    Private source SCAN host port. This is the source port where the SCAN protocol connects (for example, 1521).

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo oci logo
    Viewing docs for Oracle Cloud Infrastructure v4.21.0
    published on Monday, Aug 24, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-oci

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial