Microsoft.ServiceFabric managedClusters/nodeTypes 2021-01-01-preview

  • [アーティクル]

Bicep リソース定義

managedClusters/nodeTypes リソースの種類は、次をターゲットとする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.ServiceFabric/managedClusters/nodeTypes リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.ServiceFabric/managedClusters/nodeTypes@2021-01-01-preview' = {
  name: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    applicationPorts: {
      endPort: int
      startPort: int
    }
    capacities: {
      {customized property}: 'string'
    }
    dataDiskSizeGB: int
    ephemeralPorts: {
      endPort: int
      startPort: int
    }
    isPrimary: bool
    placementProperties: {
      {customized property}: 'string'
    }
    vmExtensions: [
      {
        name: 'string'
        properties: {
          autoUpgradeMinorVersion: bool
          forceUpdateTag: 'string'
          protectedSettings: any()
          provisionAfterExtensions: [
            'string'
          ]
          publisher: 'string'
          settings: any()
          type: 'string'
          typeHandlerVersion: 'string'
        }
      }
    ]
    vmImageOffer: 'string'
    vmImagePublisher: 'string'
    vmImageSku: 'string'
    vmImageVersion: 'string'
    vmInstanceCount: int
    vmManagedIdentity: {
      userAssignedIdentities: [
        'string'
      ]
    }
    vmSecrets: [
      {
        sourceVault: {
          id: 'string'
        }
        vaultCertificates: [
          {
            certificateStore: 'string'
            certificateUrl: 'string'
          }
        ]
      }
    ]
    vmSize: 'string'
  }
}

プロパティ値

managedClusters/nodeTypes

名前 説明 値
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。		 string (必須)
tags Azure リソース タグ。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部の子リソース」を参照してください。		 種類のリソースのシンボル名: managedClusters
properties ノードの種類のプロパティ NodeTypeProperties

NodeTypeProperties

名前 説明 値
applicationPorts クラスターが Service Fabric アプリケーションにポートを割り当てたポートの範囲。 EndpointRangeDescription
capacities ノードの種類のノードに適用される容量タグでは、クラスター リソース マネージャーはこれらのタグを使用して、ノードのリソースの量を把握します。 NodeTypePropertiesCapacities
dataDiskSizeGB GB のノード タイプ内の各 VM のディスク サイズ。 int (必須)
ephemeralPorts このノード タイプのノードを構成する必要があるエフェメラル ポートの範囲。 EndpointRangeDescription
isPrimary システム サービスを実行するノードの種類。 プライマリとしてマークするノード タイプは 1 つだけです。 既存のクラスターでは、プライマリ ノードの種類を削除または変更できません。 bool (必須)
placementProperties ノード の種類のノードに適用される配置タグ。これは、特定のサービス (ワークロード) を実行する場所を示すために使用できます。 NodeTypePropertiesPlacementProperties
vmExtensions 仮想マシンにインストールする必要がある拡張機能のセット。 VmssExtension[]
vmImageOffer Azure Virtual Machines Marketplace イメージのオファーの種類。 たとえば、UbuntuServer や WindowsServer などです。 string
vmImagePublisher Azure Virtual Machines Marketplace イメージの発行元。 たとえば、Canonical や MicrosoftWindowsServer などです。 string
vmImageSku Azure Virtual Machines Marketplace イメージの SKU。 たとえば、14.04.0-LTS や 2012-R2-Datacenter などです。 string
vmImageVersion Azure Virtual Machines Marketplace イメージのバージョン。 'latest' の値を指定して、イメージの最新バージョンを選択できます。 省略した場合、既定値は 'latest' です。 string
vmInstanceCount ノード タイプ内のノードの数。 int (必須)

制約:
最小値 = 1
最大値 = 2147483647
vmManagedIdentity ノードの種類の下にある仮想マシン スケール セットの ID。 VmManagedIdentity
vmSecrets 仮想マシンにインストールするシークレット。 VaultSecretGroup[]
vmSize プール内の仮想マシンのサイズ。 プール内の仮想マシンのサイズはすべて同じです。 たとえば、Standard_D3。 string

EndpointRangeDescription

名前 説明 値
endPort ポートの範囲の終了ポート int (必須)
startPort 一連のポートの開始ポート int (必須)

