1. Packages
  2. Azure Native
  3. API Docs
  4. edge
  5. getInstance
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.7.1 published on Wednesday, Aug 13, 2025 by Pulumi

azure-native.edge.getInstance

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.7.1 published on Wednesday, Aug 13, 2025 by Pulumi

    Get Instance Resource

    Uses Azure REST API version 2025-06-01.

    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(instance_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     solution_name: Optional[str] = None,
                     target_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetInstanceResult
    def get_instance_output(instance_name: Optional[pulumi.Input[str]] = None,
                     resource_group_name: Optional[pulumi.Input[str]] = None,
                     solution_name: Optional[pulumi.Input[str]] = None,
                     target_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: azure-native:edge:getInstance
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceName string
    Name of the instance
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SolutionName string
    Name of the solution
    TargetName string
    Name of the target
    InstanceName string
    Name of the instance
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SolutionName string
    Name of the solution
    TargetName string
    Name of the target
    instanceName String
    Name of the instance
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    solutionName String
    Name of the solution
    targetName String
    Name of the target
    instanceName string
    Name of the instance
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    solutionName string
    Name of the solution
    targetName string
    Name of the target
    instance_name str
    Name of the instance
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    solution_name str
    Name of the solution
    target_name str
    Name of the target
    instanceName String
    Name of the instance
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    solutionName String
    Name of the solution
    targetName String
    Name of the target

    getInstance Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    ETag string
    If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.Edge.Outputs.InstancePropertiesResponse
    The resource-specific properties for this resource.
    SystemData Pulumi.AzureNative.Edge.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    ExtendedLocation Pulumi.AzureNative.Edge.Outputs.AzureResourceManagerCommonTypesExtendedLocationResponse
    The complex type of the extended location.
    AzureApiVersion string
    The Azure API version of the resource.
    ETag string
    If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties InstancePropertiesResponse
    The resource-specific properties for this resource.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    ExtendedLocation AzureResourceManagerCommonTypesExtendedLocationResponse
    The complex type of the extended location.
    azureApiVersion String
    The Azure API version of the resource.
    eTag String
    If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties InstancePropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    extendedLocation AzureResourceManagerCommonTypesExtendedLocationResponse
    The complex type of the extended location.
    azureApiVersion string
    The Azure API version of the resource.
    eTag string
    If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    properties InstancePropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    extendedLocation AzureResourceManagerCommonTypesExtendedLocationResponse
    The complex type of the extended location.
    azure_api_version str
    The Azure API version of the resource.
    e_tag str
    If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    properties InstancePropertiesResponse
    The resource-specific properties for this resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    extended_location AzureResourceManagerCommonTypesExtendedLocationResponse
    The complex type of the extended location.
    azureApiVersion String
    The Azure API version of the resource.
    eTag String
    If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties Property Map
    The resource-specific properties for this resource.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    extendedLocation Property Map
    The complex type of the extended location.

    Supporting Types

    AzureResourceManagerCommonTypesExtendedLocationResponse

    Name string
    The name of the extended location.
    Type string
    The type of the extended location.
    Name string
    The name of the extended location.
    Type string
    The type of the extended location.
    name String
    The name of the extended location.
    type String
    The type of the extended location.
    name string
    The name of the extended location.
    type string
    The type of the extended location.
    name str
    The name of the extended location.
    type str
    The type of the extended location.
    name String
    The name of the extended location.
    type String
    The type of the extended location.

    ComponentStatusResponse

    Name string
    Component name
    Status string
    Component status
    Name string
    Component name
    Status string
    Component status
    name String
    Component name
    status String
    Component status
    name string
    Component name
    status string
    Component status
    name str
    Component name
    status str
    Component status
    name String
    Component name
    status String
    Component status

    DeploymentStatusResponse

    Deployed int
    Indicates if Instance is deployed
    ExpectedRunningJobId int
    The expected running job id
    Generation int
    Deployment Generation
    LastModified string
    The lastModified of the Status
    RunningJobId int
    The running job id
    Status string
    Deployment status
    StatusDetails string
    Status details
    TargetStatuses List<Pulumi.AzureNative.Edge.Inputs.TargetStatusResponse>
    Target resource statuses
    Deployed int
    Indicates if Instance is deployed
    ExpectedRunningJobId int
    The expected running job id
    Generation int
    Deployment Generation
    LastModified string
    The lastModified of the Status
    RunningJobId int
    The running job id
    Status string
    Deployment status
    StatusDetails string
    Status details
    TargetStatuses []TargetStatusResponse
    Target resource statuses
    deployed Integer
    Indicates if Instance is deployed
    expectedRunningJobId Integer
    The expected running job id
    generation Integer
    Deployment Generation
    lastModified String
    The lastModified of the Status
    runningJobId Integer
    The running job id
    status String
    Deployment status
    statusDetails String
    Status details
    targetStatuses List<TargetStatusResponse>
    Target resource statuses
    deployed number
    Indicates if Instance is deployed
    expectedRunningJobId number
    The expected running job id
    generation number
    Deployment Generation
    lastModified string
    The lastModified of the Status
    runningJobId number
    The running job id
    status string
    Deployment status
    statusDetails string
    Status details
    targetStatuses TargetStatusResponse[]
    Target resource statuses
    deployed int
    Indicates if Instance is deployed
    expected_running_job_id int
    The expected running job id
    generation int
    Deployment Generation
    last_modified str
    The lastModified of the Status
    running_job_id int
    The running job id
    status str
    Deployment status
    status_details str
    Status details
    target_statuses Sequence[TargetStatusResponse]
    Target resource statuses
    deployed Number
    Indicates if Instance is deployed
    expectedRunningJobId Number
    The expected running job id
    generation Number
    Deployment Generation
    lastModified String
    The lastModified of the Status
    runningJobId Number
    The running job id
    status String
    Deployment status
    statusDetails String
    Status details
    targetStatuses List<Property Map>
    Target resource statuses

    InstancePropertiesResponse

    DeploymentTimestampEpoch double
    Deployment timestamp of instance
    ProvisioningState string
    Provisioning state of resource
    SolutionVersionId string
    Solution version of instance
    Status Pulumi.AzureNative.Edge.Inputs.DeploymentStatusResponse
    Status of instance
    TargetId string
    Target of instance
    ActiveState string
    State of instance
    ReconciliationPolicy Pulumi.AzureNative.Edge.Inputs.ReconciliationPolicyPropertiesResponse
    Reconciliation policy of instance
    SolutionScope string
    Scope of instance
    DeploymentTimestampEpoch float64
    Deployment timestamp of instance
    ProvisioningState string
    Provisioning state of resource
    SolutionVersionId string
    Solution version of instance
    Status DeploymentStatusResponse
    Status of instance
    TargetId string
    Target of instance
    ActiveState string
    State of instance
    ReconciliationPolicy ReconciliationPolicyPropertiesResponse
    Reconciliation policy of instance
    SolutionScope string
    Scope of instance
    deploymentTimestampEpoch Double
    Deployment timestamp of instance
    provisioningState String
    Provisioning state of resource
    solutionVersionId String
    Solution version of instance
    status DeploymentStatusResponse
    Status of instance
    targetId String
    Target of instance
    activeState String
    State of instance
    reconciliationPolicy ReconciliationPolicyPropertiesResponse
    Reconciliation policy of instance
    solutionScope String
    Scope of instance
    deploymentTimestampEpoch number
    Deployment timestamp of instance
    provisioningState string
    Provisioning state of resource
    solutionVersionId string
    Solution version of instance
    status DeploymentStatusResponse
    Status of instance
    targetId string
    Target of instance
    activeState string
    State of instance
    reconciliationPolicy ReconciliationPolicyPropertiesResponse
    Reconciliation policy of instance
    solutionScope string
    Scope of instance
    deployment_timestamp_epoch float
    Deployment timestamp of instance
    provisioning_state str
    Provisioning state of resource
    solution_version_id str
    Solution version of instance
    status DeploymentStatusResponse
    Status of instance
    target_id str
    Target of instance
    active_state str
    State of instance
    reconciliation_policy ReconciliationPolicyPropertiesResponse
    Reconciliation policy of instance
    solution_scope str
    Scope of instance
    deploymentTimestampEpoch Number
    Deployment timestamp of instance
    provisioningState String
    Provisioning state of resource
    solutionVersionId String
    Solution version of instance
    status Property Map
    Status of instance
    targetId String
    Target of instance
    activeState String
    State of instance
    reconciliationPolicy Property Map
    Reconciliation policy of instance
    solutionScope String
    Scope of instance

    ReconciliationPolicyPropertiesResponse

    Interval string
    Policy interval
    State string
    The state of the ReconciliationPolicy
    Interval string
    Policy interval
    State string
    The state of the ReconciliationPolicy
    interval String
    Policy interval
    state String
    The state of the ReconciliationPolicy
    interval string
    Policy interval
    state string
    The state of the ReconciliationPolicy
    interval str
    Policy interval
    state str
    The state of the ReconciliationPolicy
    interval String
    Policy interval
    state String
    The state of the ReconciliationPolicy

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    TargetStatusResponse

    ComponentStatuses []ComponentStatusResponse
    Component statuses
    Name string
    Target name
    Status string
    Target status
    componentStatuses List<ComponentStatusResponse>
    Component statuses
    name String
    Target name
    status String
    Target status
    componentStatuses ComponentStatusResponse[]
    Component statuses
    name string
    Target name
    status string
    Target status
    component_statuses Sequence[ComponentStatusResponse]
    Component statuses
    name str
    Target name
    status str
    Target status
    componentStatuses List<Property Map>
    Component statuses
    name String
    Target name
    status String
    Target status

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.7.1 published on Wednesday, Aug 13, 2025 by Pulumi