Find-AzureRmResource

NAME Find-AzureRmResource



SYNOPSIS

Searches for resources based on specified parameters.





SYNTAX

Find-AzureRmResource [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-ExpandProperties] [-ExtensionResourceType <String>]

[-InformationAction <ActionPreference>] [-InformationVariable <String>] [-ODataQuery <String>] [-Pre] [-ResourceGroupNameContains <String>]

[-ResourceGroupNameEquals <String>] [-ResourceNameContains <String>] [-ResourceNameEquals <String>] [-ResourceType <String>] [-Top <Int32>]

[<CommonParameters>]



Find-AzureRmResource [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-ExpandProperties] [-ExtensionResourceType <String>]

[-InformationAction <ActionPreference>] [-InformationVariable <String>] [-ODataQuery <String>] [-Pre] [-ResourceNameContains <String>]

[-ResourceNameEquals <String>] -ResourceType <String> -TenantLevel [-Top <Int32>] [<CommonParameters>]



Find-AzureRmResource [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-ExpandProperties] [-ExtensionResourceType <String>]

[-InformationAction <ActionPreference>] [-InformationVariable <String>] [-ODataQuery <String>] [-Pre] [-ResourceGroupNameContains <String>]

[-ResourceGroupNameEquals <String>] [-ResourceNameContains <String>] [-ResourceNameEquals <String>] -ResourceType <String> [-Top <Int32>]

[<CommonParameters>]



Find-AzureRmResource [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-ExpandProperties] [-InformationAction <ActionPreference>]

[-InformationVariable <String>] [-ODataQuery <String>] [-Pre] [-Tag <Hashtable>] [-Top <Int32>] [<CommonParameters>]



Find-AzureRmResource [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-ExpandProperties] [-InformationAction <ActionPreference>]

[-InformationVariable <String>] [-ODataQuery <String>] [-Pre] [-TagName <String>] [-TagValue <String>] [-Top <Int32>] [<CommonParameters>]





DESCRIPTION

The Find-AzureRmResource cmdlet searches for resources based on specified parameters.





PARAMETERS

-ApiVersion <String>

Specifies the version of the resource provider API to use. If you do not specify a version, this cmdlet uses the latest available version.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ExpandProperties [<SwitchParameter>]

Indicates that this cmdlet expands the properties of the resource.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-ExtensionResourceType <String>

Specifies the extension resource type for the resources for which this cmdlet searches. For instance:



`Microsoft.Sql/Servers/Databases`



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-InformationAction <ActionPreference>

Specifies how this cmdlet responds to an information event.



The acceptable values for this parameter are:



- Continue



- Ignore



- Inquire



- SilentlyContinue



- Stop



- Suspend



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationVariable <String>

Specifies an information variable.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ODataQuery <String>

Specifies an Open Data Protocol (OData) style filter. This cmdlet appends this value to the request in addition to any other filters.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Pre [<SwitchParameter>]

Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-ResourceGroupNameContains <String>

Specifies a partial name of a resource group. This cmdlet matches resource groups of which this value is a substring. The cmdlet searches for

resources in those resource groups.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupNameEquals <String>

The resource group name for a full match.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceNameContains <String>

Specifies a partial name of a resource. The cmdlet searches for resources which contain this value as a substring.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceNameEquals <String>

The resource name for a full match. e.g. if your resource name is testResource, you can specify testResource.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceType <String>

Specifies the type of a resource. For instance, for a database, the resource type is as follows:



`Microsoft.Sql/Servers/Databases`



This cmdlet searches for resources of the specified type.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Tag <Hashtable>

The tag filter for the OData query. The expected format is @{tagName=$null} or @{tagName = 'tagValue'}.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-TagName <String>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-TagValue <String>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-TenantLevel [<SwitchParameter>]

Indicates that this cmdlet operates at the tenant level.



Required? true

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Top <Int32>

Specifies the number of resources to retrieve.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

System.Management.Automation.PSObject







NOTES









Example 1: Search for resources by type and resource group name



PS C:\\>Find-AzureRmResource -ResourceType "microsoft.web/sites" -ResourceGroupNameContains "ResourceGroup"



This command searches for resources of the type microsoft.web/sites under resource groups that have names that match the string ResourceGroup.





Example 2: Search for resources by type and resource name



PS C:\\>Find-AzureRmResource -ResourceType "microsoft.web/sites" -ResourceNameContains "test"



This command searches for resources of the type microsoft.web/sites that have a resource name that matches the string test.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... rmresource

Get-AzureRmResource

Move-AzureRmResource

New-AzureRmResource

Remove-AzureRmResourceGroup

Set-AzureRmResourceGroup