NodeTypePropertiesCapacities

名前 説明 値
{カスタマイズされたプロパティ} string

NodeTypePropertiesPlacementProperties

名前 説明 値
{カスタマイズされたプロパティ} string

VmssExtension

名前 説明 値
name 拡張機能の名前です。 string (必須)
properties 仮想マシン スケール セット拡張機能のプロパティについて説明します。 VmssExtensionProperties (必須)

VmssExtensionProperties

名前 説明 値
autoUpgradeMinorVersion 展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能でマイナー バージョンのアップグレードは行われません。 [bool]
forceUpdateTag 値が指定され、前の値と異なる場合、拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーは強制的に更新されます。 string
protectedSettings 拡張機能には、protectedSettings または protectedSettingsFromKeyVault を含めることができます。または、保護された設定をまったく含めなくなります。 Bicep の場合は、 any() 関数を使用できます。
provisionAfterExtensions この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。 string[]
publisher 拡張ハンドラーの発行元の名前。 string (必須)
settings 拡張機能の Json 形式のパブリック設定。 Bicep の場合は、 any() 関数を使用できます。
型 拡張機能の種類を指定します。たとえば、"CustomScriptExtension" です。 string (必須)
typeHandlerVersion スクリプト ハンドラーのバージョンを指定します。 string (必須)

VmManagedIdentity

名前 説明 値
userAssignedIdentities ノードの種類の下にある仮想マシン スケール セットに関連付けられているユーザー ID の一覧。 各エントリは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 string[]

VaultSecretGroup

名前 説明 値
sourceVault VaultCertificates 内のすべての証明書を含むKey Vaultの相対 URL。 SubResource (必須)
vaultCertificates 証明書を含む SourceVault のキー コンテナー参照の一覧。 VaultCertificate[] (必須)

サブリソース

名前 説明 値
id Azure リソース識別子。 string

VaultCertificate

名前 説明 値
certificateStore Windows VM の場合は、証明書を追加する仮想マシン上の証明書ストアを指定します。 指定された証明書ストアは、LocalMachine アカウントに暗黙的に含まれます。

Linux VM の場合、証明書ファイルは /var/lib/waagent ディレクトリの下に配置され、X509 証明書ファイルにはファイル名 {UppercaseThumbprint}.crt、秘密キーには {UppercaseThumbprint}.prv が付けられます。 これらのファイルはどちらも .pem 形式です。		 string (必須)
certificateUrl これは、シークレットとしてKey Vaultにアップロードされた証明書の URL です。 Key Vaultにシークレットを追加する方法については、「キー コンテナーにキーまたはシークレットを追加する」を参照してください。 この場合、証明書は UTF-8 でエンコードされた次の JSON オブジェクトの Base64 エンコードである必要があります。

{
"data":"{Base64-encoded-certificate}",
"dataType":"pfx",
"password":"{pfx-file-password}"
}		 string (必須)

ARM テンプレート リソース定義

managedClusters/nodeTypes リソースの種類は、次をターゲットとする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.ServiceFabric/managedClusters/nodeTypes リソースを作成するには、テンプレートに次の JSON を追加します。

{
  "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes",
  "apiVersion": "2021-01-01-preview",
  "name": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "applicationPorts": {
      "endPort": "int",
      "startPort": "int"
    },
    "capacities": {
      "{customized property}": "string"
    },
    "dataDiskSizeGB": "int",
    "ephemeralPorts": {
      "endPort": "int",
      "startPort": "int"
    },
    "isPrimary": "bool",
    "placementProperties": {
      "{customized property}": "string"
    },
    "vmExtensions": [
      {
        "name": "string",
        "properties": {
          "autoUpgradeMinorVersion": "bool",
          "forceUpdateTag": "string",
          "protectedSettings": {},
          "provisionAfterExtensions": [ "string" ],
          "publisher": "string",
          "settings": {},
          "type": "string",
          "typeHandlerVersion": "string"
        }
      }
    ],
    "vmImageOffer": "string",
    "vmImagePublisher": "string",
    "vmImageSku": "string",
    "vmImageVersion": "string",
    "vmInstanceCount": "int",
    "vmManagedIdentity": {
      "userAssignedIdentities": [ "string" ]
    },
    "vmSecrets": [
      {
        "sourceVault": {
          "id": "string"
        },
        "vaultCertificates": [
          {
            "certificateStore": "string",
            "certificateUrl": "string"
          }
        ]
      }
    ],
    "vmSize": "string"
  }
}

