Get-MailboxPlan
このコマンドレットは、クラウドベースのサービスでのみ使用できます。
Get-MailboxPlan コマンドレットを使用して、クラウドベースのサービスのメールボックス プランに関する情報を表示します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Get-MailboxPlan
[[-Identity] <MailboxPlanIdParameter>]
[-AllMailboxPlanReleases]
[-Credential <PSCredential>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[<CommonParameters>]
説明
メールボックス プランは、メールボックスのプロパティを自動的に構成するテンプレートです。 メールボックス プランはライセンスの種類に対応しており、ユーザーにライセンスを付与するときに適用されます。 メールボックス プランの可用性は、サービスに登録するときの選択内容と組織の年齢によって決まります。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Get-MailboxPlan
この例では、組織内のすべてのメールボックス プランの要約リストを返します。
例 2
Get-MailboxPlan -Identity ExchangeOnlineEnterprise | Format-List
この例は、ExchangeOnlineEnterprise という表示名を持つ、メールボックス プランの詳しい情報を返します。
パラメーター
-AllMailboxPlanReleases
AllMailboxPlanReleases スイッチは、以前のバージョンのサービスで使用されていたメールボックス プランを結果に含めるかどうかを指定します。 このスイッチで値を指定する必要はありません。
このスイッチを使用しない場合、コマンドは、現在のバージョンのサービスで使用されているメールボックス プランのみを返します。 このパラメーターは、以前のバージョンのサービスに登録された組織にのみ意味があります。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-Credential
Credential パラメーターは、このコマンドの実行に使用されるユーザー名とパスワードを指定します。 通常、このパラメーターはスクリプトや、必要なアクセス許可を持つ別の資格情報を入力する必要がある場合に使用します。
このパラメーターの値には、Get-Credential コマンドレットが必要です。 このコマンドを一時停止し、資格情報の入力を求めるメッセージを表示するには、値(Get-Credential)
を使用します。 または、このコマンドを実行する前に、資格情報を変数 (たとえば、$cred = Get-Credential
) に保存し、このパラメーターに変数名 ($cred
) を使用します。 詳細については、Get-Credentialに関するページをご覧ください。
Type: | PSCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-Filter
Filter パラメーターは、OPATH 構文を使用して、指定したプロパティと値で結果をフィルター処理します。 検索条件は構文"Property -ComparisonOperator 'Value'"
を使用します。
- OPATH フィルター全体を二重引用符 " " で囲みます。 フィルターにシステム値 (例えば、
$true
、$false
、または$null
) が含まれている場合は、代わりに単一引用符 ' ' を使用します。 このパラメーターは文字列 (システム ブロックではありません) ですが、波かっこ { } を使用することもできますが、これはフィルターに変数が含まれていない場合のみです。 - Property はフィルタリング可能なプロパティです。 Exchange サーバーとExchange Onlineのフィルター可能なプロパティの詳細については、「Filter パラメーターのフィルター可能なプロパティ」を参照してください。
- ComparisonOperator は OPATH 比較演算子です (たとえば
-eq
、等しい場合や-like
文字列比較の場合)。 比較演算子の詳細については、「about_Comparison_Operators」を参照してください。 - Value は、検索するプロパティ値です。 テキスト値と変数を一重引用符 (
'Value'
または'$Variable'
) で囲みます。 変数値に一重引用符が含まれている場合、変数を正しく展開するには、一重引用符を識別する (エスケープする) 必要があります。 たとえば、'$User'
の代わりに'$($User -Replace "'","''")'
を使用します。 整数またはシステム値を引用符で囲まないでください (代わりに、500
、$true
、$false
など$null
)。
論理演算子 -and
および -or
を使用すると、複数の検索条件を連結することができます。 たとえば、"Criteria1 -and Criteria2"
または "(Criteria1 -and Criteria2) -or Criteria3"
です。
Exchange の OPATH フィルターの詳細については、「 その他の OPATH 構文情報」を参照してください。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-Identity
Identity パラメーターは、表示するメールボックス プランを指定します。 メールボックス プランを一意に識別する任意の値を使用することができます。 次に例を示します。
- 名前
- Alias
- 表示名
- 識別名 (DN)
- GUID
Type: | MailboxPlanIdParameter |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-IgnoreDefaultScope
このパラメーターは、Microsoft の内部使用のために予約されています。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-ResultSize
ResultSize パラメーターは、返される結果の最大数を指定します。 クエリに一致するすべてのリクエストを返す場合は、このパラメーターの値に unlimited を使用します。 既定値は 1,000 です。
Type: | Unlimited |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-SortBy
SortBy パラメーターは、結果を並べ替えるためのプロパティを指定します。 並べ替えの基準にできるのは、一度に 1 つのプロパティのみです。 結果は昇順で並べ替えられます。
既定のビューに並べ替えるプロパティが含まれていない場合は、 コマンドを で | Format-Table -Auto Property1,Property2,...PropertyX
追加できます。 をクリックして、表示するすべてのプロパティを含む新しいビューを作成します。 プロパティ名にはワイルドカード (*) がサポートされています。
次の属性で並べ替えることができます。
- エイリアス
- DisplayName
- 名前
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
入力
Input types
このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。
出力
Output types
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。