Export-AzTerraform
指定したリソースの Terraform 構成をエクスポートします。
構文
Export-AzTerraform
[-SubscriptionId <String>]
-ExportParameter <IBaseExportModel>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Export-AzTerraform
[-SubscriptionId <String>]
-JsonFilePath <String>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Export-AzTerraform
[-SubscriptionId <String>]
-JsonString <String>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
指定したリソースの Terraform 構成をエクスポートします。
例
例 1: リソース ID によるリソースのエクスポート
Export-AzTerraform -ExportParameter $(New-AzTerraformExportResourceObject -ResourceId "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/aztfy-pwsh-test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet")
AdditionalInfo :
Code :
Configuration : terraform {
required_providers {
azurerm = {
source = "azurerm"
version = "4.0.1"
}
}
}
provider "azurerm" {
features {}
}
resource "azurerm_virtual_network" "res-0" {
address_space = ["10.0.0.0/16"]
bgp_community = ""
dns_servers = []
edge_zone = ""
flow_timeout_in_minutes = 0
___location = "westus3"
name = "test-vnet"
resource_group_name = "aztfy-pwsh-test-rg"
subnet = [{
address_prefixes = ["10.0.0.0/24"]
default_outbound_access_enabled = false
delegation = []
id = "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/aztfy-p
wsh-test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"
name = "default"
private_endpoint_network_policies = "Disabled"
private_link_service_network_policies_enabled = true
route_table_id = ""
security_group = ""
service_endpoint_policy_ids = []
service_endpoints = []
}]
tags = {}
}
Detail :
EndTime : 9/11/2024 2:32:17 AM
Errors :
Id : /subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.AzureTerraform/operationStatuses/00000000-0000-0000-0000-000000000002*A034E6455B3397057968069439403400471981A03C6A372DB86AB63D04A41AD4
Message :
Name : 00000000-0000-0000-0000-000000000002*A034E6455B3397057968069439403400471981A03C6A372DB86AB63D04A41AD4
PercentComplete :
ResourceGroupName :
ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/providers/
SkippedResource :
StartTime : 9/11/2024 2:32:14 AM
Status : Succeeded
Target :リソース ID を使用してリソースをエクスポートする
例 2: リソース グループを名前でエクスポートする
Export-AzTerraform -ExportParameter $(New-AzTerraformExportResourceGroupObject -ResourceGroupName "aztfy-pwsh-test-rg")
AdditionalInfo :
Code :
Configuration :
Detail :
EndTime : 9/11/2024 2:45:04 AM
Errors :
Id : /subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.AzureTerraform/operationStatuses/96e64a19-eed2-4d98-9d5
a-58c0b8a0aff0*A034E6455B3397057968069439403400471981A03C6A372DB86AB63D04A41AD4
Message :
Name : 96e64a19-eed2-4d98-9d5a-58c0b8a0aff0*A034E6455B3397057968069439403400471981A03C6A372DB86AB63D04A41AD4
PercentComplete :
ResourceGroupName :
ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/providers/
SkippedResource : {/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups//subscriptions/00000000-0000-0000-0000-000000000001/resourc
eGroups/aztfy-pwsh-test-rg}
StartTime : 9/11/2024 2:45:02 AM
Status : Succeeded
Target :リソース グループを名前でエクスポートする
例 3: ARG クエリによるリソースのエクスポート
Export-AzTerraform -ExportParameter $(New-AzTerraformExportQueryObject -Query "type =~ `"microsoft.network/virtualnetworks`"")
AdditionalInfo :
Code :
Configuration : terraform {
required_providers {
azurerm = {
source = "azurerm"
version = "4.0.1"
}
}
}
provider "azurerm" {
features {}
}
resource "azurerm_virtual_network" "res-0" {
address_space = ["10.0.0.0/16"]
bgp_community = ""
dns_servers = []
edge_zone = ""
flow_timeout_in_minutes = 0
___location = "westus3"
name = "test-vnet"
resource_group_name = "aztfy-pwsh-test-rg"
subnet = [{
address_prefixes = ["10.0.0.0/24"]
default_outbound_access_enabled = false
delegation = []
id = "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/aztfy-p
wsh-test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"
name = "default"
private_endpoint_network_policies = "Disabled"
private_link_service_network_policies_enabled = true
route_table_id = ""
security_group = ""
service_endpoint_policy_ids = []
service_endpoints = []
}]
tags = {}
}
Detail :
EndTime : 9/11/2024 7:40:17 AM
Errors :
Id : /subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.AzureTerraform/operationStatuses/5cf722ab-84a1-4a94-a58
6-356b6db6bb86*BED64399B6CC85896CB12E2360BF08E2FDF3132D587CEED230628920BA5D959D
Message :
Name : 5cf722ab-84a1-4a94-a586-356b6db6bb86*BED64399B6CC85896CB12E2360BF08E2FDF3132D587CEED230628920BA5D959D
PercentComplete :
ResourceGroupName :
ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/providers/
SkippedResource :
StartTime : 9/11/2024 7:40:12 AM
Status : Succeeded
Target :ARG クエリによるリソースのエクスポート
パラメーター
-AsJob
コマンドをジョブとして実行する
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
| 型: | SwitchParameter |
| Aliases: | cf |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DefaultProfile
DefaultProfile パラメーターは機能しません。 別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は SubscriptionId パラメーターを使用します。
| 型: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ExportParameter
基本エクスポート パラメーター
| 型: | IBaseExportModel |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-JsonFilePath
エクスポート操作に指定された Json ファイルのパス
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-JsonString
エクスポート操作に指定された Json 文字列
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-NoWait
コマンドを非同期的に実行する
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-SubscriptionId
ターゲット サブスクリプションの ID。 値は UUID である必要があります。
| 型: | String |
| 配置: | Named |
| 規定値: | (Get-AzContext).Subscription.Id |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
| 型: | SwitchParameter |
| Aliases: | wi |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
