Get-AzureRole

リファレンス

モジュール:: Azure

Microsoft Azure サービスのロールの一覧を返します。

注意

このドキュメントで参照されているコマンドレットは、Service Management API を使用するレガシ Azure リソースを管理するためのものです。 Azure Resource Manager リソースを管理するためのコマンドレットについては、Az PowerShell モジュールを参照してください。

構文

Get-AzureRole
   [-ServiceName] <String>
   [[-Slot] <String>]
   [[-RoleName] <String>]
   [-InstanceDetails]
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

説明

Get-AzureRole コマンドレットは、Microsoft Azure サービスのロールの詳細を含むリストオブジェクトを返します。 RoleName パラメーターを指定すると、Get-AzureRole はそのロールについてのみ詳細を返します。 InstanceDetails パラメーターを指定すると、インスタンス固有の詳細が追加で返されます。

例

例 1: サービスのロールの一覧を取得する

PS C:\> Get-AzureRole -ServiceName "MySvc01" -Slot "Production"

このコマンドは、MySvc01 サービスで実行されているすべての実稼働ロールの詳細を含むオブジェクトを返します。

例 2: サービスで実行されているロールの詳細を取得する

PS C:\> Get-AzureRole -ServiceName "MySvc1" -Slot "Staging" -RoleName "MyTestVM3"

このコマンドは、MySvc01 サービスのステージング環境で実行されている MyTestVM3 ロールの詳細を含むオブジェクトを返します。

例 3: サービスで実行されているロールのインスタンスに関するインスタンス情報を取得する

PS C:\> Get-AzureRole -ServiceName "MySvc01" -Slot "Production" -RoleName "MyTestVM02" -InstanceDetails

このコマンドは、MySvc01 サービスの運用環境で実行されている MyTestVM02 ロールのインスタンスの詳細を含むオブジェクトを返します。

例 4: サービスに関連付けられているロールインスタンスのテーブルを取得する

PS C:\> Get-AzureRole -ServiceName "MySvc01" -Slot "Production" -InstanceDetails | Format-Table -Auto "InstanceName", "InstanceSize", "InstanceStatus"

このコマンドは、MySvc01 サービスの運用環境で実行されているすべてのロールインスタンスのインスタンス名、サイズ、および状態のテーブルを返します。

パラメーター

-InformationAction

このコマンドレットが情報イベントに応答する方法を指定します。

このパラメーターの有効値は、次のとおりです。

続行
Ignore
Inquire
SilentlyContinue
Stop
Suspend

Type:	ActionPreference
Aliases:	infa
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InformationVariable

情報変数を指定します。

Type:	String
Aliases:	iv
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InstanceDetails

このコマンドレットが各ロールのインスタンスに関する詳細を返すように指定します。

Type:	SwitchParameter
Position:	3
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Profile

このコマンドレットが読み取る Azure プロファイルを指定します。プロファイルを指定しない場合、このコマンドレットはローカルの既定のプロファイルから読み取ります。

Type:	AzureSMProfile
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RoleName

取得するロールの名前を指定します。

Type:	String
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ServiceName

Azure サービスの名前を指定します。

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Slot

Azure デプロイ環境を指定します。このパラメーターに使用できる値は、運用またはステージングです。

Type:	String
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

Set-AzureRole