次の方法で共有

Az 1.0.0 の破壊的変更

  • [アーティクル]

このドキュメントでは、AzureRM 6.x と新しい Az モジュールバージョン 1.x 以降の間の変更について詳しく説明します。 目次は、スクリプトに影響を与える可能性があるモジュール固有の変更を含む、完全な移行パスのガイドに役立ちます。

AzureRM から Az への移行の概要に関する一般的なアドバイスについては、「AzureRM から Azへの移行を開始する」を参照してください。

重要

Az 1.0.0 と Az 2.0.0 の間でも破壊的変更が行われています。 このガイドに従って AzureRM から Az に更新した後、Az 2.0.0 の破壊的変更 を参照して、追加の変更を行う必要があるかどうかを確認してください。

目次

重大な変更 - 全般

このセクションでは、Az モジュールの再設計の一部である一般的な破壊的変更について詳しく説明します。

コマンドレット名詞プレフィックスの変更

AzureRM モジュールでは、コマンドレットは名詞プレフィックスとして AzureRM または Azure を使用します。 Az ではコマンドレット名が簡略化され、正規化されるため、すべてのコマンドレットでコマンドレット名詞プレフィックスとして 'Az' が使用されます。 例えば：

Get-AzureRMVM
Get-AzureKeyVaultSecret

次の内容に変更されました。

Get-AzVM
Get-AzKeyVaultSecret

これらの新しいコマンドレット名への移行を簡単にするために、Az では、Enable-AzureRmAlias と Disable-AzureRmAlias2 つの新しいコマンドレットが導入されています。 Enable-AzureRmAlias は、新しい Az コマンドレット名にマップされる古いコマンドレット名のエイリアスを AzureRM に作成します。 -Scope 引数を Enable-AzureRmAlias で使用することで、エイリアスを有効にする場所を選択することができます。

たとえば、AzureRM の次のスクリプトです。

#Requires -Modules AzureRM.Storage
Get-AzureRmStorageAccount | Get-AzureStorageContainer | Get-AzureStorageBlob

Enable-AzureRmAliasを使用して、最小限の変更で実行できます。

#Requires -Modules Az.Storage
Enable-AzureRmAlias -Scope Process
Get-AzureRmStorageAccount | Get-AzureStorageContainer | Get-AzureStorageBlob

Enable-AzureRmAlias -Scope CurrentUser を実行すると、開くすべての PowerShell セッションのエイリアスが有効になるため、このコマンドレットを実行した後、次のようなスクリプトをまったく変更する必要はありません。

Get-AzureRmStorageAccount | Get-AzureStorageContainer | Get-AzureStorageBlob

エイリアス コマンドレットの使用方法の詳細については、Enable-AzureRmAlias リファレンスを参照してください。

エイリアスを無効にする準備ができたら、Disable-AzureRmAlias コマンドを使用して作成されたエイリアスを削除します。 詳細については、Disable-AzureRmAlias リファレンスを参照してください。

重要

エイリアスを無効にする場合は、必ず、エイリアスが有効になっているすべてのスコープに対して無効にしてください。

モジュール名の変更

次のモジュールを除き、モジュール名が AzureRM.* から Az.*に変更されました。

AzureRM モジュール Az モジュール
Azure.Storage Az.Storage
Azure.AnalysisServices Az.AnalysisServices
AzureRM.Profile Az.Accounts
AzureRM.Insights Az.Monitor
AzureRM.DataFactories Az.DataFactory
AzureRM.DataFactoryV2 Az.DataFactory
AzureRM.RecoveryServices.Backup Az.RecoveryServices
AzureRM.RecoveryServices.SiteRecovery Az.RecoveryServices
AzureRM.Tags Az.Resources
AzureRM.MachineLearningCompute Az.MachineLearning
AzureRM.UsageAggregates Az.Billing
AzureRM.Consumption Az.Billing

モジュール名の変更は、#Requires または Import-Module を使用して特定のモジュールを読み込むスクリプトを、代わりに新しいモジュールを使用するように変更する必要があることを意味します。 コマンドレットサフィックスが変更されていないモジュールの場合、これはモジュール名が変更されたが、操作領域を示すサフィックス ないことを意味します。

