Set-AzAppServicePlan

Azure App Serviceプランを設定します。

構文

S1

Set-AzAppServicePlan
    [[-AdminSiteName] <String>]
    [[-Tier] <String>]
    [[-NumberofWorkers] <Int32>]
    [[-WorkerSize] <String>]
    [-ResourceGroupName] <String>
    [-Name] <String>
    [-PerSiteScaling <Boolean>]
    [-AsyncScalingEnabled <Boolean>]
    [-AsJob]
    [-Tag <Hashtable>]
    [-AssignIdentity <Boolean>]
    [-UserAssignedIdentityId <String[]>]
    [-DefaultIdentity <String>]
    [-RdpEnabled <Boolean>]
    [-VirtualNetworkSubnetId <String>]
    [-InstallScript <InstallScript[]>]
    [-StorageMount <StorageMount[]>]
    [-RegistryAdapter <RegistryAdapter[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [-AcquirePolicyToken]
    [-ChangeReference <String>]
    [<CommonParameters>]

S2

Set-AzAppServicePlan
    [-AppServicePlan] <PSAppServicePlan>
    [-AsyncScalingEnabled <Boolean>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-AssignIdentity <Boolean>]
    [-UserAssignedIdentityId <String[]>]
    [-DefaultIdentity <String>]
    [-RdpEnabled <Boolean>]
    [-VirtualNetworkSubnetId <String>]
    [-InstallScript <InstallScript[]>]
    [-StorageMount <StorageMount[]>]
    [-RegistryAdapter <RegistryAdapter[]>]
    [-AcquirePolicyToken]
    [-ChangeReference <String>]
    [<CommonParameters>]

説明

Set-AzAppServicePlan コマンドレットは、Azure App Serviceプランを設定します。

-AsyncScalingEnabled $trueを使用すると、同期的にスケーリングするワーカーが不足している場合は非同期スケーリングが可能になります。無効にするには -AsyncScalingEnabled $false。 この設定には、専用の App Service プランが必要です。 パイプラインを通じてプランを渡す場合を含め、既存の設定を保持するには、パラメーターを省略します。 このコマンドレットは、操作が完了するまで待機します。バックグラウンド実行には -AsJob を使用します。

Managed Instanceプランの場合、このコマンドレットでは、マネージド ID、インストール スクリプト、ストレージ マウント、レジストリ アダプター、プラン レベルの仮想ネットワーク統合、リモート デスクトップ プロトコル (RDP) アクセスも構成します。 コマンドから省略された設定は保持されます。 コレクション パラメーターは、対応するコレクション全体を置き換えます。空の配列を渡してすべてのエントリを削除します。 1 つのエントリを追加または削除するには、既存のプランを取得し、更新されたコレクションを渡します。

例

例 1: App Service プランを変更する

Set-AzAppServicePlan -ResourceGroupName "Default-Web-WestUS" -Name "ContosoASP" -PerSiteScaling $true

このコマンドは、Default-Web-WestUS という名前のリソース グループに属する ContosoASP という名前の App Service プランで PerSiteScaling オプションを true に設定します。

例 2

Azure App Serviceプランを設定します。 (autogenerated)

Set-AzAppServicePlan -Name 'ContosoASP' -ResourceGroupName 'Default-Web-WestUS' -Tier Free -WorkerSize Small

例 3: App Service プランをメモリ最適化 Isolated v4 SKU に変更する

Set-AzAppServicePlan -ResourceGroupName "Default-Web-WestUS" -Name "ContosoASP" -Tier "IsolatedMV4" -WorkerSize "ExtraExtraLarge"

このコマンドは、App Service Environmentの App Service プランを I5MV4 メモリ最適化 SKU に変更します。

例 4: マネージド ID を更新し、RDP を無効にする

$identityId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ContosoRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ContosoIdentity"
Set-AzAppServicePlan -ResourceGroupName "ContosoRG" -Name "ContosoManagedPlan" -UserAssignedIdentityId $identityId -DefaultIdentity $identityId -RdpEnabled $false

このコマンドは、ユーザー割り当て ID リストを置き換え、その ID をプラン統合用に選択し、RDP を無効にします。 システム割り当て ID とその他の設定は、パラメーターが指定されていないため保持されます。

例 5: 他のスクリプトを削除せずに 1 つのインストール スクリプトを削除する

$plan = Get-AzAppServicePlan -ResourceGroupName "ContosoRG" -Name "ContosoManagedPlan"
$scripts = @($plan.InstallScripts | Where-Object { $_.Name -ne "setup" })
Set-AzAppServicePlan -ResourceGroupName "ContosoRG" -Name "ContosoManagedPlan" -InstallScript $scripts

このコマンドは、セットアップ スクリプトを削除し、他のスクリプトを既存の順序で保持します。 セットアップが最後のスクリプトの場合、空の配列を渡すとスクリプト コレクションがクリアされます。 スクリプトを追加するには、既存のコレクションを新しいスクリプト オブジェクトと共に渡します。

例 6: パイプライン入力を使用してManaged Instance構成をクリアする

Get-AzAppServicePlan -ResourceGroupName "ContosoRG" -Name "ContosoManagedPlan" |
    Set-AzAppServicePlan -InstallScript @() -StorageMount @() -RegistryAdapter @() -VirtualNetworkSubnetId "" -DefaultIdentity "" -AssignIdentity $false -UserAssignedIdentityId @()

このコマンドは、すべてのスクリプト、マウント、レジストリ アダプター、仮想ネットワーク統合、およびマネージド ID をプランから削除します。 既定の ID もクリアされます。 その他のプロパティ (プランがManaged Instanceプランかどうかなど) は保持されます。

例 7: ワーカー数を増やしながら非同期スケーリングを有効にする

Set-AzAppServicePlan -ResourceGroupName "ContosoRG" -Name "ContosoASP" -NumberofWorkers 10 -AsyncScalingEnabled $true

このコマンドにより、既存の専用 App Service プランで非同期スケーリングが有効になり、10 人のワーカーが要求されます。 同期的にスケーリングするワーカーが不足している場合、サービスは非同期的にスケーリングされ、コマンドレットは完了を待機します。

パラメーター

-AcquirePolicyToken

このリソース操作のAzure Policy トークンを自動的に取得します。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-AdminSiteName

管理サイト名

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

S1
配置:2
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-AppServicePlan

App Service プラン オブジェクト

パラメーターのプロパティ

型:PSAppServicePlan
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

S2
配置:0
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-AsJob

バックグラウンドでコマンドレットを実行する

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-AssignIdentity

プランのシステム割り当てマネージド ID を有効または無効にします。 現在のシステム割り当て ID を保持するには、このパラメーターを省略します。 UserAssignedIdentityId も指定されていない限り、ユーザー割り当て ID は保持されます。

パラメーターのプロパティ

型:Boolean
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-AsyncScalingEnabled

専用 App Service プランの非同期スケーリングを有効または無効にします。 同期的にスケーリングするワーカーが不十分な場合は非同期操作を許可する場合は true、同期スケーリングのみを許可する場合は false に設定します。 現在の設定を保持するには、このパラメーターを省略します。 このパラメーターは、パイプラインを通じて渡されたプランの設定をオーバーライドすることもでき、 -AsJob には依存しません。

パラメーターのプロパティ

型:

Nullable<T>[Boolean]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ChangeReference

このリソース操作の変更参照リソース ID。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-DefaultIdentity

プラン統合に既定で使用される ID。 システム割り当て ID の [system] 、またはプランに関連付けられているユーザー割り当て ID のリソース ID を指定します。 空の文字列を渡して既定値をクリアします。既定値として以前に選択した ID を削除する場合も含まれます。 現在の既定値を保持するには、パラメーターを省略します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

パラメーターのプロパティ

型:IAzureContextContainer
規定値:None
ワイルドカードのサポート:False
DontShow:False
エイリアス:AzContext, AzureRmContext, AzureCredential

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-InstallScript

Managed Instance プランの完全なインストール スクリプト コレクション。 各オブジェクトは、名前と SourceUri と Type を含む Source (RemoteAzureBlob や PlatformStorage など) を指定します。 空の配列を渡してすべてのスクリプトを削除します。既存のスクリプトを保持するには、パラメーターを省略します。

パラメーターのプロパティ

型:

InstallScript[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Name

App Service プラン名

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

S1
配置:1
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-NumberofWorkers

ワーカーの数

パラメーターのプロパティ

型:Int32
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

S1
配置:4
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-PerSiteScaling

サイトごとのスケーリングブール値

パラメーターのプロパティ

型:Boolean
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

S1
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-RdpEnabled

Managed Instance プランへの リモート デスクトップ プロトコル (RDP) アクセスを有効または無効にします。 アクセスを無効にするには false を渡します。現在の設定を保持するには、パラメーターを省略します。 GET-AzAppServicePlanRdpCredential を使用して、RDP が有効になっているときに資格情報を取得します。

パラメーターのプロパティ

型:Boolean
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-RegistryAdapter

Managed Instance プランの完全なレジストリ アダプター コレクション。 各オブジェクトは、RegistryKey、Type、KeyVaultSecretReference.SecretUri を指定します。 サポートされている型は、Binary、String、Expand_String、Multi_String、DWord、QWord です。 空の配列を渡してすべてのアダプターを削除します。既存のアダプターを保持するには、パラメーターを省略します。

パラメーターのプロパティ

型:

RegistryAdapter[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ResourceGroupName

リソース グループ名

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

S1
配置:0
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-StorageMount

Managed Instance プランの完全なストレージ マウント コレクション。 各オブジェクトは、Name、Type、DestinationPath を指定します。 AzureFiles マウントと FileShare マウントにはソースも必要であり、CredentialsKeyVaultReference.SecretUri を使用して資格情報を参照できます。 LocalStorage マウントにはソースは必要ありません。 空の配列を渡してすべてのマウントを削除します。既存のマウントを保持するには、パラメーターを省略します。

パラメーターのプロパティ

型:

StorageMount[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Tag

タグは、リソースを分類できる名前と値のペアです

パラメーターのプロパティ

型:Hashtable
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

S1
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Tier

App Service プランレベル。 App Service Environmentでは、I1V4 から I6V4 プランの IsolatedV4、I1MV4 から I5MV4 のメモリ最適化プランの IsolatedMV4 を使用します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

S1
配置:3
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-UserAssignedIdentityId

プランに関連付けるユーザー割り当てマネージド ID リソース ID の完全な一覧。 空の配列を渡して、すべてのユーザー割り当て ID を削除します。現在のリストを保持するには、パラメーターを省略します。 -AssignIdentity も指定されていない限り、システム割り当て ID は保持されます。

パラメーターのプロパティ

型:

String[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-VirtualNetworkSubnetId

Microsoftへの委任を含む、App Service 統合用に構成された既存のサブネットの完全なリソース ID。Web/serverFarms。 空の文字列を渡して、そのサブネットからプランを切断します。現在の統合を保持するには、パラメーターを省略します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-WorkerSize

割り当てるワーカーのサイズ。 IsolatedV4 の場合、Small から ExtraExtraExtraLarge は I1V4 から I6V4 を選択します。 IsolatedMV4 の場合、Small から ExtraExtraLarge は I1MV4 から I5MV4 を選択します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

S1
配置:5
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

CommonParameters

このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、about_CommonParametersを参照してください。

入力

PSAppServicePlan

出力

PSAppServicePlan