Bicep リソース定義
serverSites リソースの種類は、次をターゲットとする操作と共にデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.OffAzure/serverSites リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.OffAzure/serverSites@2024-12-01-preview' = {
scope: resourceSymbolicName or scope
location: 'string'
name: 'string'
properties: {
agentDetails: {
keyVaultId: 'string'
keyVaultUri: 'string'
}
applianceName: 'string'
arcScope: {
locations: [
'string'
]
scopeType: 'string'
subscriptionOrResourceGroupIds: [
'string'
]
syncType: 'string'
tagSyncMode: 'string'
}
discoveryScenario: 'string'
discoverySolutionId: 'string'
servicePrincipalIdentityDetails: {
aadAuthority: 'string'
applicationId: 'string'
audience: 'string'
machineResourceId: 'string'
objectId: 'string'
rawCertData: 'string'
tenantId: 'string'
}
siteAppliancePropertiesCollection: [
{
agentDetails: {
keyVaultId: 'string'
keyVaultUri: 'string'
}
applianceName: 'string'
servicePrincipalIdentityDetails: {
aadAuthority: 'string'
applicationId: 'string'
audience: 'string'
machineResourceId: 'string'
objectId: 'string'
rawCertData: 'string'
tenantId: 'string'
}
}
]
}
tags: {
{customized property}: 'string'
}
}
プロパティ値
Microsoft.OffAzure/serverSites
| 名前 | 形容 | 価値 |
|---|---|---|
| 位置 | リソースが存在する地理的な場所 | string (必須) |
| 名前 | リソース名 | 糸 制約: パターン = ^[a-zA-Z0-9-]{3,24}$ (必須) |
| プロパティ | このリソースのリソース固有のプロパティ。 | ServerSitesプロパティ |
| スコープ | デプロイ スコープとは異なるスコープでリソースを作成するときに使用します。 | このプロパティをリソースのシンボリック名に設定して、拡張リソースを適用します。 |
| タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
ArcScopeプロパティ
| 名前 | 形容 | 価値 |
|---|---|---|
| ロケーション | Arc リソースを検出する場所。 | string[] |
| scopeType | スコープの種類で、現在 SubscriptionOrResourceGroupIds のみがサポートされています。 | 'SubscriptionOrResourceGroupIds' (必須) |
| subscriptionOrResourceGroupIds | サブスクリプションまたはリソース グループの ARM ID の一覧。 scopeType が SubscriptionOrResourceGroupIds の場合にのみ許可されます。 | string[] |
| syncType | 現在手動と定期をサポートしている同期のタイプ。 | 「マニュアル」 「定期的」 |
| タグ同期モード | タグ同期の確認。 有効にすると、Arc リソースのタグが Azure Migrate リソースに同期されます。 | 「無効」 「有効」 |
ServerSitesプロパティ
| 名前 | 形容 | 価値 |
|---|---|---|
| agentDetails | オンプレミス エージェントの詳細を取得または設定します。 | SiteAgentProperties |
| applianceName | アプライアンス名を取得または設定します。 | 文字列 |
| arcスコープ | サーバー サイトの Arc スコープ プロパティを取得または設定します。 | ArcScopeプロパティ |
| discoveryScenario | 検出シナリオを取得または設定します。 | 「DR」 'Migrate' |
| discoverySolutionId | SDS の移行ハブ ソリューションの ARM ID を取得または設定します。 | 文字列 |
| servicePrincipalIdentityDetails | エージェントがサービスへの通信に使用するサービス プリンシパル ID の詳細を取得または設定します。 | SiteSpnProperties |
| siteAppliancePropertiesCollection | アプライアンスと通信するためにサービスによって使用されるアプライアンスの詳細を取得または設定します。 | SiteApplianceProperties[] |
SiteAgentProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| keyVaultId | キー コンテナーの ARM ID を取得または設定します。 | 文字列 |
| keyVaultUri | キー コンテナー URI を取得または設定します。 | 文字列 |
SiteApplianceProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| agentDetails | オンプレミス エージェントの詳細を取得または設定します。 | SiteAgentProperties |
| applianceName | アプライアンス名を取得または設定します。 | 文字列 |
| servicePrincipalIdentityDetails | エージェントがサービスへの通信に使用するサービス プリンシパル ID の詳細を取得または設定します。 | SiteSpnProperties |
SiteSpnProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| aadAuthority | トークンの要求に使用された AAD 機関の URL を取得または設定します。 ザ サービス プリンシパル。 |
文字列 |
| applicationId | 使用するサービス プリンシパルのアプリケーション/クライアント ID を取得または設定します。 ザ オンプレミスの管理/データ プレーン コンポーネントが通信する Azure を使用する サービス。 |
文字列 |
| 聴衆 | サービス プリンシパルの対象ユーザーを取得または設定します。 | 文字列 |
| machineResourceId | Arc for servers リソースの ARM ID を取得または設定します。 | 文字列 |
| objectId | オンプレミスのサービス プリンシパルのオブジェクト ID を取得または設定します。 管理/データ プレーン コンポーネントは、Azure と通信します サービス。 |
文字列 |
| rawCertData | 証明書の有効期限フローを構築するための生の証明書データを取得または設定します。 | 文字列 |
| テナントID | サービス プリンシパルのテナント ID を取得または設定します。 オンプレミス 管理/データ プレーン コンポーネントが Azure サービス。 |
文字列 |
TrackedResourceTags
| 名前 | 形容 | 価値 |
|---|
ARM テンプレート リソース定義
serverSites リソースの種類は、次をターゲットとする操作と共にデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.OffAzure/serverSites リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.OffAzure/serverSites",
"apiVersion": "2024-12-01-preview",
"name": "string",
"location": "string",
"properties": {
"agentDetails": {
"keyVaultId": "string",
"keyVaultUri": "string"
},
"applianceName": "string",
"arcScope": {
"locations": [ "string" ],
"scopeType": "string",
"subscriptionOrResourceGroupIds": [ "string" ],
"syncType": "string",
"tagSyncMode": "string"
},
"discoveryScenario": "string",
"discoverySolutionId": "string",
"servicePrincipalIdentityDetails": {
"aadAuthority": "string",
"applicationId": "string",
"audience": "string",
"machineResourceId": "string",
"objectId": "string",
"rawCertData": "string",
"tenantId": "string"
},
"siteAppliancePropertiesCollection": [
{
"agentDetails": {
"keyVaultId": "string",
"keyVaultUri": "string"
},
"applianceName": "string",
"servicePrincipalIdentityDetails": {
"aadAuthority": "string",
"applicationId": "string",
"audience": "string",
"machineResourceId": "string",
"objectId": "string",
"rawCertData": "string",
"tenantId": "string"
}
}
]
},
"tags": {
"{customized property}": "string"
}
}
プロパティ値
Microsoft.OffAzure/serverSites
| 名前 | 形容 | 価値 |
|---|---|---|
| apiVersion | API のバージョン | '2024-12-01-プレビュー' |
| 位置 | リソースが存在する地理的な場所 | string (必須) |
| 名前 | リソース名 | 糸 制約: パターン = ^[a-zA-Z0-9-]{3,24}$ (必須) |
| プロパティ | このリソースのリソース固有のプロパティ。 | ServerSitesプロパティ |
| タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
| 型 | リソースの種類 | 'Microsoft.OffAzure/serverSites' |
ArcScopeプロパティ
| 名前 | 形容 | 価値 |
|---|---|---|
| ロケーション | Arc リソースを検出する場所。 | string[] |
| scopeType | スコープの種類で、現在 SubscriptionOrResourceGroupIds のみがサポートされています。 | 'SubscriptionOrResourceGroupIds' (必須) |
| subscriptionOrResourceGroupIds | サブスクリプションまたはリソース グループの ARM ID の一覧。 scopeType が SubscriptionOrResourceGroupIds の場合にのみ許可されます。 | string[] |
| syncType | 現在手動と定期をサポートしている同期のタイプ。 | 「マニュアル」 「定期的」 |
| タグ同期モード | タグ同期の確認。 有効にすると、Arc リソースのタグが Azure Migrate リソースに同期されます。 | 「無効」 「有効」 |
ServerSitesプロパティ
| 名前 | 形容 | 価値 |
|---|---|---|
| agentDetails | オンプレミス エージェントの詳細を取得または設定します。 | SiteAgentProperties |
| applianceName | アプライアンス名を取得または設定します。 | 文字列 |
| arcスコープ | サーバー サイトの Arc スコープ プロパティを取得または設定します。 | ArcScopeプロパティ |
| discoveryScenario | 検出シナリオを取得または設定します。 | 「DR」 'Migrate' |
| discoverySolutionId | SDS の移行ハブ ソリューションの ARM ID を取得または設定します。 | 文字列 |
| servicePrincipalIdentityDetails | エージェントがサービスへの通信に使用するサービス プリンシパル ID の詳細を取得または設定します。 | SiteSpnProperties |
| siteAppliancePropertiesCollection | アプライアンスと通信するためにサービスによって使用されるアプライアンスの詳細を取得または設定します。 | SiteApplianceProperties[] |
SiteAgentProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| keyVaultId | キー コンテナーの ARM ID を取得または設定します。 | 文字列 |
| keyVaultUri | キー コンテナー URI を取得または設定します。 | 文字列 |
SiteApplianceProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| agentDetails | オンプレミス エージェントの詳細を取得または設定します。 | SiteAgentProperties |
| applianceName | アプライアンス名を取得または設定します。 | 文字列 |
| servicePrincipalIdentityDetails | エージェントがサービスへの通信に使用するサービス プリンシパル ID の詳細を取得または設定します。 | SiteSpnProperties |
SiteSpnProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| aadAuthority | トークンの要求に使用された AAD 機関の URL を取得または設定します。 ザ サービス プリンシパル。 |
文字列 |
| applicationId | 使用するサービス プリンシパルのアプリケーション/クライアント ID を取得または設定します。 ザ オンプレミスの管理/データ プレーン コンポーネントが通信する Azure を使用する サービス。 |
文字列 |
| 聴衆 | サービス プリンシパルの対象ユーザーを取得または設定します。 | 文字列 |
| machineResourceId | Arc for servers リソースの ARM ID を取得または設定します。 | 文字列 |
| objectId | オンプレミスのサービス プリンシパルのオブジェクト ID を取得または設定します。 管理/データ プレーン コンポーネントは、Azure と通信します サービス。 |
文字列 |
| rawCertData | 証明書の有効期限フローを構築するための生の証明書データを取得または設定します。 | 文字列 |
| テナントID | サービス プリンシパルのテナント ID を取得または設定します。 オンプレミス 管理/データ プレーン コンポーネントが Azure サービス。 |
文字列 |
TrackedResourceTags
| 名前 | 形容 | 価値 |
|---|
使用例
Terraform (AzAPI プロバイダー) リソース定義
serverSites リソースの種類は、次をターゲットとする操作と共にデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.OffAzure/serverSites リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.OffAzure/serverSites@2024-12-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
agentDetails = {
keyVaultId = "string"
keyVaultUri = "string"
}
applianceName = "string"
arcScope = {
locations = [
"string"
]
scopeType = "string"
subscriptionOrResourceGroupIds = [
"string"
]
syncType = "string"
tagSyncMode = "string"
}
discoveryScenario = "string"
discoverySolutionId = "string"
servicePrincipalIdentityDetails = {
aadAuthority = "string"
applicationId = "string"
audience = "string"
machineResourceId = "string"
objectId = "string"
rawCertData = "string"
tenantId = "string"
}
siteAppliancePropertiesCollection = [
{
agentDetails = {
keyVaultId = "string"
keyVaultUri = "string"
}
applianceName = "string"
servicePrincipalIdentityDetails = {
aadAuthority = "string"
applicationId = "string"
audience = "string"
machineResourceId = "string"
objectId = "string"
rawCertData = "string"
tenantId = "string"
}
}
]
}
}
}
プロパティ値
Microsoft.OffAzure/serverSites
| 名前 | 形容 | 価値 |
|---|---|---|
| 位置 | リソースが存在する地理的な場所 | string (必須) |
| 名前 | リソース名 | 糸 制約: パターン = ^[a-zA-Z0-9-]{3,24}$ (必須) |
| parent_id | この拡張リソースを適用するリソースの ID。 | string (必須) |
| プロパティ | このリソースのリソース固有のプロパティ。 | ServerSitesプロパティ |
| タグ | リソース タグ | タグ名と値のディクショナリ。 |
| 型 | リソースの種類 | "Microsoft.OffAzure/serverSites@2024-12-01-preview" |
ArcScopeプロパティ
| 名前 | 形容 | 価値 |
|---|---|---|
| ロケーション | Arc リソースを検出する場所。 | string[] |
| scopeType | スコープの種類で、現在 SubscriptionOrResourceGroupIds のみがサポートされています。 | 'SubscriptionOrResourceGroupIds' (必須) |
| subscriptionOrResourceGroupIds | サブスクリプションまたはリソース グループの ARM ID の一覧。 scopeType が SubscriptionOrResourceGroupIds の場合にのみ許可されます。 | string[] |
| syncType | 現在手動と定期をサポートしている同期のタイプ。 | 「マニュアル」 「定期的」 |
| タグ同期モード | タグ同期の確認。 有効にすると、Arc リソースのタグが Azure Migrate リソースに同期されます。 | 「無効」 「有効」 |
ServerSitesプロパティ
| 名前 | 形容 | 価値 |
|---|---|---|
| agentDetails | オンプレミス エージェントの詳細を取得または設定します。 | SiteAgentProperties |
| applianceName | アプライアンス名を取得または設定します。 | 文字列 |
| arcスコープ | サーバー サイトの Arc スコープ プロパティを取得または設定します。 | ArcScopeプロパティ |
| discoveryScenario | 検出シナリオを取得または設定します。 | 「DR」 'Migrate' |
| discoverySolutionId | SDS の移行ハブ ソリューションの ARM ID を取得または設定します。 | 文字列 |
| servicePrincipalIdentityDetails | エージェントがサービスへの通信に使用するサービス プリンシパル ID の詳細を取得または設定します。 | SiteSpnProperties |
| siteAppliancePropertiesCollection | アプライアンスと通信するためにサービスによって使用されるアプライアンスの詳細を取得または設定します。 | SiteApplianceProperties[] |
SiteAgentProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| keyVaultId | キー コンテナーの ARM ID を取得または設定します。 | 文字列 |
| keyVaultUri | キー コンテナー URI を取得または設定します。 | 文字列 |
SiteApplianceProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| agentDetails | オンプレミス エージェントの詳細を取得または設定します。 | SiteAgentProperties |
| applianceName | アプライアンス名を取得または設定します。 | 文字列 |
| servicePrincipalIdentityDetails | エージェントがサービスへの通信に使用するサービス プリンシパル ID の詳細を取得または設定します。 | SiteSpnProperties |
SiteSpnProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| aadAuthority | トークンの要求に使用された AAD 機関の URL を取得または設定します。 ザ サービス プリンシパル。 |
文字列 |
| applicationId | 使用するサービス プリンシパルのアプリケーション/クライアント ID を取得または設定します。 ザ オンプレミスの管理/データ プレーン コンポーネントが通信する Azure を使用する サービス。 |
文字列 |
| 聴衆 | サービス プリンシパルの対象ユーザーを取得または設定します。 | 文字列 |
| machineResourceId | Arc for servers リソースの ARM ID を取得または設定します。 | 文字列 |
| objectId | オンプレミスのサービス プリンシパルのオブジェクト ID を取得または設定します。 管理/データ プレーン コンポーネントは、Azure と通信します サービス。 |
文字列 |
| rawCertData | 証明書の有効期限フローを構築するための生の証明書データを取得または設定します。 | 文字列 |
| テナントID | サービス プリンシパルのテナント ID を取得または設定します。 オンプレミス 管理/データ プレーン コンポーネントが Azure サービス。 |
文字列 |
TrackedResourceTags
| 名前 | 形容 | 価値 |
|---|