#Requires ステートメントと Import-Module ステートメントの移行作業

#Requires または Import-Module を使用して AzureRM モジュールへの依存関係を宣言するスクリプトは、新しいモジュール名を使用するように更新する必要があります。 例えば：

#Requires -Module AzureRM.Compute

次のように変更する必要があります。

#Requires -Module Az.Compute

Import-Moduleの場合:

Import-Module -Name AzureRM.Compute

次のように変更する必要があります。

Import-Module -Name Az.Compute

Fully-Qualified コマンドレット呼び出しの移行

次のようなモジュール修飾コマンドレット呼び出しを使用するスクリプト。

AzureRM.Compute\Get-AzureRmVM

新しいモジュールとコマンドレットの名前を使用するには、次のように変更する必要があります。

Az.Compute\Get-AzVM

モジュール マニフェストの依存関係の移行

モジュール マニフェスト (.psd1) ファイルを介して AzureRM モジュールへの依存関係を表すモジュールは、RequiredModules セクションのモジュール名を更新する必要があります。

RequiredModules = @(@{ModuleName="AzureRM.Profile"; ModuleVersion="5.8.2"})

次のように変更する必要があります。

RequiredModules = @(@{ModuleName="Az.Profile"; ModuleVersion="1.0.0"})

削除されたモジュール

次のモジュールが削除されました。

  • AzureRM.Backup
  • AzureRM.Compute.ManagedService
  • AzureRM.Scheduler

これらのサービスのツールは、アクティブにサポートされなくなりました。 お客様は、便利になったらすぐに代替サービスに移行することをお勧めします。

Windows PowerShell 5.1 および .NET 4.7.2

PowerShell 5.1 for Windows で Az を使用するには、.NET Framework 4.7.2 をインストールする必要があります。 PowerShell Core 6.x 以降を使用する場合、.NET Framework は必要ありません。

PSCredential を使用したユーザー ログインの一時的な削除

.NET Standard の認証フローが変更されたため、PSCredential を使用してユーザー ログインを一時的に削除しています。 この機能は、Windows 用 PowerShell 5.1 の 2019 年 1 月 15 日リリースで再導入される予定です。 これについては、この GitHub の問題 詳しく説明します。

Web ブラウザー プロンプトではなく、既定のデバイス コード ログイン

.NET Standard の認証フローが変更されたため、対話型ログイン時に既定のログイン フローとしてデバイス ログインを使用しています。 2019 年 1 月 15 日リリースでは、Windows 用 PowerShell 5.1 の Web ブラウザー ベースのログインが既定として再導入されます。 その時点で、ユーザーは Switch パラメーターを使用してデバイス ログインを選択できます。

モジュールの破壊的変更

このセクションでは、個々のモジュールとコマンドレットの具体的な破壊的変更について詳しく説明します。

Az.ApiManagement (以前の AzureRM.ApiManagement)

  • 次のコマンドレットを削除しました。
    • New-AzureRmApiManagementHostnameConfiguration
    • Set-AzureRmApiManagementHostnames
    • Update-AzureRmApiManagementDeployment
    • Import-AzureRmApiManagementHostnameCertificate
    • Set-AzApiManagement コマンドレット 使用して、代わりにこれらのプロパティを設定します
  • 次のプロパティを削除しました。
    • PsApiManagementContextからプロパティ PortalHostnameConfiguration、ProxyHostnameConfiguration、ManagementHostnameConfiguration、および型 PsApiManagementHostnameConfiguration の ScmHostnameConfiguration を削除しました。 代わりに、PortalCustomHostnameConfiguration、ProxyCustomHostnameConfiguration、ManagementCustomHostnameConfiguration、および型 PsApiManagementCustomHostNameConfigurationの ScmCustomHostnameConfiguration を使用します。
    • PsApiManagementContext からプロパティ StaticIPs を削除しました。 プロパティは、PublicIPAddresses と PrivateIPAddressesに分割されています。
    • コマンドレットから必要なプロパティ Location New-AzureApiManagementVirtualNetwork 削除しました。

Az.Billing (以前の AzureRM.Billing、AzureRM.Consumption、AzureRM.UsageAggregates)

  • InvoiceName パラメーターは、Get-AzConsumptionUsageDetail コマンドレットから削除されました。 スクリプトでは、請求書に他の ID パラメーターを使用する必要があります。

Az.CognitiveServices (以前の AzureRM.CognitiveServices)

  • コマンドレット Get-AzCognitiveServicesAccountSkus からパラメーター セット GetSkusWithAccountParamSetName を削除しました。 ResourceGroupName とアカウント名を使用する代わりに、アカウントの種類と場所ごとに SKU を取得する必要があります。

Az.Compute (以前の AzureRM.Compute)

  • IdentityIds は PSVirtualMachineIdentity プロパティから削除され、PSVirtualMachineScaleSet オブジェクトスクリプトはこのフィールドの値を使用して処理を決定する必要がなくなります。
  • PSVirtualMachineScaleSetVM オブジェクトの InstanceView プロパティの型が VirtualMachineInstanceView から VirtualMachineScaleSetVMInstanceView に変更されます
  • AutoOSUpgradePolicyプロパティとAutomaticOSUpgradeプロパティがUpgradePolicyプロパティから削除される
  • オブジェクト内の Sku プロパティの型 PSSnapshotUpdateDiskSku から SnapshotSku に変更されます
  • VmScaleSetVMParameterSet は Add-AzVMDataDisk コマンドレットから削除されたため、ScaleSet VM にデータディスクを個別に追加することはできなくなりました。

Az.DataFactory (以前の AzureRM.DataFactories と AzureRM.DataFactoryV2)

  • New-AzDataFactoryEncryptValue コマンドレットでは、GatewayName パラメーターが必須になりました
  • コマンドレット New-AzDataFactoryGatewayKey 削除しました
  • Get-AzDataFactoryV2ActivityRun コマンドレットからパラメーター LinkedServiceName 削除されました。スクリプトでは、このフィールドの値を使用して処理を決定する必要がなくなりました。

Az.DataLakeAnalytics (以前の AzureRM.DataLakeAnalytics)

  • 非推奨のコマンドレット (New-AzDataLakeAnalyticsCatalogSecret、Remove-AzDataLakeAnalyticsCatalogSecret、および Set-AzDataLakeAnalyticsCatalogSecret を削除しました)

Az.DataLakeStore (以前の AzureRM.DataLakeStore)

  • 次のコマンドレットでは、Encoding パラメーターが型 FileSystemCmdletProviderEncoding から System.Text.Encodingに変更されています。 この変更により、エンコード値 String および Oemが削除されます。 その他の以前のエンコード値はすべて残ります。

    • New-AzureRmDataLakeStoreItem
    • Add-AzureRmDataLakeStoreItemContent
    • Get-AzureRmDataLakeStoreItemContent

  • New-AzDataLakeStoreAccount コマンドレットと Set-AzDataLakeStoreAccount コマンドレットから非推奨の Tags プロパティ エイリアスを削除しました

    次のコマンドレットを使用するスクリプトは

    New-AzureRMDataLakeStoreAccount -Tags @{TagName="TagValue"}

    に変更すべきです。

    New-AzDataLakeStoreAccount -Tag @{TagName="TagValue"}

  • 非推奨のプロパティ Identity、EncryptionState、EncryptionProvisioningState、EncryptionConfig、FirewallState、FirewallRules、VirtualNetworkRules、TrustedIdProviderState、TrustedIdProviders、DefaultGroup、NewTier、CurrentTier、FirewallAllowAzureIpsPSDataLakeStoreAccountBasic オブジェクトから削除されました。 Get-AzDataLakeStoreAccount から返された PSDatalakeStoreAccount を使用するスクリプトでは、これらのプロパティを参照しないでください。

Az.KeyVault (以前の AzureRM.KeyVault)

  • PurgeDisabled プロパティが PSKeyVaultKeyAttributes、PSKeyVaultKeyIdentityItem、および PSKeyVaultSecretAttributes オブジェクトから削除されました。スクリプトは、処理の決定を行うために、PurgeDisabled プロパティを参照しなくなりました。

Az.Media (以前の AzureRM.Media)

  • New-AzMediaService コマンドレットのスクリプトを使用して、非推奨の Tags プロパティエイリアスを削除する。

    New-AzureRMMediaService -Tags @{TagName="TagValue"}

    次のように変更する必要があります。

    New-AzMediaService -Tag @{TagName="TagValue"}

Az.Monitor (以前の AzureRM.Insights)

  • 複数形の名前 Categories と Timegrains パラメーターを削除し、Set-AzDiagnosticSetting コマンドレットスクリプトで単一のパラメーター名を使用するように変更しました。

    Set-AzureRmDiagnosticSetting -Timegrains PT1M -Categories Category1, Category2

    次のように変更する必要があります。

    Set-AzDiagnosticSetting -Timegrain PT1M -Category Category1, Category2

Az.Network (以前の AzureRM.Network)

  • 非推奨の ResourceId パラメーター Get-AzServiceEndpointPolicyDefinition コマンドレットから削除されました
  • 非推奨の EnableVmProtection プロパティ PSVirtualNetwork オブジェクトから削除されました
  • 非推奨の Set-AzVirtualNetworkGatewayVpnClientConfig コマンドレットを削除しました

スクリプトは、これらのフィールドの値に基づいて処理の決定を行うべきではありません。

Az.OperationalInsights (以前の AzureRM.OperationalInsights)

  • Get-AzOperationalInsightsDataSource の既定のパラメーター セットが削除され、ByWorkspaceNameByKind が既定のパラメーター セットになりました

    データソースを一覧表示するために使用されたスクリプト

    Get-AzureRmOperationalInsightsDataSource

    種類 (Kind) を指定するように変更する必要があります。

    Get-AzOperationalInsightsDataSource -Kind AzureActivityLog

Az.RecoveryServices (以前の AzureRM.RecoveryServices、AzureRM.RecoveryServices.Backup、AzureRM.RecoveryServices.SiteRecovery)

  • New/Set-AzRecoveryServicesAsrPolicy コマンドレットからパラメーター Encryption を削除しました
  • TargetStorageAccountName パラメーターは、Restore-AzRecoveryServicesBackupItem コマンドレットでのマネージド ディスクの復元に必須になりました
  • Restore-AzRecoveryServicesBackupItem コマンドレットの StorageAccountName パラメーターと StorageAccountResourceGroupName パラメーターを削除しました
  • Get-AzRecoveryServicesBackupContainer コマンドレット Nameパラメーターを削除しました

Az.Resources (以前の AzureRM.Resources)

  • New/Set-AzPolicyAssignment コマンドレットからパラメーター Sku を削除しました。

  • New-AzADServicePrincipal および New-AzADSpCredential コマンドレットから、Password パラメーターが削除されました。パスワードは自動的に生成されます。次のようにパスワードを指定しているスクリプトは

    New-AzAdSpCredential -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -Password $secPassword

    出力からパスワードを取得するように変更する必要があります。

    $credential = New-AzAdSpCredential -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444
$secPassword = $credential.Secret

Az.ServiceFabric (以前の AzureRM.ServiceFabric)

  • 次のコマンドレットの戻り値の型が変更されました。
    • ApplicationHealthPolicy 型のプロパティ ServiceTypeHealthPolicies が削除されました。
    • ClusterUpgradeDeltaHealthPolicy 型のプロパティ ApplicationHealthPolicies が削除されました。
    • ClusterUpgradePolicy 型のプロパティ OverrideUserUpgradePolicy が削除されました。
    • これらの変更は、次のコマンドレットに影響します。
      • Add-AzServiceFabricClientCertificate
      • Add-AzServiceFabricClusterCertificate
      • Add-AzServiceFabricNode
      • Add-AzServiceFabricNodeType
      • Get-AzServiceFabricCluster
      • Remove-AzServiceFabricClientCertificate
      • Remove-AzServiceFabricClusterCertificate
      • Remove-AzServiceFabricNode
      • Remove-AzServiceFabricNodeType
      • Remove-AzServiceFabricSetting
      • Set-AzServiceFabricSetting
      • Set-AzServiceFabricUpgradeType
      • Update-AzServiceFabricDurability
      • Update-AzServiceFabricReliability

