1. Packages
  2. Netbox Provider
  3. API Docs
  4. getRegion
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger

netbox.getRegion

Explore with Pulumi AI

netbox logo
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger

    Using getRegion

    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 getRegion(args: GetRegionArgs, opts?: InvokeOptions): Promise<GetRegionResult>
    function getRegionOutput(args: GetRegionOutputArgs, opts?: InvokeOptions): Output<GetRegionResult>
    def get_region(filters: Optional[Sequence[GetRegionFilter]] = None,
                   opts: Optional[InvokeOptions] = None) -> GetRegionResult
    def get_region_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetRegionFilterArgs]]]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetRegionResult]
    func LookupRegion(ctx *Context, args *LookupRegionArgs, opts ...InvokeOption) (*LookupRegionResult, error)
    func LookupRegionOutput(ctx *Context, args *LookupRegionOutputArgs, opts ...InvokeOption) LookupRegionResultOutput

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

    public static class GetRegion 
    {
        public static Task<GetRegionResult> InvokeAsync(GetRegionArgs args, InvokeOptions? opts = null)
        public static Output<GetRegionResult> Invoke(GetRegionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRegionResult> getRegion(GetRegionArgs args, InvokeOptions options)
    public static Output<GetRegionResult> getRegion(GetRegionArgs args, InvokeOptions options)
    
    fn::invoke:
      function: netbox:index/getRegion:getRegion
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getRegion Result

    The following output properties are available:

    Description string
    Id double
    The ID of this resource.
    Name string
    ParentRegionId double
    Slug string
    Filters List<GetRegionFilter>
    Description string
    Id float64
    The ID of this resource.
    Name string
    ParentRegionId float64
    Slug string
    Filters []GetRegionFilter
    description String
    id Double
    The ID of this resource.
    name String
    parentRegionId Double
    slug String
    filters List<GetRegionFilter>
    description string
    id number
    The ID of this resource.
    name string
    parentRegionId number
    slug string
    filters GetRegionFilter[]
    description str
    id float
    The ID of this resource.
    name str
    parent_region_id float
    slug str
    filters Sequence[GetRegionFilter]
    description String
    id Number
    The ID of this resource.
    name String
    parentRegionId Number
    slug String
    filters List<Property Map>

    Supporting Types

    GetRegionFilter

    Id double
    The ID of this resource.
    Name string
    Slug string
    Id float64
    The ID of this resource.
    Name string
    Slug string
    id Double
    The ID of this resource.
    name String
    slug String
    id number
    The ID of this resource.
    name string
    slug string
    id float
    The ID of this resource.
    name str
    slug str
    id Number
    The ID of this resource.
    name String
    slug String

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    netbox logo
    netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger