Load Balancers - Create Or Update

サービス:: AKS

API バージョン:: 2025-05-02-preview

指定したマネージドクラスターでロードバランサーを作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/loadBalancers/{loadBalancerName}?api-version=2025-05-02-preview

URI パラメーター

名前	/	必須	型	説明
loadBalancerName	path	True	string minLength: 1 maxLength: 12 pattern: ^[a-z][a-z0-9]{0,11}$	ロードバランサ―の名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前は大文字と小文字が区別されます。
resourceName	path	True	string minLength: 1 maxLength: 63 pattern: ^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$	マネージドクラスターリソースの名前。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
properties.primaryAgentPoolName	True	string	必須フィールド。既存のエージェントプールの ID を指定する必要がある文字列値。特定のプール内のすべてのノードは、常にこのロードバランサーに追加されます。このエージェントプールには、自動スケール操作用に少なくとも 1 つのノードと minCount>=1 が必要です。エージェントプールは、1 つのロードバランサーのプライマリプールに限定できます。
properties.allowServicePlacement		boolean	サービスをロードバランサーに自動的に配置するかどうか。指定しない場合、既定値は true です。手動で false に設定すると、外部ロードバランサーと内部ロードバランサーの両方がサービスに対して明示的に対象とされない限り選択されません。
properties.nodeSelector		LabelSelector	このセレクターに一致するノードは、このロードバランサーのメンバーとして使用できます。
properties.serviceLabelSelector		LabelSelector	このセレクターに一致する必要があるサービスのみを、このロードバランサーに配置できます。
properties.serviceNamespaceSelector		LabelSelector	セレクターに一致する名前空間で作成されたサービスは、このロードバランサーに配置できます。

応答

名前	型	説明
200 OK	LoadBalancer	既存のロードバランサーが正常に更新されました
201 Created	LoadBalancer	新しいロードバランサーが正常に作成されました
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Create or update a Load Balancer

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/loadBalancers/kubernetes?api-version=2025-05-02-preview

{
  "properties": {
    "primaryAgentPoolName": "agentpool1",
    "allowServicePlacement": true
  }
}

応答のサンプル

状態コード:: 200

{
  "name": "kubernetes",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/loadBalancers/kubernetes",
  "properties": {
    "primaryAgentPoolName": "agentPool1",
    "allowServicePlacement": true,
    "provisioningState": "Succeeded"
  }
}

状態コード:: 201

{
  "name": "kubernetes",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/loadBalancers/kubernetes",
  "properties": {
    "primaryAgentPoolName": "agentPool1",
    "allowServicePlacement": true,
    "provisioningState": "Succeeded"
  }
}

定義

名前	説明
CloudError	コンテナーサービスからのエラー応答。
CloudErrorBody	コンテナーサービスからのエラー応答。
createdByType	リソースを作成した ID の種類。
LabelSelector	ラベルセレクターは、一連のリソースに対するラベルクエリです。 matchLabels と matchExpressions の結果は ANDed です。空のラベルセレクターは、すべてのオブジェクトと一致します。 null ラベルセレクターは、オブジェクトと一致しません。
LabelSelectorRequirement	ラベルセレクターの要件は、値、キー、およびキーと値を関連付ける演算子を含むセレクターです。
LoadBalancer	複数の Standard ロードバランサーに関する構成。指定しない場合は、単一ロードバランサーモードが使用されます。リース時に 1 つの構成が指定されている場合は、複数の Standard ロードバランサーモードが使用されます。 `kubernetes`という名前の構成が必要です。 name フィールドは、対応するパブリックロードバランサーの名前になります。必要に応じて内部ロードバランサーが作成され、名前が `<name>-internal`されます。内部 lb は、外部構成と同じ構成を共有します。内部 lbs を LoadBalancer リストに含める必要はありません。
operator	演算子は、一連の値に対するキーのリレーションシップを表します。有効な演算子は In と NotIn です
systemData	リソースの作成と最後の変更に関連するメタデータ。

CloudError

Object

コンテナーサービスからのエラー応答。

名前	型	説明
error	CloudErrorBody	エラーの詳細。

CloudErrorBody

Object

コンテナーサービスからのエラー応答。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
details	CloudErrorBody[]	エラーに関する追加の詳細の一覧。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。たとえば、エラーが発生したプロパティの名前です。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

LabelSelector

Object

ラベルセレクターは、一連のリソースに対するラベルクエリです。 matchLabels と matchExpressions の結果は ANDed です。空のラベルセレクターは、すべてのオブジェクトと一致します。 null ラベルセレクターは、オブジェクトと一致しません。

名前	型	説明
matchExpressions	LabelSelectorRequirement[]	matchExpressions は、ラベルセレクターの要件の一覧です。要件は ANDed です。
matchLabels	string[]	matchLabels は{key=value} ペアの配列です。 matchLabels マップ内の 1 つの {key=value} は、matchExpressions の要素と同じです。この要素のキーフィールドは `key`され、演算子は `In`され、値配列には `value`のみが含まれます。要件は ANDed です。

LabelSelectorRequirement

Object

ラベルセレクターの要件は、値、キー、およびキーと値を関連付ける演算子を含むセレクターです。

名前	型	説明
key	string	キーは、セレクターが適用されるラベルキーです。
operator	operator	演算子は、一連の値に対するキーのリレーションシップを表します。有効な演算子は In と NotIn です
values	string[]	values は文字列値の配列です。値の配列は空でない必要があります。

LoadBalancer

Object

複数の Standard ロードバランサーに関する構成。指定しない場合は、単一ロードバランサーモードが使用されます。リース時に 1 つの構成が指定されている場合は、複数の Standard ロードバランサーモードが使用されます。 kubernetesという名前の構成が必要です。 name フィールドは、対応するパブリックロードバランサーの名前になります。必要に応じて内部ロードバランサーが作成され、名前が <name>-internalされます。内部 lb は、外部構成と同じ構成を共有します。内部 lbs を LoadBalancer リストに含める必要はありません。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.allowServicePlacement	boolean	サービスをロードバランサーに自動的に配置するかどうか。指定しない場合、既定値は true です。手動で false に設定すると、外部ロードバランサーと内部ロードバランサーの両方がサービスに対して明示的に対象とされない限り選択されません。
properties.nodeSelector	LabelSelector	このセレクターに一致するノードは、このロードバランサーのメンバーとして使用できます。
properties.primaryAgentPoolName	string	必須フィールド。既存のエージェントプールの ID を指定する必要がある文字列値。特定のプール内のすべてのノードは、常にこのロードバランサーに追加されます。このエージェントプールには、自動スケール操作用に少なくとも 1 つのノードと minCount>=1 が必要です。エージェントプールは、1 つのロードバランサーのプライマリプールに限定できます。
properties.provisioningState	string	現在のプロビジョニング状態。
properties.serviceLabelSelector	LabelSelector	このセレクターに一致する必要があるサービスのみを、このロードバランサーに配置できます。
properties.serviceNamespaceSelector	LabelSelector	セレクターに一致する名前空間で作成されたサービスは、このロードバランサーに配置できます。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

operator

列挙

演算子は、一連の値に対するキーのリレーションシップを表します。有効な演算子は In と NotIn です

値	説明
In	キーの値は、指定されたリストに含まれている必要があります。
NotIn	キーの値は、指定されたリストに含めてはなりません。
Exists	キーの値が存在する必要があります。
DoesNotExist	キーの値は存在しません。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有

Load Balancers - Create Or Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

Create or update a Load Balancer

要求のサンプル

応答のサンプル

定義

CloudError

CloudErrorBody

createdByType

LabelSelector

LabelSelectorRequirement

LoadBalancer

operator

systemData