Az.Sql (以前の AzureRM.Sql)

  • Set-AzSqlDatabaseBackupLongTermRetentionPolicy コマンドレットから State パラメーターと ResourceId パラメーターを削除しました
  • 非推奨のコマンドレットを削除しました:Get/Set-AzSqlServerBackupLongTermRetentionVault、Get/Start/Stop-AzSqlServerUpgrade、Get/Set-AzSqlDatabaseAuditingPolicy、Get/Set-AzSqlServerAuditingPolicy、Remove-AzSqlDatabaseAuditing、Remove-AzSqlServerAuditing
  • 非推奨のパラメーター CurrentGet-AzSqlDatabaseBackupLongTermRetentionPolicy コマンドレットから削除されました
  • 非推奨のパラメーター DatabaseNameGet-AzSqlServerServiceObjective コマンドレットから削除されました
  • 非推奨のパラメーター PrivilegedLoginSet-AzSqlDatabaseDataMaskingPolicy コマンドレットから削除されました

Az.Storage (以前の Azure.Storage と AzureRM.Storage)

  • ストレージ アカウント名のみを使用した Oauth ストレージ コンテキストの作成をサポートするために、既定のパラメーター セットが OAuthParameterSet に変更されました
    • 例: $ctx = New-AzureStorageContext -StorageAccountName $accountName
  • Get-AzStorageUsage コマンドレットでは、Location パラメーターが必須になりました
  • Storage API メソッドでは、同期 API 呼び出しではなく、タスクベースの非同期パターン (TAP) が使用されるようになりました。 次の例では、新しい非同期コマンドを示します。

ブロブ スナップショット

AzureRM:

$b = Get-AzureStorageBlob -Container $containerName -Blob $blobName -Context $ctx
$b.ICloudBlob.Snapshot()

Az:

$b = Get-AzStorageBlob -Container $containerName -Blob $blobName -Context $ctx
$task = $b.ICloudBlob.SnapshotAsync()
$task.Wait()
$snapshot = $task.Result

スナップショットの共有

AzureRM:

$Share = Get-AzureStorageShare -Name $containerName -Context $ctx
$snapshot = $Share.Snapshot()

Az:

$Share = Get-AzStorageShare -Name $containerName -Context $ctx
$task = $Share.SnapshotAsync()
$task.Wait()
$snapshot = $task.Result

論理的に削除された BLOB の削除の取り消し

AzureRM:

$b = Get-AzureStorageBlob -Container $containerName -Blob $blobName -IncludeDeleted -Context $ctx
$b.ICloudBlob.Undelete()

Az:

$b = Get-AzStorageBlob -Container $containerName -Blob $blobName -IncludeDeleted -Context $ctx
$task = $b.ICloudBlob.UndeleteAsync()
$task.Wait()

BLOB 層の設定

AzureRM:

$blockBlob = Get-AzureStorageBlob -Container $containerName -Blob $blockBlobName -Context $ctx
$blockBlob.ICloudBlob.SetStandardBlobTier("hot")

$pageBlob = Get-AzureStorageBlob -Container $containerName -Blob $pageBlobName -Context $ctx
$pageBlob.ICloudBlob.SetPremiumBlobTier("P4")

Az:

$blockBlob = Get-AzStorageBlob -Container $containerName -Blob $blockBlobName -Context $ctx
$task = $blockBlob.ICloudBlob.SetStandardBlobTierAsync("hot")
$task.Wait()

$pageBlob = Get-AzStorageBlob -Container $containerName -Blob $pageBlobName -Context $ctx
$task = $pageBlob.ICloudBlob.SetPremiumBlobTierAsync("P4")
$task.Wait()

Az.Websites (以前の AzureRM.Websites)

  • PSAppServicePlan、PSCertificate、PSCloningInfo、および PSSite オブジェクトから非推奨のプロパティを削除しました