gcore 0.21.0 published on Tuesday, Apr 22, 2025 by g-core
gcore.getInstance
Explore with Pulumi AI
Represent instance. Could be used with baremetal also
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as gcore from "@pulumi/gcore";
const pr = gcore.getProject({
name: "test",
});
const rg = gcore.getRegion({
name: "ED-10 Preprod",
});
const vm = Promise.all([rg, pr]).then(([rg, pr]) => gcore.getInstance({
name: "test-vm",
regionId: rg.id,
projectId: pr.id,
}));
export const view = vm;
import pulumi
import pulumi_gcore as gcore
pr = gcore.get_project(name="test")
rg = gcore.get_region(name="ED-10 Preprod")
vm = gcore.get_instance(name="test-vm",
region_id=rg.id,
project_id=pr.id)
pulumi.export("view", vm)
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/gcore"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
pr, err := gcore.GetProject(ctx, &gcore.GetProjectArgs{
Name: "test",
}, nil)
if err != nil {
return err
}
rg, err := gcore.GetRegion(ctx, &gcore.GetRegionArgs{
Name: "ED-10 Preprod",
}, nil)
if err != nil {
return err
}
vm, err := gcore.LookupInstance(ctx, &gcore.LookupInstanceArgs{
Name: "test-vm",
RegionId: pulumi.Float64Ref(rg.Id),
ProjectId: pulumi.Float64Ref(pr.Id),
}, nil)
if err != nil {
return err
}
ctx.Export("view", vm)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcore = Pulumi.Gcore;
return await Deployment.RunAsync(() =>
{
var pr = Gcore.GetProject.Invoke(new()
{
Name = "test",
});
var rg = Gcore.GetRegion.Invoke(new()
{
Name = "ED-10 Preprod",
});
var vm = Gcore.GetInstance.Invoke(new()
{
Name = "test-vm",
RegionId = rg.Apply(getRegionResult => getRegionResult.Id),
ProjectId = pr.Apply(getProjectResult => getProjectResult.Id),
});
return new Dictionary<string, object?>
{
["view"] = vm,
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcore.GcoreFunctions;
import com.pulumi.gcore.inputs.GetProjectArgs;
import com.pulumi.gcore.inputs.GetRegionArgs;
import com.pulumi.gcore.inputs.GetInstanceArgs;
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 pr = GcoreFunctions.getProject(GetProjectArgs.builder()
.name("test")
.build());
final var rg = GcoreFunctions.getRegion(GetRegionArgs.builder()
.name("ED-10 Preprod")
.build());
final var vm = GcoreFunctions.getInstance(GetInstanceArgs.builder()
.name("test-vm")
.regionId(rg.applyValue(getRegionResult -> getRegionResult.id()))
.projectId(pr.applyValue(getProjectResult -> getProjectResult.id()))
.build());
ctx.export("view", vm.applyValue(getInstanceResult -> getInstanceResult));
}
}
variables:
pr:
fn::invoke:
function: gcore:getProject
arguments:
name: test
rg:
fn::invoke:
function: gcore:getRegion
arguments:
name: ED-10 Preprod
vm:
fn::invoke:
function: gcore:getInstance
arguments:
name: test-vm
regionId: ${rg.id}
projectId: ${pr.id}
outputs:
view: ${vm}
Using getInstance
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 getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>
def get_instance(id: Optional[str] = None,
name: Optional[str] = None,
project_id: Optional[float] = None,
project_name: Optional[str] = None,
region_id: Optional[float] = None,
region_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
project_id: Optional[pulumi.Input[float]] = None,
project_name: Optional[pulumi.Input[str]] = None,
region_id: Optional[pulumi.Input[float]] = None,
region_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]
func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput
> Note: This function is named LookupInstance
in the Go SDK.
public static class GetInstance
{
public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
public static Output<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
fn::invoke:
function: gcore:index/getInstance:getInstance
arguments:
# arguments dictionary
The following arguments are supported:
- Name string
- Id string
- The ID of this resource.
- Project
Id double - Project
Name string - Region
Id double - Region
Name string
- Name string
- Id string
- The ID of this resource.
- Project
Id float64 - Project
Name string - Region
Id float64 - Region
Name string
- name String
- id String
- The ID of this resource.
- project
Id Double - project
Name String - region
Id Double - region
Name String
- name string
- id string
- The ID of this resource.
- project
Id number - project
Name string - region
Id number - region
Name string
- name str
- id str
- The ID of this resource.
- project_
id float - project_
name str - region_
id float - region_
name str
- name String
- id String
- The ID of this resource.
- project
Id Number - project
Name String - region
Id Number - region
Name String
getInstance Result
The following output properties are available:
- Addresses
List<Get
Instance Address> - Flavor Dictionary<string, string>
- Flavor
Id string - Id string
- The ID of this resource.
- Interfaces
List<Get
Instance Interface> - Metadatas
List<Get
Instance Metadata> - Name string
- Security
Groups List<GetInstance Security Group> - Firewalls list
- Status string
- Vm
State string - Volumes
List<Get
Instance Volume> - Project
Id double - Project
Name string - Region
Id double - Region
Name string
- Addresses
[]Get
Instance Address - Flavor map[string]string
- Flavor
Id string - Id string
- The ID of this resource.
- Interfaces
[]Get
Instance Interface - Metadatas
[]Get
Instance Metadata - Name string
- Security
Groups []GetInstance Security Group - Firewalls list
- Status string
- Vm
State string - Volumes
[]Get
Instance Volume - Project
Id float64 - Project
Name string - Region
Id float64 - Region
Name string
- addresses
List<Get
Instance Address> - flavor Map<String,String>
- flavor
Id String - id String
- The ID of this resource.
- interfaces
List<Get
Instance Interface> - metadatas
List<Get
Instance Metadata> - name String
- security
Groups List<GetInstance Security Group> - Firewalls list
- status String
- vm
State String - volumes
List<Get
Instance Volume> - project
Id Double - project
Name String - region
Id Double - region
Name String
- addresses
Get
Instance Address[] - flavor {[key: string]: string}
- flavor
Id string - id string
- The ID of this resource.
- interfaces
Get
Instance Interface[] - metadatas
Get
Instance Metadata[] - name string
- security
Groups GetInstance Security Group[] - Firewalls list
- status string
- vm
State string - volumes
Get
Instance Volume[] - project
Id number - project
Name string - region
Id number - region
Name string
- addresses
Sequence[Get
Instance Address] - flavor Mapping[str, str]
- flavor_
id str - id str
- The ID of this resource.
- interfaces
Sequence[Get
Instance Interface] - metadatas
Sequence[Get
Instance Metadata] - name str
- security_
groups Sequence[GetInstance Security Group] - Firewalls list
- status str
- vm_
state str - volumes
Sequence[Get
Instance Volume] - project_
id float - project_
name str - region_
id float - region_
name str
- addresses List<Property Map>
- flavor Map<String>
- flavor
Id String - id String
- The ID of this resource.
- interfaces List<Property Map>
- metadatas List<Property Map>
- name String
- security
Groups List<Property Map> - Firewalls list
- status String
- vm
State String - volumes List<Property Map>
- project
Id Number - project
Name String - region
Id Number - region
Name String
Supporting Types
GetInstanceAddress
GetInstanceAddressNet
GetInstanceInterface
- ip_
address str - network_
id str - port_
id str - subnet_
id str
GetInstanceMetadata
GetInstanceSecurityGroup
- Name string
- Name string
- name String
- name string
- name str
- name String
GetInstanceVolume
- Delete
On boolTermination - Volume
Id string
- Delete
On boolTermination - Volume
Id string
- delete
On BooleanTermination - volume
Id String
- delete
On booleanTermination - volume
Id string
- delete_
on_ booltermination - volume_
id str
- delete
On BooleanTermination - volume
Id String
Package Details
- Repository
- gcore g-core/terraform-provider-gcore
- License
- Notes
- This Pulumi package is based on the
gcore
Terraform Provider.