oci.OspGateway.getAddress

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 testAddress = oci.OspGateway.getAddress({
    addressId: testAddres.id,
    compartmentId: compartmentId,
    ospHomeRegion: addressOspHomeRegion,
});

import pulumi
import pulumi_oci as oci

test_address = oci.OspGateway.get_address(address_id=test_addres["id"],
    compartment_id=compartment_id,
    osp_home_region=address_osp_home_region)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ospgateway.GetAddress(ctx, &ospgateway.GetAddressArgs{
			AddressId:     testAddres.Id,
			CompartmentId: compartmentId,
			OspHomeRegion: addressOspHomeRegion,
		}, 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 testAddress = Oci.OspGateway.GetAddress.Invoke(new()
    {
        AddressId = testAddres.Id,
        CompartmentId = compartmentId,
        OspHomeRegion = addressOspHomeRegion,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.OspGateway.OspGatewayFunctions;
import com.pulumi.oci.OspGateway.inputs.GetAddressArgs;
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 testAddress = OspGatewayFunctions.getAddress(GetAddressArgs.builder()
            .addressId(testAddres.id())
            .compartmentId(compartmentId)
            .ospHomeRegion(addressOspHomeRegion)
            .build());

    }
}

variables:
  testAddress:
    fn::invoke:
      function: oci:OspGateway:getAddress
      arguments:
        addressId: ${testAddres.id}
        compartmentId: ${compartmentId}
        ospHomeRegion: ${addressOspHomeRegion}

Using getAddress

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 getAddress(args: GetAddressArgs, opts?: InvokeOptions): Promise<GetAddressResult>
function getAddressOutput(args: GetAddressOutputArgs, opts?: InvokeOptions): Output<GetAddressResult>

def get_address(address_id: Optional[str] = None,
                compartment_id: Optional[str] = None,
                osp_home_region: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetAddressResult
def get_address_output(address_id: Optional[pulumi.Input[str]] = None,
                compartment_id: Optional[pulumi.Input[str]] = None,
                osp_home_region: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetAddressResult]

func GetAddress(ctx *Context, args *GetAddressArgs, opts ...InvokeOption) (*GetAddressResult, error)
func GetAddressOutput(ctx *Context, args *GetAddressOutputArgs, opts ...InvokeOption) GetAddressResultOutput

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

public static class GetAddress 
{
    public static Task<GetAddressResult> InvokeAsync(GetAddressArgs args, InvokeOptions? opts = null)
    public static Output<GetAddressResult> Invoke(GetAddressInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAddressResult> getAddress(GetAddressArgs args, InvokeOptions options)
public static Output<GetAddressResult> getAddress(GetAddressArgs args, InvokeOptions options)

fn::invoke:
  function: oci:OspGateway/getAddress:getAddress
  arguments:
    # arguments dictionary

The following arguments are supported:

AddressId string: The identifier of the address.
CompartmentId string: The OCID of the compartment.
OspHomeRegion string: The home region's public name of the logged in user.

AddressId string: The identifier of the address.
CompartmentId string: The OCID of the compartment.
OspHomeRegion string: The home region's public name of the logged in user.

addressId String: The identifier of the address.
compartmentId String: The OCID of the compartment.
ospHomeRegion String: The home region's public name of the logged in user.

addressId string: The identifier of the address.
compartmentId string: The OCID of the compartment.
ospHomeRegion string: The home region's public name of the logged in user.

address_id str: The identifier of the address.
compartment_id str: The OCID of the compartment.
osp_home_region str: The home region's public name of the logged in user.

addressId String: The identifier of the address.
compartmentId String: The OCID of the compartment.
ospHomeRegion String: The home region's public name of the logged in user.

getAddress Result

The following output properties are available:

AddressId string
AddressKey string: Address identifier.
City string: Name of the city.
CompanyName string: Name of the customer company.
CompartmentId string
ContributorClass string: Contributor class of the customer company.
Country string: Country of the address.
County string: County of the address.
DepartmentName string: Department name of the customer company.
EmailAddress string: Contact person email address.
FirstName string: First name of the contact person.
Id string: The provider-assigned unique ID for this managed resource.
InternalNumber string: Internal number of the customer company.
JobTitle string: Job title of the contact person.
LastName string: Last name of the contact person.
Line1 string: Address line 1.
Line2 string: Address line 2.
Line3 string: Address line 3.
Line4 string: Address line 4.
MiddleName string: Middle name of the contact person.
MunicipalInscription string: Municipal Inscription.
OspHomeRegion string
PhoneCountryCode string: Phone country code of the contact person.
PhoneNumber string: Phone number of the contact person.
PostalCode string: Post code of the address.
Province string: Province of the address.
State string: State of the address.
StateInscription string: State Inscription.
StreetName string: Street name of the address.
StreetNumber string: Street number of the address.

AddressId string
AddressKey string: Address identifier.
City string: Name of the city.
CompanyName string: Name of the customer company.
CompartmentId string
ContributorClass string: Contributor class of the customer company.
Country string: Country of the address.
County string: County of the address.
DepartmentName string: Department name of the customer company.
EmailAddress string: Contact person email address.
FirstName string: First name of the contact person.
Id string: The provider-assigned unique ID for this managed resource.
InternalNumber string: Internal number of the customer company.
JobTitle string: Job title of the contact person.
LastName string: Last name of the contact person.
Line1 string: Address line 1.
Line2 string: Address line 2.
Line3 string: Address line 3.
Line4 string: Address line 4.
MiddleName string: Middle name of the contact person.
MunicipalInscription string: Municipal Inscription.
OspHomeRegion string
PhoneCountryCode string: Phone country code of the contact person.
PhoneNumber string: Phone number of the contact person.
PostalCode string: Post code of the address.
Province string: Province of the address.
State string: State of the address.
StateInscription string: State Inscription.
StreetName string: Street name of the address.
StreetNumber string: Street number of the address.

addressId String
addressKey String: Address identifier.
city String: Name of the city.
companyName String: Name of the customer company.
compartmentId String
contributorClass String: Contributor class of the customer company.
country String: Country of the address.
county String: County of the address.
departmentName String: Department name of the customer company.
emailAddress String: Contact person email address.
firstName String: First name of the contact person.
id String: The provider-assigned unique ID for this managed resource.
internalNumber String: Internal number of the customer company.
jobTitle String: Job title of the contact person.
lastName String: Last name of the contact person.
line1 String: Address line 1.
line2 String: Address line 2.
line3 String: Address line 3.
line4 String: Address line 4.
middleName String: Middle name of the contact person.
municipalInscription String: Municipal Inscription.
ospHomeRegion String
phoneCountryCode String: Phone country code of the contact person.
phoneNumber String: Phone number of the contact person.
postalCode String: Post code of the address.
province String: Province of the address.
state String: State of the address.
stateInscription String: State Inscription.
streetName String: Street name of the address.
streetNumber String: Street number of the address.

addressId string
addressKey string: Address identifier.
city string: Name of the city.
companyName string: Name of the customer company.
compartmentId string
contributorClass string: Contributor class of the customer company.
country string: Country of the address.
county string: County of the address.
departmentName string: Department name of the customer company.
emailAddress string: Contact person email address.
firstName string: First name of the contact person.
id string: The provider-assigned unique ID for this managed resource.
internalNumber string: Internal number of the customer company.
jobTitle string: Job title of the contact person.
lastName string: Last name of the contact person.
line1 string: Address line 1.
line2 string: Address line 2.
line3 string: Address line 3.
line4 string: Address line 4.
middleName string: Middle name of the contact person.
municipalInscription string: Municipal Inscription.
ospHomeRegion string
phoneCountryCode string: Phone country code of the contact person.
phoneNumber string: Phone number of the contact person.
postalCode string: Post code of the address.
province string: Province of the address.
state string: State of the address.
stateInscription string: State Inscription.
streetName string: Street name of the address.
streetNumber string: Street number of the address.

address_id str
address_key str: Address identifier.
city str: Name of the city.
company_name str: Name of the customer company.
compartment_id str
contributor_class str: Contributor class of the customer company.
country str: Country of the address.
county str: County of the address.
department_name str: Department name of the customer company.
email_address str: Contact person email address.
first_name str: First name of the contact person.
id str: The provider-assigned unique ID for this managed resource.
internal_number str: Internal number of the customer company.
job_title str: Job title of the contact person.
last_name str: Last name of the contact person.
line1 str: Address line 1.
line2 str: Address line 2.
line3 str: Address line 3.
line4 str: Address line 4.
middle_name str: Middle name of the contact person.
municipal_inscription str: Municipal Inscription.
osp_home_region str
phone_country_code str: Phone country code of the contact person.
phone_number str: Phone number of the contact person.
postal_code str: Post code of the address.
province str: Province of the address.
state str: State of the address.
state_inscription str: State Inscription.
street_name str: Street name of the address.
street_number str: Street number of the address.

addressId String
addressKey String: Address identifier.
city String: Name of the city.
companyName String: Name of the customer company.
compartmentId String
contributorClass String: Contributor class of the customer company.
country String: Country of the address.
county String: County of the address.
departmentName String: Department name of the customer company.
emailAddress String: Contact person email address.
firstName String: First name of the contact person.
id String: The provider-assigned unique ID for this managed resource.
internalNumber String: Internal number of the customer company.
jobTitle String: Job title of the contact person.
lastName String: Last name of the contact person.
line1 String: Address line 1.
line2 String: Address line 2.
line3 String: Address line 3.
line4 String: Address line 4.
middleName String: Middle name of the contact person.
municipalInscription String: Municipal Inscription.
ospHomeRegion String
phoneCountryCode String: Phone country code of the contact person.
phoneNumber String: Phone number of the contact person.
postalCode String: Post code of the address.
province String: Province of the address.
state String: State of the address.
stateInscription String: State Inscription.
streetName String: Street name of the address.
streetNumber String: Street number of the address.

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.OspGateway.getAddress

On this page

On this page

Example Usage

Using getAddress

getAddress Result

Package Details

On this page

On this page