プロパティ値

managedClusters/nodeTypes

名前 説明 値
type リソースの種類 'Microsoft.ServiceFabric/managedClusters/nodeTypes'
apiVersion リソース API のバージョン '2021-01-01-preview'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。		 string (必須)
tags Azure リソース タグ。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
properties ノードの種類のプロパティ NodeTypeProperties

NodeTypeProperties

名前 説明 値
applicationPorts クラスターが Service Fabric アプリケーションにポートを割り当てたポートの範囲。 EndpointRangeDescription
capacities ノードの種類のノードに適用される容量タグでは、クラスター リソース マネージャーはこれらのタグを使用して、ノードのリソースの量を把握します。 NodeTypePropertiesCapacities
dataDiskSizeGB GB のノード タイプ内の各 VM のディスク サイズ。 int (必須)
ephemeralPorts このノード タイプのノードを構成する必要があるエフェメラル ポートの範囲。 EndpointRangeDescription
isPrimary システム サービスを実行するノードの種類。 プライマリとしてマークするノード タイプは 1 つだけです。 既存のクラスターでは、プライマリ ノードの種類を削除または変更できません。 bool (必須)
placementProperties ノード の種類のノードに適用される配置タグ。これは、特定のサービス (ワークロード) を実行する場所を示すために使用できます。 NodeTypePropertiesPlacementProperties
vmExtensions 仮想マシンにインストールする必要がある拡張機能のセット。 VmssExtension[]
vmImageOffer Azure Virtual Machines Marketplace イメージのオファーの種類。 たとえば、UbuntuServer や WindowsServer などです。 string
vmImagePublisher Azure Virtual Machines Marketplace イメージの発行元。 たとえば、Canonical や MicrosoftWindowsServer などです。 string
vmImageSku Azure Virtual Machines Marketplace イメージの SKU。 たとえば、14.04.0-LTS や 2012-R2-Datacenter などです。 string
vmImageVersion Azure Virtual Machines Marketplace イメージのバージョン。 'latest' の値を指定して、イメージの最新バージョンを選択できます。 省略した場合、既定値は 'latest' です。 string
vmInstanceCount ノード タイプ内のノードの数。 int (必須)

制約:
最小値 = 1
最大値 = 2147483647
vmManagedIdentity ノードの種類の下にある仮想マシン スケール セットの ID。 VmManagedIdentity
vmSecrets 仮想マシンにインストールするシークレット。 VaultSecretGroup[]
vmSize プール内の仮想マシンのサイズ。 プール内の仮想マシンのサイズはすべて同じです。 たとえば、Standard_D3。 string

EndpointRangeDescription

名前 説明 値
endPort ポートの範囲の終了ポート int (必須)
startPort 一連のポートの開始ポート int (必須)

NodeTypePropertiesCapacities

名前 説明 値
{カスタマイズされたプロパティ} string

NodeTypePropertiesPlacementProperties

名前 説明 値
{カスタマイズされたプロパティ} string

VmssExtension

名前 説明 値
name 拡張機能の名前です。 string (必須)
properties 仮想マシン スケール セット拡張機能のプロパティについて説明します。 VmssExtensionProperties (必須)

VmssExtensionProperties

名前 説明 値
autoUpgradeMinorVersion 展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能でマイナー バージョンのアップグレードは行われません。 [bool]
forceUpdateTag 値が指定され、前の値と異なる場合、拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーは強制的に更新されます。 string
protectedSettings 拡張機能には、protectedSettings または protectedSettingsFromKeyVault を含めることができます。または、保護された設定をまったく含めなくなります。
provisionAfterExtensions この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。 string[]
publisher 拡張ハンドラーの発行元の名前。 string (必須)
settings 拡張機能の Json 形式のパブリック設定。
型 拡張機能の種類を指定します。たとえば、"CustomScriptExtension" です。 string (必須)
typeHandlerVersion スクリプト ハンドラーのバージョンを指定します。 string (必須)

VmManagedIdentity

