1. Packages
  2. Scm Provider
  3. API Docs
  4. getAddressObject
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi

scm.getAddressObject

Explore with Pulumi AI

scm logo
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi

    Retrieves a config item.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scm from "@pulumi/scm";
    
    const example = scm.getAddressObject({
        id: "1234-56-789",
    });
    
    import pulumi
    import pulumi_scm as scm
    
    example = scm.get_address_object(id="1234-56-789")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-scm/sdk/go/scm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := scm.LookupAddressObject(ctx, &scm.LookupAddressObjectArgs{
    			Id: "1234-56-789",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scm = Pulumi.Scm;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Scm.GetAddressObject.Invoke(new()
        {
            Id = "1234-56-789",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scm.ScmFunctions;
    import com.pulumi.scm.inputs.GetAddressObjectArgs;
    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 example = ScmFunctions.getAddressObject(GetAddressObjectArgs.builder()
                .id("1234-56-789")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: scm:getAddressObject
          Arguments:
            id: 1234-56-789
    

    Using getAddressObject

    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 getAddressObject(args: GetAddressObjectArgs, opts?: InvokeOptions): Promise<GetAddressObjectResult>
    function getAddressObjectOutput(args: GetAddressObjectOutputArgs, opts?: InvokeOptions): Output<GetAddressObjectResult>
    def get_address_object(id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetAddressObjectResult
    def get_address_object_output(id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetAddressObjectResult]
    func LookupAddressObject(ctx *Context, args *LookupAddressObjectArgs, opts ...InvokeOption) (*LookupAddressObjectResult, error)
    func LookupAddressObjectOutput(ctx *Context, args *LookupAddressObjectOutputArgs, opts ...InvokeOption) LookupAddressObjectResultOutput

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

    public static class GetAddressObject 
    {
        public static Task<GetAddressObjectResult> InvokeAsync(GetAddressObjectArgs args, InvokeOptions? opts = null)
        public static Output<GetAddressObjectResult> Invoke(GetAddressObjectInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAddressObjectResult> getAddressObject(GetAddressObjectArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: scm:index/getAddressObject:getAddressObject
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The Id param.
    Id string
    The Id param.
    id String
    The Id param.
    id string
    The Id param.
    id str
    The Id param.
    id String
    The Id param.

    getAddressObject Result

    The following output properties are available:

    Description string
    The Description param. String length must not exceed 1023 characters.
    Fqdn string
    The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$.
    Id string
    The Id param.
    IpNetmask string
    The IpNetmask param.
    IpRange string
    The IpRange param.
    IpWildcard string
    The IpWildcard param.
    Name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    Tags List<string>
    Tags for address object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    Tfid string
    Type string
    The Type param.
    Description string
    The Description param. String length must not exceed 1023 characters.
    Fqdn string
    The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$.
    Id string
    The Id param.
    IpNetmask string
    The IpNetmask param.
    IpRange string
    The IpRange param.
    IpWildcard string
    The IpWildcard param.
    Name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    Tags []string
    Tags for address object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    Tfid string
    Type string
    The Type param.
    description String
    The Description param. String length must not exceed 1023 characters.
    fqdn String
    The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$.
    id String
    The Id param.
    ipNetmask String
    The IpNetmask param.
    ipRange String
    The IpRange param.
    ipWildcard String
    The IpWildcard param.
    name String
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    tags List<String>
    Tags for address object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    tfid String
    type String
    The Type param.
    description string
    The Description param. String length must not exceed 1023 characters.
    fqdn string
    The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$.
    id string
    The Id param.
    ipNetmask string
    The IpNetmask param.
    ipRange string
    The IpRange param.
    ipWildcard string
    The IpWildcard param.
    name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    tags string[]
    Tags for address object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    tfid string
    type string
    The Type param.
    description str
    The Description param. String length must not exceed 1023 characters.
    fqdn str
    The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$.
    id str
    The Id param.
    ip_netmask str
    The IpNetmask param.
    ip_range str
    The IpRange param.
    ip_wildcard str
    The IpWildcard param.
    name str
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    tags Sequence[str]
    Tags for address object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    tfid str
    type str
    The Type param.
    description String
    The Description param. String length must not exceed 1023 characters.
    fqdn String
    The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$.
    id String
    The Id param.
    ipNetmask String
    The IpNetmask param.
    ipRange String
    The IpRange param.
    ipWildcard String
    The IpWildcard param.
    name String
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    tags List<String>
    Tags for address object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    tfid String
    type String
    The Type param.

    Package Details

    Repository
    scm pulumi/pulumi-scm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scm Terraform Provider.
    scm logo
    Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi