Set-AzureServiceRemoteDesktopExtension

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

展開されたサービスまたはデプロイ時に、指定されたロールまたはすべてのロールでリモート デスクトップ拡張機能を有効にします。

Note

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

Az PowerShell モジュールは、PowerShell を使用して Azure Resource Manager (ARM) リソースを管理するために推奨される PowerShell モジュールです。

重要

現在、Cloud Services (クラシック) は新しいお客様に対して非推奨となっており、2024 年 8 月 31 日に、すべてのお客様に対して廃止される予定です。 新しいデプロイでは、新しい Azure Resource Manager ベースのデプロイ モデル、 Azure Cloud Services (延長サポート) を使用してください。

構文

Set-AzureServiceRemoteDesktopExtension
   [[-ServiceName] <String>]
   [[-Slot] <String>]
   [[-Role] <String[]>]
   [[-X509Certificate] <X509Certificate2>]
   [[-ThumbprintAlgorithm] <String>]
   [-Credential] <PSCredential>
   [[-Expiration] <DateTime>]
   [[-Version] <String>]
   [[-ExtensionId] <String>]
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]
Set-AzureServiceRemoteDesktopExtension
   [[-ServiceName] <String>]
   [[-Slot] <String>]
   [[-Role] <String[]>]
   [-CertificateThumbprint] <String>
   [[-ThumbprintAlgorithm] <String>]
   [-Credential] <PSCredential>
   [[-Expiration] <DateTime>]
   [[-Version] <String>]
   [[-ExtensionId] <String>]
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

説明

Set-AzureServiceRemoteDesktopExtension コマンドレットを使用すると、デプロイされたサービスまたはデプロイ時に、指定されたロールまたはすべてのロールでリモート デスクトップ拡張機能が有効になります。

例

例 1: リモート デスクトップ拡張機能を有効にする

PS C:\> Set-AzureServiceRemoteDesktopExtension -ServiceName $svc -Credentials $creds

このコマンドにより、指定されたサービスのリモート デスクトップ拡張機能が有効になります。

例 2: 指定したロールに対してリモート デスクトップ拡張機能を有効にする

PS C:\> Set-AzureServiceRemoteDesktopExtension -ServiceName $svc -Credentials $creds -Role "WebRole1"

このコマンドにより、指定されたサービスとロールのリモート デスクトップ拡張機能が有効になります。

パラメーター

-CertificateThumbprint

プライベート構成の暗号化に使用する証明書の拇印を指定します。 この証明書は、証明書ストアに既に存在している必要があります。 証明書を指定しない場合、このコマンドレットは証明書を作成します。

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

-Credential

リモート デスクトップで有効にする資格情報を指定します。 資格情報には、ユーザー名とパスワードが含まれます。

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

-Expiration

ユーザー アカウントの有効期限を指定できる日時オブジェクトを指定します。

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

-ExtensionId

拡張 ID を指定します。

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

-InformationAction

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

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

  • 続行
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • [中断]
型:ActionPreference
Aliases:infa
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-InformationVariable

情報変数を指定します。

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

-Profile

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

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

-Role

リモート デスクトップ構成を指定するロールの配列を省略可能に指定します。 このパラメーターを指定しない場合、リモート デスクトップ構成はすべてのロールの既定の構成として適用されます。

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

-ServiceName

デプロイの Azure サービス名を指定します。

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

-Slot

変更するデプロイの環境を指定します。 このパラメーターに使用できる値は、Production、Staging です。

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

-ThumbprintAlgorithm

拇印を使用して証明書を識別する拇印ハッシュ アルゴリズムを指定します。 このパラメーターは省略可能で、既定値は sha1 です。

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

-Version

拡張機能のバージョンを指定します。

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

-X509Certificate

クラウド サービスに自動的にアップロードされ、拡張機能のプライベート構成の暗号化に使用される x509 証明書を指定します。

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