名前 説明 値
userAssignedIdentities ノードの種類の下にある仮想マシン スケール セットに関連付けられているユーザー ID の一覧。 各エントリは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 string[]

VaultSecretGroup

名前 説明 値
sourceVault VaultCertificates 内のすべての証明書を含むKey Vaultの相対 URL。 SubResource (必須)
vaultCertificates 証明書を含む SourceVault のキー コンテナー参照の一覧。 VaultCertificate[] (必須)

サブリソース

名前 説明 値
id Azure リソース識別子。 string

VaultCertificate

名前 説明 値
certificateStore Windows VM の場合は、証明書を追加する仮想マシン上の証明書ストアを指定します。 指定した証明書ストアは、LocalMachine アカウントに暗黙的に含まれます。

Linux VM の場合、証明書ファイルは /var/lib/waagent ディレクトリの下に配置され、X509 証明書ファイルの場合はファイル名 {UppercaseThumbprint}.crt、秘密キーには {UppercaseThumbprint}.prv が付けられます。 これらのファイルはどちらも .pem 形式です。		 string (必須)
certificateUrl これは、シークレットとしてKey Vaultにアップロードされた証明書の URL です。 Key Vaultにシークレットを追加する方法については、「キー コンテナーにキーまたはシークレットを追加する」を参照してください。 この場合、証明書は UTF-8 でエンコードされた次の JSON オブジェクトの Base64 エンコードである必要があります。

{
"data":"{Base64-encoded-certificate}",
"dataType":"pfx",
"password":"{pfx-file-password}"
}		 string (必須)

Terraform (AzAPI プロバイダー) リソース定義

managedClusters/nodeTypes リソースの種類は、次をターゲットとする操作でデプロイできます。

  • リソース グループ

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.ServiceFabric/managedClusters/nodeTypes リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ServiceFabric/managedClusters/nodeTypes@2021-01-01-preview"
  name = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      applicationPorts = {
        endPort = int
        startPort = int
      }
      capacities = {
        {customized property} = "string"
      }
      dataDiskSizeGB = int
      ephemeralPorts = {
        endPort = int
        startPort = int
      }
      isPrimary = bool
      placementProperties = {
        {customized property} = "string"
      }
      vmExtensions = [
        {
          name = "string"
          properties = {
            autoUpgradeMinorVersion = bool
            forceUpdateTag = "string"
            provisionAfterExtensions = [
              "string"
            ]
            publisher = "string"
            type = "string"
            typeHandlerVersion = "string"
          }
        }
      ]
      vmImageOffer = "string"
      vmImagePublisher = "string"
      vmImageSku = "string"
      vmImageVersion = "string"
      vmInstanceCount = int
      vmManagedIdentity = {
        userAssignedIdentities = [
          "string"
        ]
      }
      vmSecrets = [
        {
          sourceVault = {
            id = "string"
          }
          vaultCertificates = [
            {
              certificateStore = "string"
              certificateUrl = "string"
            }
          ]
        }
      ]
      vmSize = "string"
    }
  })
}

プロパティ値

managedClusters/nodeTypes

名前 説明 値
type リソースの種類 "Microsoft.ServiceFabric/managedClusters/nodeTypes@2021-01-01-preview"
name リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: managedClusters
tags Azure リソース タグ。 タグの名前と値のディクショナリ。
properties ノードの種類のプロパティ NodeTypeProperties

NodeTypeProperties

