次の方法で共有

Get-AzureRole

  • リファレンス
モジュール:
Azure

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

Note

このドキュメントで参照されているコマンドレットは、Azure Service Manager (ASM) API を使用するレガシ Azure リソースを管理するためのものです。 ASM の廃止が予定されているため、新しいリソースを作成する場合、このレガシ PowerShell モジュールは推奨されません。 詳細については、「Azure Service Manager の廃止」を参照してください。

Az PowerShell モジュールは、PowerShell を使用して Azure Resource Manager (ARM) リソースを管理するための推奨される 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
  • 阻止
  • [中断]
型:ActionPreference
Aliases:infa
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-InformationVariable

情報変数を指定します。

型:String
Aliases:iv
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-InstanceDetails

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

型:SwitchParameter
配置:3
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Profile

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

型:AzureSMProfile
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-RoleName

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

型:String
配置:2
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ServiceName

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

型:String
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Slot

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

型:String
配置:1
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False