Azure Classic

v5.24.0 published on Wednesday, Nov 9, 2022 by Pulumi

getResources

Use this data source to access information about existing resources.

Using getResources

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 getResources(args: GetResourcesArgs, opts?: InvokeOptions): Promise<GetResourcesResult>
function getResourcesOutput(args: GetResourcesOutputArgs, opts?: InvokeOptions): Output<GetResourcesResult>
def get_resources(name: Optional[str] = None,
                  required_tags: Optional[Mapping[str, str]] = None,
                  resource_group_name: Optional[str] = None,
                  type: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetResourcesResult
def get_resources_output(name: Optional[pulumi.Input[str]] = None,
                  required_tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                  resource_group_name: Optional[pulumi.Input[str]] = None,
                  type: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetResourcesResult]
func GetResources(ctx *Context, args *GetResourcesArgs, opts ...InvokeOption) (*GetResourcesResult, error)
func GetResourcesOutput(ctx *Context, args *GetResourcesOutputArgs, opts ...InvokeOption) GetResourcesResultOutput

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

public static class GetResources 
{
    public static Task<GetResourcesResult> InvokeAsync(GetResourcesArgs args, InvokeOptions? opts = null)
    public static Output<GetResourcesResult> Invoke(GetResourcesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetResourcesResult> getResources(GetResourcesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: azure:core/getResources:getResources
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string

The name of the Resource.

RequiredTags Dictionary<string, string>

A mapping of tags which the resource has to have in order to be included in the result.

ResourceGroupName string

The name of the Resource group where the Resources are located.

Type string

The Resource Type of the Resources you want to list (e.g. Microsoft.Network/virtualNetworks). A full list of available Resource Types can be found here.

Name string

The name of the Resource.

RequiredTags map[string]string

A mapping of tags which the resource has to have in order to be included in the result.

ResourceGroupName string

The name of the Resource group where the Resources are located.

Type string

The Resource Type of the Resources you want to list (e.g. Microsoft.Network/virtualNetworks). A full list of available Resource Types can be found here.

name String

The name of the Resource.

requiredTags Map<String,String>

A mapping of tags which the resource has to have in order to be included in the result.

resourceGroupName String

The name of the Resource group where the Resources are located.

type String

The Resource Type of the Resources you want to list (e.g. Microsoft.Network/virtualNetworks). A full list of available Resource Types can be found here.

name string

The name of the Resource.

requiredTags {[key: string]: string}

A mapping of tags which the resource has to have in order to be included in the result.

resourceGroupName string

The name of the Resource group where the Resources are located.

type string

The Resource Type of the Resources you want to list (e.g. Microsoft.Network/virtualNetworks). A full list of available Resource Types can be found here.

name str

The name of the Resource.

required_tags Mapping[str, str]

A mapping of tags which the resource has to have in order to be included in the result.

resource_group_name str

The name of the Resource group where the Resources are located.

type str

The Resource Type of the Resources you want to list (e.g. Microsoft.Network/virtualNetworks). A full list of available Resource Types can be found here.

name String

The name of the Resource.

requiredTags Map<String>

A mapping of tags which the resource has to have in order to be included in the result.

resourceGroupName String

The name of the Resource group where the Resources are located.

type String

The Resource Type of the Resources you want to list (e.g. Microsoft.Network/virtualNetworks). A full list of available Resource Types can be found here.

getResources Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Name string

The name of this Resource.

ResourceGroupName string
Resources List<GetResourcesResource>

One or more resource blocks as defined below.

Type string

The type of this Resource. (e.g. Microsoft.Network/virtualNetworks).

RequiredTags Dictionary<string, string>
Id string

The provider-assigned unique ID for this managed resource.

Name string

The name of this Resource.

ResourceGroupName string
Resources []GetResourcesResource

One or more resource blocks as defined below.

Type string

The type of this Resource. (e.g. Microsoft.Network/virtualNetworks).

RequiredTags map[string]string
id String

The provider-assigned unique ID for this managed resource.

name String

The name of this Resource.

resourceGroupName String
resources List<GetResourcesResource>

One or more resource blocks as defined below.

type String

The type of this Resource. (e.g. Microsoft.Network/virtualNetworks).

requiredTags Map<String,String>
id string

The provider-assigned unique ID for this managed resource.

name string

The name of this Resource.

resourceGroupName string
resources GetResourcesResource[]

One or more resource blocks as defined below.

type string

The type of this Resource. (e.g. Microsoft.Network/virtualNetworks).

requiredTags {[key: string]: string}
id str

The provider-assigned unique ID for this managed resource.

name str

The name of this Resource.

resource_group_name str
resources Sequence[GetResourcesResource]

One or more resource blocks as defined below.

type str

The type of this Resource. (e.g. Microsoft.Network/virtualNetworks).

required_tags Mapping[str, str]
id String

The provider-assigned unique ID for this managed resource.

name String

The name of this Resource.

resourceGroupName String
resources List<Property Map>

One or more resource blocks as defined below.

type String

The type of this Resource. (e.g. Microsoft.Network/virtualNetworks).

requiredTags Map<String>

Supporting Types

GetResourcesResource

Id string

The ID of this Resource.

Location string

The Azure Region in which this Resource exists.

Name string

The name of the Resource.

Tags Dictionary<string, string>

A map of tags assigned to this Resource.

Type string

The Resource Type of the Resources you want to list (e.g. Microsoft.Network/virtualNetworks). A full list of available Resource Types can be found here.

Id string

The ID of this Resource.

Location string

The Azure Region in which this Resource exists.

Name string

The name of the Resource.

Tags map[string]string

A map of tags assigned to this Resource.

Type string

The Resource Type of the Resources you want to list (e.g. Microsoft.Network/virtualNetworks). A full list of available Resource Types can be found here.

id String

The ID of this Resource.

location String

The Azure Region in which this Resource exists.

name String

The name of the Resource.

tags Map<String,String>

A map of tags assigned to this Resource.

type String

The Resource Type of the Resources you want to list (e.g. Microsoft.Network/virtualNetworks). A full list of available Resource Types can be found here.

id string

The ID of this Resource.

location string

The Azure Region in which this Resource exists.

name string

The name of the Resource.

tags {[key: string]: string}

A map of tags assigned to this Resource.

type string

The Resource Type of the Resources you want to list (e.g. Microsoft.Network/virtualNetworks). A full list of available Resource Types can be found here.

id str

The ID of this Resource.

location str

The Azure Region in which this Resource exists.

name str

The name of the Resource.

tags Mapping[str, str]

A map of tags assigned to this Resource.

type str

The Resource Type of the Resources you want to list (e.g. Microsoft.Network/virtualNetworks). A full list of available Resource Types can be found here.

id String

The ID of this Resource.

location String

The Azure Region in which this Resource exists.

name String

The name of the Resource.

tags Map<String>

A map of tags assigned to this Resource.

type String

The Resource Type of the Resources you want to list (e.g. Microsoft.Network/virtualNetworks). A full list of available Resource Types can be found here.

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.