Oracle Cloud Infrastructure v2.33.0, May 1 25

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

oci.ApiGateway.getSubscriber

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

Example Usage

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

const testSubscriber = oci.ApiGateway.getSubscriber({
    subscriberId: testSubscriberOciApigatewaySubscriber.id,
});

import pulumi
import pulumi_oci as oci

test_subscriber = oci.ApiGateway.get_subscriber(subscriber_id=test_subscriber_oci_apigateway_subscriber["id"])

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/apigateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.GetSubscriber(ctx, &apigateway.GetSubscriberArgs{
			SubscriberId: testSubscriberOciApigatewaySubscriber.Id,
		}, 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 testSubscriber = Oci.ApiGateway.GetSubscriber.Invoke(new()
    {
        SubscriberId = testSubscriberOciApigatewaySubscriber.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ApiGateway.ApiGatewayFunctions;
import com.pulumi.oci.ApiGateway.inputs.GetSubscriberArgs;
import java.util.List;
import java.util.ArrayList;
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 testSubscriber = ApiGatewayFunctions.getSubscriber(GetSubscriberArgs.builder()
            .subscriberId(testSubscriberOciApigatewaySubscriber.id())
            .build());

    }
}

variables:
  testSubscriber:
    fn::invoke:
      function: oci:ApiGateway:getSubscriber
      arguments:
        subscriberId: ${testSubscriberOciApigatewaySubscriber.id}

Using getSubscriber

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 getSubscriber(args: GetSubscriberArgs, opts?: InvokeOptions): Promise<GetSubscriberResult>
function getSubscriberOutput(args: GetSubscriberOutputArgs, opts?: InvokeOptions): Output<GetSubscriberResult>

def get_subscriber(subscriber_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetSubscriberResult
def get_subscriber_output(subscriber_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetSubscriberResult]

func LookupSubscriber(ctx *Context, args *LookupSubscriberArgs, opts ...InvokeOption) (*LookupSubscriberResult, error)
func LookupSubscriberOutput(ctx *Context, args *LookupSubscriberOutputArgs, opts ...InvokeOption) LookupSubscriberResultOutput

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

public static class GetSubscriber 
{
    public static Task<GetSubscriberResult> InvokeAsync(GetSubscriberArgs args, InvokeOptions? opts = null)
    public static Output<GetSubscriberResult> Invoke(GetSubscriberInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSubscriberResult> getSubscriber(GetSubscriberArgs args, InvokeOptions options)
public static Output<GetSubscriberResult> getSubscriber(GetSubscriberArgs args, InvokeOptions options)

fn::invoke:
  function: oci:ApiGateway/getSubscriber:getSubscriber
  arguments:
    # arguments dictionary

The following arguments are supported:

SubscriberId string: The ocid of the subscriber.

SubscriberId string: The ocid of the subscriber.

subscriberId String: The ocid of the subscriber.

subscriberId string: The ocid of the subscriber.

subscriber_id str: The ocid of the subscriber.

subscriberId String: The ocid of the subscriber.

getSubscriber Result

The following output properties are available:

Clients List<GetSubscriberClient>: The clients belonging to this subscriber.
CompartmentId string: The OCID of the compartment in which the resource is created.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
FreeformTags Dictionary<string, string>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The OCID of the resource.
LifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
State string: The current state of the subscriber.
SubscriberId string
TimeCreated string: The time this resource was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time this resource was last updated. An RFC3339 formatted datetime string.
UsagePlans List<string>: An array of OCIDs of usage plan resources.

Clients []GetSubscriberClient: The clients belonging to this subscriber.
CompartmentId string: The OCID of the compartment in which the resource is created.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
FreeformTags map[string]string: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The OCID of the resource.
LifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
State string: The current state of the subscriber.
SubscriberId string
TimeCreated string: The time this resource was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time this resource was last updated. An RFC3339 formatted datetime string.
UsagePlans []string: An array of OCIDs of usage plan resources.

clients List<GetSubscriberClient>: The clients belonging to this subscriber.
compartmentId String: The OCID of the compartment in which the resource is created.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
freeformTags Map<String,String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The OCID of the resource.
lifecycleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
state String: The current state of the subscriber.
subscriberId String
timeCreated String: The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated String: The time this resource was last updated. An RFC3339 formatted datetime string.
usagePlans List<String>: An array of OCIDs of usage plan resources.

clients GetSubscriberClient[]: The clients belonging to this subscriber.
compartmentId string: The OCID of the compartment in which the resource is created.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
freeformTags {[key: string]: string}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id string: The OCID of the resource.
lifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
state string: The current state of the subscriber.
subscriberId string
timeCreated string: The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated string: The time this resource was last updated. An RFC3339 formatted datetime string.
usagePlans string[]: An array of OCIDs of usage plan resources.

clients Sequence[GetSubscriberClient]: The clients belonging to this subscriber.
compartment_id str: The OCID of the compartment in which the resource is created.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
display_name str: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
freeform_tags Mapping[str, str]: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id str: The OCID of the resource.
lifecycle_details str: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
state str: The current state of the subscriber.
subscriber_id str
time_created str: The time this resource was created. An RFC3339 formatted datetime string.
time_updated str: The time this resource was last updated. An RFC3339 formatted datetime string.
usage_plans Sequence[str]: An array of OCIDs of usage plan resources.

clients List<Property Map>: The clients belonging to this subscriber.
compartmentId String: The OCID of the compartment in which the resource is created.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
freeformTags Map<String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The OCID of the resource.
lifecycleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
state String: The current state of the subscriber.
subscriberId String
timeCreated String: The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated String: The time this resource was last updated. An RFC3339 formatted datetime string.
usagePlans List<String>: An array of OCIDs of usage plan resources.

Supporting Types

GetSubscriberClient

Name string: The name of the client. Must be unique within a subscriber.
Token string: The token for the client. Must be unique within a tenancy.

Name string: The name of the client. Must be unique within a subscriber.
Token string: The token for the client. Must be unique within a tenancy.

name String: The name of the client. Must be unique within a subscriber.
token String: The token for the client. Must be unique within a tenancy.

name string: The name of the client. Must be unique within a subscriber.
token string: The token for the client. Must be unique within a tenancy.

name str: The name of the client. Must be unique within a subscriber.
token str: The token for the client. Must be unique within a tenancy.

name String: The name of the client. Must be unique within a subscriber.
token String: The token for the client. Must be unique within a tenancy.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

pulumi/pulumi-oci

oci.ApiGateway.getSubscriber

On this page

On this page

Example Usage

Using getSubscriber

getSubscriber Result

Supporting Types

GetSubscriberClient

Package Details

On this page

On this page