We recommend using Azure Native.
azure.core.getResources
Explore with Pulumi AI
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.
- Dictionary<string, string>
A mapping of tags which the resource has to have in order to be included in the result.
- Resource
Group stringName 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.
- map[string]string
A mapping of tags which the resource has to have in order to be included in the result.
- Resource
Group stringName 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.
- Map<String,String>
A mapping of tags which the resource has to have in order to be included in the result.
- resource
Group StringName 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.
- {[key: string]: string}
A mapping of tags which the resource has to have in order to be included in the result.
- resource
Group stringName 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.
- Mapping[str, str]
A mapping of tags which the resource has to have in order to be included in the result.
- resource_
group_ strname 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.
- Map<String>
A mapping of tags which the resource has to have in order to be included in the result.
- resource
Group StringName 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.
- Resource
Group stringName The name of the Resource Group in which this Resource exists.
- Resources
List<Get
Resources Resource> One or more
resource
blocks as defined below.- Type string
The type of this Resource. (e.g.
Microsoft.Network/virtualNetworks
).- Dictionary<string, string>
- Id string
The provider-assigned unique ID for this managed resource.
- Name string
The name of this Resource.
- Resource
Group stringName The name of the Resource Group in which this Resource exists.
- Resources
[]Get
Resources Resource One or more
resource
blocks as defined below.- Type string
The type of this Resource. (e.g.
Microsoft.Network/virtualNetworks
).- map[string]string
- id String
The provider-assigned unique ID for this managed resource.
- name String
The name of this Resource.
- resource
Group StringName The name of the Resource Group in which this Resource exists.
- resources
List<Get
Resources Resource> One or more
resource
blocks as defined below.- type String
The type of this Resource. (e.g.
Microsoft.Network/virtualNetworks
).- Map<String,String>
- id string
The provider-assigned unique ID for this managed resource.
- name string
The name of this Resource.
- resource
Group stringName The name of the Resource Group in which this Resource exists.
- resources
Get
Resources Resource[] One or more
resource
blocks as defined below.- type string
The type of this Resource. (e.g.
Microsoft.Network/virtualNetworks
).- {[key: string]: string}
- id str
The provider-assigned unique ID for this managed resource.
- name str
The name of this Resource.
- resource_
group_ strname The name of the Resource Group in which this Resource exists.
- resources
Sequence[Get
Resources Resource] One or more
resource
blocks as defined below.- type str
The type of this Resource. (e.g.
Microsoft.Network/virtualNetworks
).- Mapping[str, str]
- id String
The provider-assigned unique ID for this managed resource.
- name String
The name of this Resource.
- resource
Group StringName The name of the Resource Group in which this Resource exists.
- resources List<Property Map>
One or more
resource
blocks as defined below.- type String
The type of this Resource. (e.g.
Microsoft.Network/virtualNetworks
).- 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.
- Resource
Group stringName The name of the Resource group where the Resources are located.
- 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.
- Resource
Group stringName The name of the Resource group where the Resources are located.
- 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.
- resource
Group StringName The name of the Resource group where the Resources are located.
- 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.
- resource
Group stringName The name of the Resource group where the Resources are located.
- {[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.
- resource_
group_ strname The name of the Resource group where the Resources are located.
- 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.
- resource
Group StringName The name of the Resource group where the Resources are located.
- 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
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurerm
Terraform Provider.