ユニバーサルプリント PowerShell モジュール

[アーティクル]
12/15/2023

UniversalPrintManagement PowerShell モジュールは、コマンドラインからユニバーサルプリントリソースを使用および管理するために設計されています。自動ツールを構築したい場合は、このモジュールを使用します。

この記事は、UniversalPrintManagement モジュールの使用を開始するのに役立ち、その背後にある主要な概念を説明します。

UniversalPrintManagement のインストール

PowerShell セッションから次のコマンドを実行します。

Install-Module UniversalPrintManagement

既定では、PowerShell ギャラリーは、PowerShellGet の信頼できるリポジトリとしては構成されません。 PSGallery の初回使用時には、次のプロンプトが表示されます。

Untrusted repository

You are installing the modules from an untrusted repository. If you trust this repository, change
its InstallationPolicy value by running the `Set-PSRepository` cmdlet.

Are you sure you want to install the modules from 'PSGallery'?
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "N"):

インストールを続行するには、Yes または Yes to All を選択します。

Note

オフラインシナリオでの PSGallery モジュールのインストールの追加情報については、PowerShell ギャラリーを参照してください。

UniversalPrintManagement のアンインストール

PowerShell セッションから次のコマンドを実行します。

Uninstall-Module -Name UniversalPrintManagement

Connect-UPService コマンドレットを使って対話形式でサインインします。

Connect-UPService

サインインダイアログが表示され、Azure アカウントのユーザー名とパスワードを提供するか、以前に保存したアカウントのいずれかを選択できます。

Note

このコマンドレットの主な目的は、自動スクリプトの非対話型サインインを許可することです。これは、たとえば、Connect-UPService -UserPrincipalName username@tenantname.com -Password $variableHoldingSecureString 構文を使用して、セキュリティで保護されたストレージからパスワードを取得することで行うことができます。

サインインしたら、モジュールで使用可能なコマンドレットを使用して、プリンターリソースにアクセスして管理します。

UniversalPrintManagement コマンドレット

UniversalPrintManagement コマンドレットは、PowerShellの標準の名前付け規則、VERB-NOUN に従います。動詞はアクションを説明し (例: Get、Set、Grant、Revoke を含む)、名詞はリソースの種類(例: UPPrinter、UPPrintJob、UPAccess を含む)を説明します。 UniversalPrintManagement の名詞は、常に接頭辞 UP で始まります。

名詞、動詞を知ることは、Get-Command コマンドレットを使ったコマンドを見つけ出すのに役立ちます。たとえば、Get 動詞を使用したコマンドを見つけるには：

Get-Command -Verb Get -Module UniversalPrintManagement

例を使用してコマンドレットの詳細を取得するには：

Get-Help Get-UPPrinter -Detailed

[注] UniversalPrintManagement Get コマンドレットは現在、後続トークンを使用して結果を返し、大規模なコレクションを通してページングし、失敗した要求を再処理できるようになります。後続トークンを使用する方法について説明します。後続トークンに対応するために必要なモデルの変更により、Get コマンドレットの結果を変数に格納し、.results を介してそれらにアクセスすることをお勧めします。こちらの例を参照してください。

コマンドレット	説明
Connect-UPService	ユニバーサルプリントコマンドレット要求に使用する認証済みアカウントに接続します。

プリンター

コマンドレット	説明
Get-UPPrinter	このコマンドレットを使用して、プリンターの 1 つまたは一覧に関する情報を取得します。
Remove-UPPrinter	プリンターの登録を解除するには、このコマンドレットを使用します。

プリンターのプロパティ

コマンドレット	説明
Set-UPPrinterProperty	プリンターの変更可能なプロパティを更新するには、このコマンドレットを使用します。

プリンターの共有

コマンドレット	説明
New-UPPrinterShare	プリンターを共有するには、このコマンドレットを使用します。
Get-UPPrinterShare	このコマンドレットを使用して、共有プリンターの 1 つまたは一覧に関する情報を取得します。
Remove-UPPrinterShare	このコマンドレットを使用して、以前に共有されているプリンターの共有を解除します。
Set-UPPrinterShare	このコマンドレットを使用して、稼働中のプリンターとの維持管理に向けて登録済みのプリンターを交換するために、プリンター共有を更新します。

ユーザーのアクセス許可

コマンドレット	説明
Grant-UPAccess	このコマンドレットを使用して、ユーザーまたはグループ、または組織内のすべてのユーザーに印刷アクセス権を付与します。
Revoke-UPAccess	このコマンドレットを使用して、ユーザーまたはグループ、または組織内のすべてのユーザーからの印刷アクセス権を取り消します。
Get-UPAllowedMember	このコマンドレットを使用して、特定のプリンターへの印刷アクセス権を持つユーザーとグループに関する情報を取得します。

コネクタ

コマンドレット	説明
Get-UPConnector	このコマンドレットを使用して、コネクタの 1 つまたは一覧に関する情報を取得します。
Remove-UPConnector	コネクタの登録を解除するには、このコマンドレットを使用します。

コネクタのプロパティ

コマンドレット	説明
Set-UPConnectorProperty	コネクタの変更可能なプロパティを更新するには、このコマンドレットを使用します。

印刷ジョブ

コマンドレット	説明
Get-UPPrintJob	このコマンドレットを使用して、プリンターに送信された印刷ジョブに関する情報を取得します。

印刷ジョブの報告

コマンドレット	説明
Get-UPUsageReport	このコマンドレットを使用して、さまざまな種類の印刷使用状況レポートを取得します。

ユニバーサル プリント PowerShell モジュール