名前 説明 値
applicationPorts クラスターが Service Fabric アプリケーションにポートを割り当てたポートの範囲。 EndpointRangeDescription
capacities ノードの種類のノードに適用される容量タグでは、クラスター リソース マネージャーはこれらのタグを使用して、ノードのリソースの量を把握します。 NodeTypePropertiesCapacities
dataDiskSizeGB GB のノード タイプ内の各 VM のディスク サイズ。 int (必須)
ephemeralPorts このノード タイプのノードを構成する必要があるエフェメラル ポートの範囲。 EndpointRangeDescription
isPrimary システム サービスを実行するノードの種類。 プライマリとしてマークするノード タイプは 1 つだけです。 既存のクラスターでは、プライマリ ノードの種類を削除または変更できません。 bool (必須)
placementProperties ノード の種類のノードに適用される配置タグ。これは、特定のサービス (ワークロード) を実行する場所を示すために使用できます。 NodeTypePropertiesPlacementProperties
vmExtensions 仮想マシンにインストールする必要がある拡張機能のセット。 VmssExtension[]
vmImageOffer Azure Virtual Machines Marketplace イメージのオファーの種類。 たとえば、UbuntuServer や WindowsServer などです。 string
vmImagePublisher Azure Virtual Machines Marketplace イメージの発行元。 たとえば、Canonical や MicrosoftWindowsServer などです。 string
vmImageSku Azure Virtual Machines Marketplace イメージの SKU。 たとえば、14.04.0-LTS や 2012-R2-Datacenter などです。 string
vmImageVersion Azure Virtual Machines Marketplace イメージのバージョン。 'latest' の値を指定して、イメージの最新バージョンを選択できます。 省略した場合、既定値は 'latest' です。 string
vmInstanceCount ノード タイプ内のノードの数。 int (必須)

制約:
最小値 = 1
最大値 = 2147483647
vmManagedIdentity ノードの種類の下にある仮想マシン スケール セットの ID。 VmManagedIdentity
vmSecrets 仮想マシンにインストールするシークレット。 VaultSecretGroup[]
vmSize プール内の仮想マシンのサイズ。 プール内の仮想マシンのサイズはすべて同じです。 たとえば、Standard_D3。 string

EndpointRangeDescription

名前 説明 値
endPort ポートの範囲の終了ポート int (必須)
startPort ポート範囲の開始ポート int (必須)

NodeTypePropertiesCapacities

名前 説明 値
{カスタマイズされたプロパティ} string

NodeTypePropertiesPlacementProperties

名前 説明 値
{カスタマイズされたプロパティ} string

VmssExtension

名前 説明 値
name 拡張機能の名前です。 string (必須)
properties 仮想マシン スケール セット拡張機能のプロパティについて説明します。 VmssExtensionProperties (必須)

VmssExtensionProperties

名前 説明 値
autoUpgradeMinorVersion 展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用するかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能でマイナー バージョンのアップグレードは行われません。 [bool]
forceUpdateTag 値が指定され、前の値と異なる場合、拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーは強制的に更新されます。 string
protectedSettings 拡張機能には、protectedSettings または protectedSettingsFromKeyVault を含めることも、保護された設定をまったく含めることもできます。
provisionAfterExtensions この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。 string[]
publisher 拡張ハンドラーパブリッシャーの名前。 string (必須)
settings 拡張機能の Json 形式のパブリック設定。
型 拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。 string (必須)
typeHandlerVersion スクリプト ハンドラーのバージョンを指定します。 string (必須)

VmManagedIdentity

名前 説明 値
userAssignedIdentities ノードの種類の下にある仮想マシン スケール セットに関連付けられているユーザー ID の一覧。 各エントリは、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" という形式の ARM リソース ID になります。 string[]

VaultSecretGroup

名前 説明 値
sourceVault VaultCertificates のすべての証明書を含むKey Vaultの相対 URL。 SubResource (必須)
vaultCertificates 証明書を含む SourceVault 内のキー コンテナー参照の一覧。 VaultCertificate[] (必須)

サブリソース

名前 説明 値
id Azure リソース識別子。 string

VaultCertificate

名前 説明 値
certificateStore Windows VM の場合は、証明書を追加する仮想マシン上の証明書ストアを指定します。 指定された証明書ストアは、LocalMachine アカウントに暗黙的に含まれます。

Linux VM の場合、証明書ファイルは /var/lib/waagent ディレクトリの下に配置され、X509 証明書ファイルにはファイル名 {UppercaseThumbprint}.crt、秘密キーには {UppercaseThumbprint}.prv が付けられます。 これらのファイルはどちらも .pem 形式です。		 string (必須)
certificateUrl これは、シークレットとしてKey Vaultにアップロードされた証明書の URL です。 Key Vaultにシークレットを追加する方法については、「キー コンテナーにキーまたはシークレットを追加する」を参照してください。 この場合、証明書は UTF-8 でエンコードされた次の JSON オブジェクトの Base64 エンコードである必要があります。

{
"data":"{Base64-encoded-certificate}",
"dataType":"pfx",
"password":"{pfx-file-password}"
}		 string (必須)