< Back
Get-ProvAzureResourceGroup
Post
NAME Get-ProvAzureResourceGroup
SYNOPSIS
Read details of an Azure Resource Group.
SYNTAX
Get-ProvAzureResourceGroup -AuthContext <object> -Subscriptionid <Guid> [-ApiVersion <string>] [-ResourceGroupName
<string>] [<CommonParameters>]
DESCRIPTION
This cmdlet connects to the Azure REST API and reads resource group details for further processing with REST API
requests.
A PSobject of type Provance.Azure.ResourceManager.Tenant, to be used in further commandlets.
PARAMETERS
-AuthContext <object>
A valid authentication token, as provided by "Get-ProvAzureAuthContext"
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-ApiVersion <string>
The REST API Version used to read the data from Azure. Default is "2016-01-01", but may be changed due to
updates in the REST API on Azure
See https://docs.microsoft.com/en-us/rest/a ... urcegroups for more.
Required? false
Position? named
Default value 2018-01-01
Accept pipeline input? false
Accept wildcard characters? false
-Subscriptionid <Guid>
The GUID of the Azure Subscription where the Resource Group has been created.
Required? true
Position? named
Default value 00000000-0000-0000-0000-000000000000
Accept pipeline input? false
Accept wildcard characters? false
-ResourceGroupName <string>
The name of the Resource Group to look for.
If this parameteris not specified, all Resource Groups of the Subscriptions will be returned.
Required? false
Position? named
Default value
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.Object
A valid authentication token, as provided by "Get-ProvAzureAuthContext"
OUTPUTS
Provance.Azure.Common.Model.ResourceGroup
---------- EXAMPLE 1 ----------
Retrieving Azure Resource Group details
$myresourcegroup = Get-ProvAzureResourceGroup -AuthContext $token -SubscriptionId
'f56127c0-7c3e-4994-8733-e14eaf7864c8' -ResourceGroupName 'VirtualMachines'
The $token object shall be generated with Get-ProvAzureAuthContext first
---------- EXAMPLE 2 ----------
Retrieving details of all Azure Resource Groups in the subscription
$myresourcegroup = Get-ProvAzureResourceGroup -AuthContext $token -SubscriptionId
'f56127c0-7c3e-4994-8733-e14eaf7864c8'
The $token object shall be generated with Get-ProvAzureAuthContext first
RELATED LINKS
Provance Technologies Inc. (http://provance.com)
Help (http://help.provance.com)
SYNOPSIS
Read details of an Azure Resource Group.
SYNTAX
Get-ProvAzureResourceGroup -AuthContext <object> -Subscriptionid <Guid> [-ApiVersion <string>] [-ResourceGroupName
<string>] [<CommonParameters>]
DESCRIPTION
This cmdlet connects to the Azure REST API and reads resource group details for further processing with REST API
requests.
A PSobject of type Provance.Azure.ResourceManager.Tenant, to be used in further commandlets.
PARAMETERS
-AuthContext <object>
A valid authentication token, as provided by "Get-ProvAzureAuthContext"
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-ApiVersion <string>
The REST API Version used to read the data from Azure. Default is "2016-01-01", but may be changed due to
updates in the REST API on Azure
See https://docs.microsoft.com/en-us/rest/a ... urcegroups for more.
Required? false
Position? named
Default value 2018-01-01
Accept pipeline input? false
Accept wildcard characters? false
-Subscriptionid <Guid>
The GUID of the Azure Subscription where the Resource Group has been created.
Required? true
Position? named
Default value 00000000-0000-0000-0000-000000000000
Accept pipeline input? false
Accept wildcard characters? false
-ResourceGroupName <string>
The name of the Resource Group to look for.
If this parameteris not specified, all Resource Groups of the Subscriptions will be returned.
Required? false
Position? named
Default value
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.Object
A valid authentication token, as provided by "Get-ProvAzureAuthContext"
OUTPUTS
Provance.Azure.Common.Model.ResourceGroup
---------- EXAMPLE 1 ----------
Retrieving Azure Resource Group details
$myresourcegroup = Get-ProvAzureResourceGroup -AuthContext $token -SubscriptionId
'f56127c0-7c3e-4994-8733-e14eaf7864c8' -ResourceGroupName 'VirtualMachines'
The $token object shall be generated with Get-ProvAzureAuthContext first
---------- EXAMPLE 2 ----------
Retrieving details of all Azure Resource Groups in the subscription
$myresourcegroup = Get-ProvAzureResourceGroup -AuthContext $token -SubscriptionId
'f56127c0-7c3e-4994-8733-e14eaf7864c8'
The $token object shall be generated with Get-ProvAzureAuthContext first
RELATED LINKS
Provance Technologies Inc. (http://provance.com)
Help (http://help.provance.com)