Get-AzsInfrastructureRole
Returns the requested infrastructure role description.
Syntax
Get-AzsInfrastructureRole
[-Location <String>]
[-ResourceGroupName <String>]
[-SubscriptionId <String[]>]
[-Filter <String>]
[-DefaultProfile <PSObject>]
[-PassThru]
[<CommonParameters>] Get-AzsInfrastructureRole
-Name <String>
[-Location <String>]
[-ResourceGroupName <String>]
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[-PassThru]
[<CommonParameters>] Get-AzsInfrastructureRole
-INPUTOBJECT \<IFabricAdminIdentity>
[-DefaultProfile <PSObject>]
[-PassThru]
[<CommonParameters>] Description
Returns the requested infrastructure role description.
Examples
Example 1:
PS C:\> Get-AzsInfrastructureRole
A list of all infrastructure roles.Get a list of all infrastructure roles.
Example 2:
PS C:\> Get-AzsInfrastructureRole -Name "Active Directory Federation Services"
An infrastructure role based on the name.Get an infrastructure role based on the name.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | System.Management.Automation.PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Filter
OData filter parameter.
| Type: | System.String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | Microsoft.Azure.PowerShell.Cmdlets.FabricAdmin.Models.IFabricAdminIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Location
Location of the resource.
| Type: | System.String |
| Position: | Named |
| Default value: | (Get-AzLocation)[0].Location |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Infrastructure role name.
| Type: | System.String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PassThru
Returns true when the command succeeds
| Type: | System.Management.Automation.SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
Name of the resource group.
| Type: | System.String |
| Position: | Named |
| Default value: | -join("System.",(Get-AzLocation)[0].Location) |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
| Type: | System.String[] |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.Azure.PowerShell.Cmdlets.FabricAdmin.Models.IFabricAdminIdentity
Outputs
Microsoft.Azure.PowerShell.Cmdlets.FabricAdmin.Models.Api20160501.IInfraRole
Notes
COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
INPUTOBJECT <IFabricAdminIdentity>: Identity Parameter
[Drive <String>]: Name of the storage drive.[EdgeGateway <String>]: Name of the edge gateway.[EdgeGatewayPool <String>]: Name of the edge gateway pool.[FabricLocation <String>]: Fabric location.[FileShare <String>]: Fabric file share name.[IPPool <String>]: IP pool name.[Id <String>]: Resource identity path[InfraRole <String>]: Infrastructure role name.[InfraRoleInstance <String>]: Name of an infrastructure role instance.[Location <String>]: Location of the resource.[LogicalNetwork <String>]: Name of the logical network.[LogicalSubnet <String>]: Name of the logical subnet.[MacAddressPool <String>]: Name of the MAC address pool.[Operation <String>]: Operation identifier.[ResourceGroupName <String>]: Name of the resource group.[ScaleUnit <String>]: Name of the scale units.[ScaleUnitNode <String>]: Name of the scale unit node.[SlbMuxInstance <String>]: Name of a SLB MUX instance.[StoragePool <String>]: Storage pool name.[StorageSubSystem <String>]: Name of the storage system.[SubscriptionId <String>]: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.[Volume <String>]: Name of the storage volume.