Broker - Create Or Update

サービス:
IoT Operations
API バージョン:
2026-07-01

BrokerResource を作成する

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}?api-version=2026-07-01

URI パラメーター

名前 / 必須 型 説明
brokerName
 path True

string

minLength: 3
maxLength: 63
pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$

ブローカーの名前。
instanceName
 path True

string

minLength: 3
maxLength: 63
pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$

インスタンスの名前。
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

リソース グループの名前。 名前は大文字と小文字を区別しません。
subscriptionId
 path True

string (uuid)

ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version
 query True

string

minLength: 1

この操作に使用する API バージョン。

要求本文

名前 型 説明
extendedLocation

ExtendedLocation

リソースのエッジの場所。
properties

BrokerProperties

このリソースのリソース固有のプロパティ。

応答

名前 型 説明
200 OK

BrokerResource

リソース 'BrokerResource' の更新操作に成功しました
201 Created

BrokerResource

リソース 'BrokerResource' の作成操作に成功しました

ヘッダー

  • Azure-AsyncOperation: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

名前 説明
user_impersonation あなたのユーザー アカウントになりすます

例

Broker_CreateOrUpdate
Broker_CreateOrUpdate_Complex
Broker_CreateOrUpdate_Minimal
Broker_CreateOrUpdate_Simple

Broker_CreateOrUpdate

要求のサンプル

PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2026-07-01

{
  "properties": {
    "advanced": {
      "clients": {
        "maxSessionExpirySeconds": 3859,
        "maxMessageExpirySeconds": 3263,
        "maxPacketSizeBytes": 3029,
        "subscriberQueueLimit": {
          "length": 6,
          "strategy": "None"
        },
        "maxReceiveMaximum": 2365,
        "maxKeepAliveSeconds": 3744
      },
      "encryptInternalTraffic": "Enabled",
      "internalCerts": {
        "duration": "bchrc",
        "renewBefore": "xkafmpgjfifkwwrhkswtopdnne",
        "privateKey": {
          "algorithm": "Ec256",
          "rotationPolicy": "Always"
        }
      }
    },
    "cardinality": {
      "backendChain": {
        "partitions": 11,
        "redundancyFactor": 5,
        "workers": 15
      },
      "frontend": {
        "replicas": 2,
        "workers": 6
      }
    },
    "diagnostics": {
      "logs": {
        "level": "rnmwokumdmebpmfxxxzvvjfdywotav"
      },
      "metrics": {
        "prometheusPort": 7581
      },
      "selfCheck": {
        "mode": "Enabled",
        "intervalSeconds": 158,
        "timeoutSeconds": 14
      },
      "traces": {
        "mode": "Enabled",
        "cacheSizeMegabytes": 28,
        "selfTracing": {
          "mode": "Enabled",
          "intervalSeconds": 22
        },
        "spanChannelCapacity": 1000
      }
    },
    "diskBackedMessageBuffer": {
      "maxSize": "500M",
      "ephemeralVolumeClaimSpec": {
        "volumeName": "c",
        "volumeMode": "rxvpksjuuugqnqzeiprocknbn",
        "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
        "accessModes": [
          "nuluhigrbb"
        ],
        "dataSource": {
          "apiGroup": "npqapyksvvpkohujx",
          "kind": "wazgyb",
          "name": "cwhsgxxcxsyppoefm"
        },
        "dataSourceRef": {
          "apiGroup": "mnfnykznjjsoqpfsgdqioupt",
          "kind": "odynqzekfzsnawrctaxg",
          "name": "envszivbbmixbyddzg",
          "namespace": "etcfzvxqd"
        },
        "resources": {
          "limits": {
            "key2719": "hmphcrgctu"
          },
          "requests": {
            "key2909": "txocprnyrsgvhfrg"
          }
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "e",
              "operator": "In",
              "values": [
                "slmpajlywqvuyknipgztsonqyybt"
              ]
            }
          ],
          "matchLabels": {
            "key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
          }
        }
      },
      "persistentVolumeClaimSpec": {
        "volumeName": "c",
        "volumeMode": "rxvpksjuuugqnqzeiprocknbn",
        "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
        "accessModes": [
          "nuluhigrbb"
        ],
        "dataSource": {
          "apiGroup": "npqapyksvvpkohujx",
          "kind": "wazgyb",
          "name": "cwhsgxxcxsyppoefm"
        },
        "dataSourceRef": {
          "apiGroup": "mnfnykznjjsoqpfsgdqioupt",
          "kind": "odynqzekfzsnawrctaxg",
          "name": "envszivbbmixbyddzg",
          "namespace": "etcfzvxqd"
        },
        "resources": {
          "limits": {
            "key2719": "hmphcrgctu"
          },
          "requests": {
            "key2909": "txocprnyrsgvhfrg"
          }
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "e",
              "operator": "In",
              "values": [
                "slmpajlywqvuyknipgztsonqyybt"
              ]
            }
          ],
          "matchLabels": {
            "key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
          }
        }
      }
    },
    "generateResourceLimits": {
      "cpu": "Enabled"
    },
    "memoryProfile": "Tiny",
    "highPriorityMessagesBackpressureHandling": "Accept"
  },
  "extendedLocation": {
    "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  }
}

応答のサンプル

状態コード:
200 
{
  "properties": {
    "advanced": {
      "clients": {
        "maxSessionExpirySeconds": 3859,
        "maxMessageExpirySeconds": 3263,
        "maxPacketSizeBytes": 3029,
        "subscriberQueueLimit": {
          "length": 6,
          "strategy": "None"
        },
        "maxReceiveMaximum": 2365,
        "maxKeepAliveSeconds": 3744
      },
      "encryptInternalTraffic": "Enabled",
      "internalCerts": {
        "duration": "bchrc",
        "renewBefore": "xkafmpgjfifkwwrhkswtopdnne",
        "privateKey": {
          "algorithm": "Ec256",
          "rotationPolicy": "Always"
        }
      }
    },
    "cardinality": {
      "backendChain": {
        "partitions": 11,
        "redundancyFactor": 5,
        "workers": 15
      },
      "frontend": {
        "replicas": 2,
        "workers": 6
      }
    },
    "diagnostics": {
      "logs": {
        "level": "rnmwokumdmebpmfxxxzvvjfdywotav"
      },
      "metrics": {
        "prometheusPort": 7581
      },
      "selfCheck": {
        "mode": "Enabled",
        "intervalSeconds": 158,
        "timeoutSeconds": 14
      },
      "traces": {
        "mode": "Enabled",
        "cacheSizeMegabytes": 28,
        "selfTracing": {
          "mode": "Enabled",
          "intervalSeconds": 22
        },
        "spanChannelCapacity": 1000
      }
    },
    "diskBackedMessageBuffer": {
      "maxSize": "500M",
      "ephemeralVolumeClaimSpec": {
        "volumeName": "c",
        "volumeMode": "rxvpksjuuugqnqzeiprocknbn",
        "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
        "accessModes": [
          "nuluhigrbb"
        ],
        "dataSource": {
          "apiGroup": "npqapyksvvpkohujx",
          "kind": "wazgyb",
          "name": "cwhsgxxcxsyppoefm"
        },
        "dataSourceRef": {
          "apiGroup": "mnfnykznjjsoqpfsgdqioupt",
          "kind": "odynqzekfzsnawrctaxg",
          "name": "envszivbbmixbyddzg",
          "namespace": "etcfzvxqd"
        },
        "resources": {
          "limits": {
            "key2719": "hmphcrgctu"
          },
          "requests": {
            "key2909": "txocprnyrsgvhfrg"
          }
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "e",
              "operator": "In",
              "values": [
                "slmpajlywqvuyknipgztsonqyybt"
              ]
            }
          ],
          "matchLabels": {
            "key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
          }
        }
      },
      "persistentVolumeClaimSpec": {
        "volumeName": "c",
        "volumeMode": "rxvpksjuuugqnqzeiprocknbn",
        "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
        "accessModes": [
          "nuluhigrbb"
        ],
        "dataSource": {
          "apiGroup": "npqapyksvvpkohujx",
          "kind": "wazgyb",
          "name": "cwhsgxxcxsyppoefm"
        },
        "dataSourceRef": {
          "apiGroup": "mnfnykznjjsoqpfsgdqioupt",
          "kind": "odynqzekfzsnawrctaxg",
          "name": "envszivbbmixbyddzg",
          "namespace": "etcfzvxqd"
        },
        "resources": {
          "limits": {
            "key2719": "hmphcrgctu"
          },
          "requests": {
            "key2909": "txocprnyrsgvhfrg"
          }
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "e",
              "operator": "In",
              "values": [
                "slmpajlywqvuyknipgztsonqyybt"
              ]
            }
          ],
          "matchLabels": {
            "key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
          }
        }
      }
    },
    "generateResourceLimits": {
      "cpu": "Enabled"
    },
    "memoryProfile": "Tiny",
    "highPriorityMessagesBackpressureHandling": "Accept",
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "dowrkel",
  "type": "Microsoft.IoTOperations/instances/brokers",
  "systemData": {
    "createdBy": "contosouser",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "contosouser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}
状態コード:
201 
Azure-AsyncOperation: https://contoso.com/operationstatus
{
  "properties": {
    "advanced": {
      "clients": {
        "maxSessionExpirySeconds": 3859,
        "maxMessageExpirySeconds": 3263,
        "maxPacketSizeBytes": 3029,
        "subscriberQueueLimit": {
          "length": 6,
          "strategy": "None"
        },
        "maxReceiveMaximum": 2365,
        "maxKeepAliveSeconds": 3744
      },
      "encryptInternalTraffic": "Enabled",
      "internalCerts": {
        "duration": "bchrc",
        "renewBefore": "xkafmpgjfifkwwrhkswtopdnne",
        "privateKey": {
          "algorithm": "Ec256",
          "rotationPolicy": "Always"
        }
      }
    },
    "cardinality": {
      "backendChain": {
        "partitions": 11,
        "redundancyFactor": 5,
        "workers": 15
      },
      "frontend": {
        "replicas": 2,
        "workers": 6
      }
    },
    "diagnostics": {
      "logs": {
        "level": "rnmwokumdmebpmfxxxzvvjfdywotav"
      },
      "metrics": {
        "prometheusPort": 7581
      },
      "selfCheck": {
        "mode": "Enabled",
        "intervalSeconds": 158,
        "timeoutSeconds": 14
      },
      "traces": {
        "mode": "Enabled",
        "cacheSizeMegabytes": 28,
        "selfTracing": {
          "mode": "Enabled",
          "intervalSeconds": 22
        },
        "spanChannelCapacity": 1000
      }
    },
    "diskBackedMessageBuffer": {
      "maxSize": "500M",
      "ephemeralVolumeClaimSpec": {
        "volumeName": "c",
        "volumeMode": "rxvpksjuuugqnqzeiprocknbn",
        "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
        "accessModes": [
          "nuluhigrbb"
        ],
        "dataSource": {
          "apiGroup": "npqapyksvvpkohujx",
          "kind": "wazgyb",
          "name": "cwhsgxxcxsyppoefm"
        },
        "dataSourceRef": {
          "apiGroup": "mnfnykznjjsoqpfsgdqioupt",
          "kind": "odynqzekfzsnawrctaxg",
          "name": "envszivbbmixbyddzg",
          "namespace": "etcfzvxqd"
        },
        "resources": {
          "limits": {
            "key2719": "hmphcrgctu"
          },
          "requests": {
            "key2909": "txocprnyrsgvhfrg"
          }
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "e",
              "operator": "In",
              "values": [
                "slmpajlywqvuyknipgztsonqyybt"
              ]
            }
          ],
          "matchLabels": {
            "key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
          }
        }
      },
      "persistentVolumeClaimSpec": {
        "volumeName": "c",
        "volumeMode": "rxvpksjuuugqnqzeiprocknbn",
        "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
        "accessModes": [
          "nuluhigrbb"
        ],
        "dataSource": {
          "apiGroup": "npqapyksvvpkohujx",
          "kind": "wazgyb",
          "name": "cwhsgxxcxsyppoefm"
        },
        "dataSourceRef": {
          "apiGroup": "mnfnykznjjsoqpfsgdqioupt",
          "kind": "odynqzekfzsnawrctaxg",
          "name": "envszivbbmixbyddzg",
          "namespace": "etcfzvxqd"
        },
        "resources": {
          "limits": {
            "key2719": "hmphcrgctu"
          },
          "requests": {
            "key2909": "txocprnyrsgvhfrg"
          }
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "e",
              "operator": "In",
              "values": [
                "slmpajlywqvuyknipgztsonqyybt"
              ]
            }
          ],
          "matchLabels": {
            "key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
          }
        }
      }
    },
    "generateResourceLimits": {
      "cpu": "Enabled"
    },
    "memoryProfile": "Tiny",
    "highPriorityMessagesBackpressureHandling": "Accept",
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "dowrkel",
  "type": "Microsoft.IoTOperations/instances/brokers",
  "systemData": {
    "createdBy": "contosouser",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "contosouser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

Broker_CreateOrUpdate_Complex

要求のサンプル

PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2026-07-01

{
  "properties": {
    "cardinality": {
      "backendChain": {
        "partitions": 2,
        "redundancyFactor": 2,
        "workers": 2
      },
      "frontend": {
        "replicas": 2,
        "workers": 2
      }
    },
    "diskBackedMessageBuffer": {
      "maxSize": "50M"
    },
    "generateResourceLimits": {
      "cpu": "Enabled"
    },
    "memoryProfile": "Medium"
  },
  "extendedLocation": {
    "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  }
}

応答のサンプル

状態コード:
200 
{
  "properties": {
    "cardinality": {
      "backendChain": {
        "partitions": 2,
        "redundancyFactor": 2,
        "workers": 2
      },
      "frontend": {
        "replicas": 2,
        "workers": 2
      }
    },
    "diskBackedMessageBuffer": {
      "maxSize": "50M"
    },
    "generateResourceLimits": {
      "cpu": "Enabled"
    },
    "memoryProfile": "Medium",
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "llptmlifnqqwairx",
  "type": "Microsoft.IoTOperations/instances/brokers",
  "systemData": {
    "createdBy": "contosouser",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "contosouser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}
状態コード:
201 
Azure-AsyncOperation: https://contoso.com/operationstatus
{
  "properties": {
    "cardinality": {
      "backendChain": {
        "partitions": 2,
        "redundancyFactor": 2,
        "workers": 2
      },
      "frontend": {
        "replicas": 2,
        "workers": 2
      }
    },
    "diskBackedMessageBuffer": {
      "maxSize": "50M"
    },
    "generateResourceLimits": {
      "cpu": "Enabled"
    },
    "memoryProfile": "Medium",
    "provisioningState": "Accepted"
  },
  "extendedLocation": {
    "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "llptmlifnqqwairx",
  "type": "Microsoft.IoTOperations/instances/brokers",
  "systemData": {
    "createdBy": "contosouser",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "contosouser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

Broker_CreateOrUpdate_Minimal

要求のサンプル

PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2026-07-01

{
  "properties": {
    "memoryProfile": "Tiny"
  },
  "extendedLocation": {
    "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  }
}

応答のサンプル

状態コード:
200 
{
  "properties": {
    "advanced": {
      "clients": {
        "maxSessionExpirySeconds": 3859,
        "maxMessageExpirySeconds": 3263,
        "maxPacketSizeBytes": 3029,
        "subscriberQueueLimit": {
          "length": 6,
          "strategy": "None"
        },
        "maxReceiveMaximum": 2365,
        "maxKeepAliveSeconds": 3744
      },
      "encryptInternalTraffic": "Enabled",
      "internalCerts": {
        "duration": "bchrc",
        "renewBefore": "xkafmpgjfifkwwrhkswtopdnne",
        "privateKey": {
          "algorithm": "Ec256",
          "rotationPolicy": "Always"
        }
      }
    },
    "cardinality": {
      "backendChain": {
        "partitions": 11,
        "redundancyFactor": 5,
        "workers": 15
      },
      "frontend": {
        "replicas": 2,
        "workers": 6
      }
    },
    "diagnostics": {
      "logs": {
        "level": "rnmwokumdmebpmfxxxzvvjfdywotav"
      },
      "metrics": {
        "prometheusPort": 7581
      },
      "selfCheck": {
        "mode": "Enabled",
        "intervalSeconds": 158,
        "timeoutSeconds": 14
      },
      "traces": {
        "mode": "Enabled",
        "cacheSizeMegabytes": 28,
        "selfTracing": {
          "mode": "Enabled",
          "intervalSeconds": 22
        },
        "spanChannelCapacity": 1000
      }
    },
    "diskBackedMessageBuffer": {
      "maxSize": "500M",
      "ephemeralVolumeClaimSpec": {
        "volumeName": "c",
        "volumeMode": "rxvpksjuuugqnqzeiprocknbn",
        "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
        "accessModes": [
          "nuluhigrbb"
        ],
        "dataSource": {
          "apiGroup": "npqapyksvvpkohujx",
          "kind": "wazgyb",
          "name": "cwhsgxxcxsyppoefm"
        },
        "dataSourceRef": {
          "apiGroup": "mnfnykznjjsoqpfsgdqioupt",
          "kind": "odynqzekfzsnawrctaxg",
          "name": "envszivbbmixbyddzg",
          "namespace": "etcfzvxqd"
        },
        "resources": {
          "limits": {
            "key2719": "hmphcrgctu"
          },
          "requests": {
            "key2909": "txocprnyrsgvhfrg"
          }
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "e",
              "operator": "In",
              "values": [
                "slmpajlywqvuyknipgztsonqyybt"
              ]
            }
          ],
          "matchLabels": {
            "key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
          }
        }
      },
      "persistentVolumeClaimSpec": {
        "volumeName": "c",
        "volumeMode": "rxvpksjuuugqnqzeiprocknbn",
        "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
        "accessModes": [
          "nuluhigrbb"
        ],
        "dataSource": {
          "apiGroup": "npqapyksvvpkohujx",
          "kind": "wazgyb",
          "name": "cwhsgxxcxsyppoefm"
        },
        "dataSourceRef": {
          "apiGroup": "mnfnykznjjsoqpfsgdqioupt",
          "kind": "odynqzekfzsnawrctaxg",
          "name": "envszivbbmixbyddzg",
          "namespace": "etcfzvxqd"
        },
        "resources": {
          "limits": {
            "key2719": "hmphcrgctu"
          },
          "requests": {
            "key2909": "txocprnyrsgvhfrg"
          }
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "e",
              "operator": "In",
              "values": [
                "slmpajlywqvuyknipgztsonqyybt"
              ]
            }
          ],
          "matchLabels": {
            "key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
          }
        }
      }
    },
    "generateResourceLimits": {
      "cpu": "Enabled"
    },
    "memoryProfile": "Tiny",
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "dowrkel",
  "type": "Microsoft.IoTOperations/instances/brokers",
  "systemData": {
    "createdBy": "contosouser",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "contosouser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}
状態コード:
201 
Azure-AsyncOperation: https://contoso.com/operationstatus
{
  "properties": {
    "advanced": {
      "clients": {
        "maxSessionExpirySeconds": 3859,
        "maxMessageExpirySeconds": 3263,
        "maxPacketSizeBytes": 3029,
        "subscriberQueueLimit": {
          "length": 6,
          "strategy": "None"
        },
        "maxReceiveMaximum": 2365,
        "maxKeepAliveSeconds": 3744
      },
      "encryptInternalTraffic": "Enabled",
      "internalCerts": {
        "duration": "bchrc",
        "renewBefore": "xkafmpgjfifkwwrhkswtopdnne",
        "privateKey": {
          "algorithm": "Ec256",
          "rotationPolicy": "Always"
        }
      }
    },
    "cardinality": {
      "backendChain": {
        "partitions": 11,
        "redundancyFactor": 5,
        "workers": 15
      },
      "frontend": {
        "replicas": 2,
        "workers": 6
      }
    },
    "diagnostics": {
      "logs": {
        "level": "rnmwokumdmebpmfxxxzvvjfdywotav"
      },
      "metrics": {
        "prometheusPort": 7581
      },
      "selfCheck": {
        "mode": "Enabled",
        "intervalSeconds": 158,
        "timeoutSeconds": 14
      },
      "traces": {
        "mode": "Enabled",
        "cacheSizeMegabytes": 28,
        "selfTracing": {
          "mode": "Enabled",
          "intervalSeconds": 22
        },
        "spanChannelCapacity": 1000
      }
    },
    "diskBackedMessageBuffer": {
      "maxSize": "500M",
      "ephemeralVolumeClaimSpec": {
        "volumeName": "c",
        "volumeMode": "rxvpksjuuugqnqzeiprocknbn",
        "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
        "accessModes": [
          "nuluhigrbb"
        ],
        "dataSource": {
          "apiGroup": "npqapyksvvpkohujx",
          "kind": "wazgyb",
          "name": "cwhsgxxcxsyppoefm"
        },
        "dataSourceRef": {
          "apiGroup": "mnfnykznjjsoqpfsgdqioupt",
          "kind": "odynqzekfzsnawrctaxg",
          "name": "envszivbbmixbyddzg",
          "namespace": "etcfzvxqd"
        },
        "resources": {
          "limits": {
            "key2719": "hmphcrgctu"
          },
          "requests": {
            "key2909": "txocprnyrsgvhfrg"
          }
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "e",
              "operator": "In",
              "values": [
                "slmpajlywqvuyknipgztsonqyybt"
              ]
            }
          ],
          "matchLabels": {
            "key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
          }
        }
      },
      "persistentVolumeClaimSpec": {
        "volumeName": "c",
        "volumeMode": "rxvpksjuuugqnqzeiprocknbn",
        "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
        "accessModes": [
          "nuluhigrbb"
        ],
        "dataSource": {
          "apiGroup": "npqapyksvvpkohujx",
          "kind": "wazgyb",
          "name": "cwhsgxxcxsyppoefm"
        },
        "dataSourceRef": {
          "apiGroup": "mnfnykznjjsoqpfsgdqioupt",
          "kind": "odynqzekfzsnawrctaxg",
          "name": "envszivbbmixbyddzg",
          "namespace": "etcfzvxqd"
        },
        "resources": {
          "limits": {
            "key2719": "hmphcrgctu"
          },
          "requests": {
            "key2909": "txocprnyrsgvhfrg"
          }
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "e",
              "operator": "In",
              "values": [
                "slmpajlywqvuyknipgztsonqyybt"
              ]
            }
          ],
          "matchLabels": {
            "key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
          }
        }
      }
    },
    "generateResourceLimits": {
      "cpu": "Enabled"
    },
    "memoryProfile": "Tiny",
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "dowrkel",
  "type": "Microsoft.IoTOperations/instances/brokers",
  "systemData": {
    "createdBy": "contosouser",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "contosouser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

Broker_CreateOrUpdate_Simple

要求のサンプル

PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2026-07-01

{
  "properties": {
    "cardinality": {
      "backendChain": {
        "partitions": 2,
        "redundancyFactor": 2,
        "workers": 2
      },
      "frontend": {
        "replicas": 2,
        "workers": 2
      }
    },
    "generateResourceLimits": {
      "cpu": "Enabled"
    },
    "memoryProfile": "Low"
  },
  "extendedLocation": {
    "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  }
}

応答のサンプル

状態コード:
200 
{
  "properties": {
    "advanced": {
      "clients": {
        "maxSessionExpirySeconds": 3859,
        "maxMessageExpirySeconds": 3263,
        "maxPacketSizeBytes": 3029,
        "subscriberQueueLimit": {
          "length": 6,
          "strategy": "None"
        },
        "maxReceiveMaximum": 2365,
        "maxKeepAliveSeconds": 3744
      },
      "encryptInternalTraffic": "Enabled",
      "internalCerts": {
        "duration": "bchrc",
        "renewBefore": "xkafmpgjfifkwwrhkswtopdnne",
        "privateKey": {
          "algorithm": "Ec256",
          "rotationPolicy": "Always"
        }
      }
    },
    "cardinality": {
      "backendChain": {
        "partitions": 11,
        "redundancyFactor": 5,
        "workers": 15
      },
      "frontend": {
        "replicas": 2,
        "workers": 6
      }
    },
    "diagnostics": {
      "logs": {
        "level": "rnmwokumdmebpmfxxxzvvjfdywotav"
      },
      "metrics": {
        "prometheusPort": 7581
      },
      "selfCheck": {
        "mode": "Enabled",
        "intervalSeconds": 158,
        "timeoutSeconds": 14
      },
      "traces": {
        "mode": "Enabled",
        "cacheSizeMegabytes": 28,
        "selfTracing": {
          "mode": "Enabled",
          "intervalSeconds": 22
        },
        "spanChannelCapacity": 1000
      }
    },
    "diskBackedMessageBuffer": {
      "maxSize": "500M",
      "ephemeralVolumeClaimSpec": {
        "volumeName": "c",
        "volumeMode": "rxvpksjuuugqnqzeiprocknbn",
        "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
        "accessModes": [
          "nuluhigrbb"
        ],
        "dataSource": {
          "apiGroup": "npqapyksvvpkohujx",
          "kind": "wazgyb",
          "name": "cwhsgxxcxsyppoefm"
        },
        "dataSourceRef": {
          "apiGroup": "mnfnykznjjsoqpfsgdqioupt",
          "kind": "odynqzekfzsnawrctaxg",
          "name": "envszivbbmixbyddzg",
          "namespace": "etcfzvxqd"
        },
        "resources": {
          "limits": {
            "key2719": "hmphcrgctu"
          },
          "requests": {
            "key2909": "txocprnyrsgvhfrg"
          }
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "e",
              "operator": "In",
              "values": [
                "slmpajlywqvuyknipgztsonqyybt"
              ]
            }
          ],
          "matchLabels": {
            "key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
          }
        }
      },
      "persistentVolumeClaimSpec": {
        "volumeName": "c",
        "volumeMode": "rxvpksjuuugqnqzeiprocknbn",
        "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
        "accessModes": [
          "nuluhigrbb"
        ],
        "dataSource": {
          "apiGroup": "npqapyksvvpkohujx",
          "kind": "wazgyb",
          "name": "cwhsgxxcxsyppoefm"
        },
        "dataSourceRef": {
          "apiGroup": "mnfnykznjjsoqpfsgdqioupt",
          "kind": "odynqzekfzsnawrctaxg",
          "name": "envszivbbmixbyddzg",
          "namespace": "etcfzvxqd"
        },
        "resources": {
          "limits": {
            "key2719": "hmphcrgctu"
          },
          "requests": {
            "key2909": "txocprnyrsgvhfrg"
          }
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "e",
              "operator": "In",
              "values": [
                "slmpajlywqvuyknipgztsonqyybt"
              ]
            }
          ],
          "matchLabels": {
            "key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
          }
        }
      }
    },
    "generateResourceLimits": {
      "cpu": "Enabled"
    },
    "memoryProfile": "Tiny",
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "dowrkel",
  "type": "Microsoft.IoTOperations/instances/brokers",
  "systemData": {
    "createdBy": "contosouser",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "contosouser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}
状態コード:
201 
Azure-AsyncOperation: https://contoso.com/operationstatus
{
  "properties": {
    "advanced": {
      "clients": {
        "maxSessionExpirySeconds": 3859,
        "maxMessageExpirySeconds": 3263,
        "maxPacketSizeBytes": 3029,
        "subscriberQueueLimit": {
          "length": 6,
          "strategy": "None"
        },
        "maxReceiveMaximum": 2365,
        "maxKeepAliveSeconds": 3744
      },
      "encryptInternalTraffic": "Enabled",
      "internalCerts": {
        "duration": "bchrc",
        "renewBefore": "xkafmpgjfifkwwrhkswtopdnne",
        "privateKey": {
          "algorithm": "Ec256",
          "rotationPolicy": "Always"
        }
      }
    },
    "cardinality": {
      "backendChain": {
        "partitions": 11,
        "redundancyFactor": 5,
        "workers": 15
      },
      "frontend": {
        "replicas": 2,
        "workers": 6
      }
    },
    "diagnostics": {
      "logs": {
        "level": "rnmwokumdmebpmfxxxzvvjfdywotav"
      },
      "metrics": {
        "prometheusPort": 7581
      },
      "selfCheck": {
        "mode": "Enabled",
        "intervalSeconds": 158,
        "timeoutSeconds": 14
      },
      "traces": {
        "mode": "Enabled",
        "cacheSizeMegabytes": 28,
        "selfTracing": {
          "mode": "Enabled",
          "intervalSeconds": 22
        },
        "spanChannelCapacity": 1000
      }
    },
    "diskBackedMessageBuffer": {
      "maxSize": "500M",
      "ephemeralVolumeClaimSpec": {
        "volumeName": "c",
        "volumeMode": "rxvpksjuuugqnqzeiprocknbn",
        "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
        "accessModes": [
          "nuluhigrbb"
        ],
        "dataSource": {
          "apiGroup": "npqapyksvvpkohujx",
          "kind": "wazgyb",
          "name": "cwhsgxxcxsyppoefm"
        },
        "dataSourceRef": {
          "apiGroup": "mnfnykznjjsoqpfsgdqioupt",
          "kind": "odynqzekfzsnawrctaxg",
          "name": "envszivbbmixbyddzg",
          "namespace": "etcfzvxqd"
        },
        "resources": {
          "limits": {
            "key2719": "hmphcrgctu"
          },
          "requests": {
            "key2909": "txocprnyrsgvhfrg"
          }
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "e",
              "operator": "In",
              "values": [
                "slmpajlywqvuyknipgztsonqyybt"
              ]
            }
          ],
          "matchLabels": {
            "key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
          }
        }
      },
      "persistentVolumeClaimSpec": {
        "volumeName": "c",
        "volumeMode": "rxvpksjuuugqnqzeiprocknbn",
        "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
        "accessModes": [
          "nuluhigrbb"
        ],
        "dataSource": {
          "apiGroup": "npqapyksvvpkohujx",
          "kind": "wazgyb",
          "name": "cwhsgxxcxsyppoefm"
        },
        "dataSourceRef": {
          "apiGroup": "mnfnykznjjsoqpfsgdqioupt",
          "kind": "odynqzekfzsnawrctaxg",
          "name": "envszivbbmixbyddzg",
          "namespace": "etcfzvxqd"
        },
        "resources": {
          "limits": {
            "key2719": "hmphcrgctu"
          },
          "requests": {
            "key2909": "txocprnyrsgvhfrg"
          }
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "e",
              "operator": "In",
              "values": [
                "slmpajlywqvuyknipgztsonqyybt"
              ]
            }
          ],
          "matchLabels": {
            "key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
          }
        }
      }
    },
    "generateResourceLimits": {
      "cpu": "Enabled"
    },
    "memoryProfile": "Tiny",
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "dowrkel",
  "type": "Microsoft.IoTOperations/instances/brokers",
  "systemData": {
    "createdBy": "contosouser",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "contosouser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

定義

名前 説明
AdvancedSettings

Broker の詳細設定
BackendChain

ブローカーのバックエンド インスタンスの必要なプロパティ
BrokerDiagnostics

Broker 診断設定のプロパティ
BrokerMemoryProfile

ブローカーのメモリ プロファイル設定
BrokerPersistence

ディスク永続性の設定。

永続性が有効になっている場合、永続性のために選択された特定の項目 (パフォーマンスに重要ではないデータ) はディスク上にのみ存在します。 影響を受けるアイテムは次のとおりです。

  • 保持されたメッセージはディスクにのみ保存されます。
  • WILLメッセージはディスクにのみ保存されます。
  • DSS キーと値のペアは、パフォーマンスを向上させるためにディスクとメモリの両方に残る時間ロックなどのパフォーマンスが重要な項目を除き、ディスクにのみ保存されます。

Optional. 設定されていない場合、すべてはメモリ内にあります。 注: 構成されている場合、すべての MQTT セッション状態がディスクに書き込まれます。
BrokerPersistenceEncryption

Broker Persistence Encryption プロパティ。
BrokerPersistencePolicyMode

ブローカー永続性ポリシーモードの値。
BrokerProperties

Broker リソースのプロパティ
BrokerResource

インスタンス ブローカー リソース
BrokerRetainMessagesCustomPolicy

Custom Broker のメッセージ保持ポリシー。
BrokerRetainMessagesDynamic

BrokerRetainMessagesCustomPolicy の動的設定。
BrokerRetainMessagesSettings

ブローカーのメッセージ保持プロパティ。
BrokerStateStoreCustomPolicy

ブローカー状態ストアのカスタムポリシー。
BrokerStateStoreDynamic

BrokerStateStoreCustomPolicy の動的設定。
BrokerStateStoreKeyType

Broker State Store Key Type プロパティ。
BrokerStateStorePolicyResources

Broker State Store ポリシーリソースのプロパティ。
BrokerStateStorePolicySettings

ブローカー状態ストアのカスタムポリシー設定。
BrokerStatus

BrokerStatusの状態。
BrokerSubscriberQueueCustomPolicy

カスタムサブスクライバキューポリシーのプロパティ。
BrokerSubscriberQueueCustomPolicySettings

ブローカー サブスクライバ キュー カスタム ポリシーのプロパティ。
BrokerSubscriberQueueDynamic

BrokerSubscriberQueueCustomPolicy の動的設定。
Cardinality

カーディナリティプロパティ
CertManagerCertOptions

Cert Manager の証明書のプロパティ
CertManagerPrivateKey

Cert Manager の秘密キーのプロパティ
ClientConfig

クライアント構成の設定。
createdByType

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

診断ログのプロパティ
DiskBackedMessageBuffer

DiskBackedMessageBuffer プロパティ
ErrorAdditionalInfo

リソース管理エラーの追加情報
ErrorDetail

エラーの詳細。
ErrorResponse

エラー応答
ExtendedLocation

拡張された場所は、Azure の場所の拡張機能です。 Azure ARC 対応 Kubernetes クラスターを、Azure サービス インスタンスをデプロイするためのターゲットの場所として使用する方法を提供します。
ExtendedLocationType

ExtendedLocation の型を定義する列挙型が受け入れられます。
Frontend

ブローカーのフロントエンド インスタンスの必要なプロパティ
GenerateResourceLimits

GenerateResourceLimits プロパティ
HighPriorityMessagesBackpressureHandling

バックプレッシャー状態中の高優先度メッセージの処理。
KubernetesReference

Kubernetes リファレンス
LocalKubernetesReference

Kubernetes リファレンス
Metrics

診断メトリックのプロパティ
OperationalMode

Mode プロパティ
OperatorValues

有効な演算子は In、NotIn、Exists、DoesNotExist です。
PrivateKeyAlgorithm

秘密キー アルゴリズムの種類。
PrivateKeyRotationPolicy

秘密キーローテーション ポリシー。
ProvisioningState

リソースの状態を定義する列挙型。
ResourceHealthState

リソースの正常性状態。
ResourceHealthStatus

資源の健康状態を表します。
SelfCheck

Broker Diagnostic Self Check プロパティ
SelfTracing

診断自己トレースのプロパティ
SubscriberMessageDropStrategy

サブスクライバー キューからメッセージを削除するための列挙型定義戦略。
SubscriberQueueLimit

サブスクライバー キューの制限の設定。
systemData

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

Broker 診断トレースのプロパティ
VolumeClaimResourceRequirements

VolumeClaimResourceRequirements プロパティ
VolumeClaimResourceRequirementsClaims

VolumeClaimResourceRequirementsClaims プロパティ。
VolumeClaimSpec

VolumeClaimSpec プロパティ
VolumeClaimSpecSelector

VolumeClaimSpecSelector プロパティ
VolumeClaimSpecSelectorMatchExpressions

VolumeClaimSpecSelectorMatchExpressions プロパティ

AdvancedSettings

Object

Broker の詳細設定

名前 型 規定値 説明
clients

ClientConfig

すべてのクライアントに関連する構成。
encryptInternalTraffic

OperationalMode

Enabled

内部トラフィックの暗号化を有効または無効にする設定。
internalCerts

CertManagerCertOptions

証明書のローテーションと秘密キーの構成。

BackendChain

Object

ブローカーのバックエンド インスタンスの必要なプロパティ

名前 型 規定値 説明
partitions

integer (int32)

minimum: 1
maximum: 16

物理バックエンド パーティションの必要な数。
redundancyFactor

integer (int32)

minimum: 1
maximum: 5

物理パーティション内のバックエンド レプリカ (ポッド) の必要な数。
workers

integer (int32)

minimum: 1
maximum: 16 		1

レプリカ (ポッド) あたりの論理バックエンド ワーカーの数。

BrokerDiagnostics

Object

Broker 診断設定のプロパティ

名前 型 説明
logs

DiagnosticsLogs

リソースの診断ログ設定。
metrics

Metrics

リソースのメトリック設定。
selfCheck

SelfCheck

自己チェックのプロパティ。
traces

Traces

トレースのプロパティ。

BrokerMemoryProfile

列挙

ブローカーのメモリ プロファイル設定

値 説明
Tiny

小さなメモリプロファイル。
Low

メモリプロファイルが少ない。
Medium

中程度のメモリプロファイル。
High

高いメモリプロファイル。

BrokerPersistence

Object

ディスク永続性の設定。

永続性が有効になっている場合、永続性のために選択された特定の項目 (パフォーマンスに重要ではないデータ) はディスク上にのみ存在します。 影響を受けるアイテムは次のとおりです。

  • 保持されたメッセージはディスクにのみ保存されます。
  • WILLメッセージはディスクにのみ保存されます。
  • DSS キーと値のペアは、パフォーマンスを向上させるためにディスクとメモリの両方に残る時間ロックなどのパフォーマンスが重要な項目を除き、ディスクにのみ保存されます。

Optional. 設定されていない場合、すべてはメモリ内にあります。 注: 構成されている場合、すべての MQTT セッション状態がディスクに書き込まれます。

名前 型 説明
encryption

BrokerPersistenceEncryption

永続性データベースの暗号化に関連する設定を制御します。 オプションで、デフォルトで暗号化が有効になります。
maxSize

string

ディスク上のメッセージ バッファーの最大サイズ。 PVC テンプレートが persistentVolumeClaimSpec を使用して指定されている場合、このサイズは、そのテンプレートの要求および制限サイズとして使用されます。 PVC テンプレートが指定されていない場合は、このサイズ制限でローカル パス プロビジョナーが要求されます。 Required.
persistentVolumeClaimSpec

VolumeClaimSpec

指定した永続ボリューム要求テンプレートを使用して、永続ボリュームをマウントします。 diskBackedMessageBufferと同じオブジェクトですが、accessモードフィールドをReadWriteOncePodに設定しなければならないという制限があります。

設定されていない場合は、デフォルトのプロパティを持つデフォルトのPVCが使用されます。 このPVCはクラスタのデフォルトstorageクラスを使用しますが、ローカルパスプロビジョナーを使用している場合もあればそうでない場合もあります。 ユーザーがこの設定を残したりstorageクラスフィールドを置かずに設定し、クラスタのデフォルトがローカルパスクラスでない場合、最適でない動作をオプトインしていると言えます。
retain BrokerRetainMessagesPolicy:

BrokerRetainMessagesCustomPolicy

どのトピックの保持メッセージをディスクに保持するかを制御します。
stateStore BrokerStateStorePolicy:

BrokerStateStoreCustomPolicy

状態ストアのディスクに保持するキーを制御します。
subscriberQueue BrokerSubscriberQueuePolicy:

BrokerSubscriberQueueCustomPolicy

ディスクに永続化するサブスクライバ・メッセージ・キューを制御します。 重要: 再接続を容易にするために、このセクションが設定されていない場合でも、永続化設定が指定されている場合、セッション状態メタデータは常にディスクに書き込まれます。

BrokerPersistenceEncryption

Object

Broker Persistence Encryption プロパティ。

名前 型 説明
mode

OperationalMode

暗号化が有効になっているかどうかを決定します。

BrokerPersistencePolicyMode

列挙

ブローカー永続性ポリシーモードの値。

値 説明
All

すべてのポリシー モード。
None

None のポリシー モード。
Custom

ポリシーがカスタム・ポリシーであることを示します。

BrokerProperties

Object

Broker リソースのプロパティ

名前 型 規定値 説明
advanced

AdvancedSettings

Broker の詳細設定。
cardinality

Cardinality

ブローカーのカーディナリティの詳細。
diagnostics

BrokerDiagnostics

Spec は、Broker 診断設定の目的の ID を定義します。
diskBackedMessageBuffer

DiskBackedMessageBuffer

ディスク バックアップ メッセージ バッファーの設定。
generateResourceLimits

GenerateResourceLimits

この設定では、Kubernetes CPU リソースの制限を要求するかどうかを制御します。 レプリカまたはワーカーの数を増やすと、要求された CPU リソースの量が比例して増加します。 この設定が有効になっていて、CPU リソースが不足している場合は、エラーが生成されます。
healthState

ResourceHealthState

Unknown

リソースの正常性状態。
highPriorityMessagesBackpressureHandling

HighPriorityMessagesBackpressureHandling

通常の優先度メッセージがバックプレッシャーされている場合の高優先度メッセージの処理。

「受け入れ」に設定されている場合、ブローカーは通常の優先度メッセージがバックプレッシャーで拒否されるにもかかわらず、高優先度のメッセージを引き続き受け入れます。

「拒否」に設定すると、高優先度メッセージにもバックプレッシャーが影響します。

デフォルトは「受け入れ」となります。
memoryProfile

BrokerMemoryProfile

Medium

Broker のメモリ プロファイル。
persistence

BrokerPersistence

ブローカーの永続性設定。
provisioningState

ProvisioningState

最後の操作の状態。
status

BrokerStatus

ブローカーの状況。

BrokerResource

Object

インスタンス ブローカー リソース

名前 型 説明
extendedLocation

ExtendedLocation

リソースのエッジの場所。
id

string (arm-id)

リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

リソースの名前
properties

BrokerProperties

このリソースのリソース固有のプロパティ。
systemData

systemData

createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type

string

リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

BrokerRetainMessagesCustomPolicy

Object

Custom Broker のメッセージ保持ポリシー。

名前 型 説明
mode string:

Custom

「All」はすべての保持メッセージを永続化し、「None」は何も保持せず、「Custom」は指定されたトピックのみを保持します。
retainSettings

BrokerRetainMessagesSettings

ポリシーの設定。

BrokerRetainMessagesDynamic

Object

BrokerRetainMessagesCustomPolicy の動的設定。

名前 型 説明
mode

OperationalMode

BrokerRetainMessagesCustomPolicy のモード。

BrokerRetainMessagesSettings

Object

ブローカーのメッセージ保持プロパティ。

名前 型 説明
dynamic

BrokerRetainMessagesDynamic

MQTT クライアントがユーザー・プロパティーを介してディスク・パーシスタンスを要求できるかどうかを制御 MQTTv5 。 他のグループ(論理OR)に加えて機能します。
topics

string[]

保持されたメッセージがディスクに永続化されるトピックのリスト。 ワイルドカード # と + がサポートされています。

BrokerStateStoreCustomPolicy

Object

ブローカー状態ストアのカスタムポリシー。

名前 型 説明
mode string:

Custom

すべてのキーを永続化するには 'All'、指定したキーのみを永続化するには 'None'、指定されたキーのみを永続化するには 'Custom'。
stateStoreSettings

BrokerStateStorePolicySettings

ポリシーの設定。

BrokerStateStoreDynamic

Object

BrokerStateStoreCustomPolicy の動的設定。

名前 型 説明
mode

OperationalMode

BrokerStateStoreCustomPolicy のモード。

BrokerStateStoreKeyType

列挙

Broker State Store Key Type プロパティ。

値 説明
Pattern

グロブスタイルのパターンマッチングに使用されます。
String

たとえば、キーにパターン (*、?、[0-9]) として一致する可能性のある文字が含まれている場合など、完全一致を行うために使用されます。
Binary

バイナリキーの照合に使用します。

BrokerStateStorePolicyResources

Object

Broker State Store ポリシーリソースのプロパティ。

名前 型 説明
keyType

BrokerStateStoreKeyType

ディスクに永続化するためのキー。
keys

string[]

ディスクに保持するキーのリスト (必須)。

BrokerStateStorePolicySettings

Object

ブローカー状態ストアのカスタムポリシー設定。

名前 型 説明
dynamic

BrokerStateStoreDynamic

MQTT クライアントがユーザー・プロパティーを介してディスク・パーシスタンスを要求できるかどうかを制御 MQTTv5 。 他のグループ(論理OR)に加えて機能します。
stateStoreResources

BrokerStateStorePolicyResources[]

ディスクに保持するキーとキーの種類のリスト。

BrokerStatus

Object

BrokerStatusの状態。

名前 型 説明
healthState

ResourceHealthStatus

ブローカーの健康状態。

BrokerSubscriberQueueCustomPolicy

Object

カスタムサブスクライバキューポリシーのプロパティ。

名前 型 説明
mode string:

Custom

すべてのサブスクライバキューを永続化するには「All」、指定したキューのみを永続化するには「None」、指定されたキューのみを永続化するには「Custom」です。
subscriberQueueSettings

BrokerSubscriberQueueCustomPolicySettings

カスタムポリシー (モードが カスタム の場合に必要)。 すべてのグループのサブスクライバキューは、ディスクに永続化されます(論理OR)。

BrokerSubscriberQueueCustomPolicySettings

Object

ブローカー サブスクライバ キュー カスタム ポリシーのプロパティ。

名前 型 説明
dynamic

BrokerSubscriberQueueDynamic

MQTT クライアントがユーザー・プロパティーを介してディスク・パーシスタンスを要求できるかどうかを制御 MQTTv5 。 他のグループ(論理OR)に加えて機能します。
subscriberClientIds

string[]

サブスクライバーのクライアントIDのリスト、ワイルドカード*がサポートされています。

BrokerSubscriberQueueDynamic

Object

BrokerSubscriberQueueCustomPolicy の動的設定。

名前 型 説明
mode

OperationalMode

BrokerSubscriberQueueCustomPolicy のモード。

Cardinality

Object

カーディナリティプロパティ

名前 型 説明
backendChain

BackendChain

バックエンド ブローカーの必要なプロパティ
frontend

Frontend

フロントエンドの必要なプロパティ

CertManagerCertOptions

Object

Cert Manager の証明書のプロパティ

名前 型 説明
duration

string

証明書の有効期間。 Go 時間を使用して指定する必要があります。期間の形式 (h|m|s)。 たとえば、240 時間は 240 時間、45 分は 45m です。
privateKey

CertManagerPrivateKey

証明書秘密キーの構成。
renewBefore

string

証明書の更新を開始するタイミング。 Go 時間を使用して指定する必要があります。期間の形式 (h|m|s)。 たとえば、240 時間は 240 時間、45 分は 45m です。

CertManagerPrivateKey

Object

Cert Manager の秘密キーのプロパティ

名前 型 説明
algorithm

PrivateKeyAlgorithm

秘密キーのアルゴリズム。
rotationPolicy

PrivateKeyRotationPolicy

cert-manager 秘密キー rotationPolicy。

ClientConfig

Object

クライアント構成の設定。

名前 型 説明
maxKeepAliveSeconds

integer (int32)

minimum: 0
maximum: 65535

クライアントのキープ アライブの上限 (秒単位)。
maxMessageExpirySeconds

integer (int32)

minimum: 1

メッセージの有効期限間隔の上限 (秒単位)。
maxPacketSizeBytes

integer (int32)

minimum: 1
maximum: 268435456

パケットの最大メッセージ サイズ (バイト単位)。
maxReceiveMaximum

integer (int32)

minimum: 1
maximum: 65535

クライアントが CONNECT パケットで要求できる受信最大値の上限。
maxSessionExpirySeconds

integer (int32)

minimum: 1

セッションの有効期限間隔の上限 (秒単位)。
subscriberQueueLimit

SubscriberQueueLimit

サブスクライバーのキューに登録されたメッセージの数の制限。

createdByType

列挙

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

値 説明
User
Application
ManagedIdentity
Key

DiagnosticsLogs

Object

診断ログのプロパティ

名前 型 規定値 説明
level

string

info

ログ レベル。 例 - 'debug'、'info'、'warn'、'error'、'trace'。

DiskBackedMessageBuffer

Object

DiskBackedMessageBuffer プロパティ

名前 型 説明
ephemeralVolumeClaimSpec

VolumeClaimSpec

指定した永続ボリューム要求テンプレートを使用して、メッセージ バッファーの "汎用エフェメラル ボリューム" をマウントします。 詳細については、https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes を参照してください。
maxSize

string

pattern: ^[0-9]+[KMGTPE]$

ディスク上のメッセージ バッファーの最大サイズ。 ephemeralVolumeClaimSpec または persistentVolumeClaimSpec のいずれかを使用して PVC テンプレートを指定した場合、このサイズはそのテンプレートの要求および制限サイズとして使用されます。 ephemeralVolumeClaimSpec も persistentVolumeClaimSpec も指定されていない場合は、このサイズを制限として emptyDir ボリュームがマウントされます。 詳細については、https://kubernetes.io/docs/concepts/storage/volumes/#emptydir を参照してください。
persistentVolumeClaimSpec

VolumeClaimSpec

指定した永続ボリューム要求テンプレートを使用して、メッセージ バッファーの永続ボリュームをマウントします。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーに関する追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細。
message

string

エラー メッセージ。
target

string

エラーの対象。

ErrorResponse

Object

エラー応答

名前 型 説明
error

ErrorDetail

エラー オブジェクト。

ExtendedLocation

Object

拡張された場所は、Azure の場所の拡張機能です。 Azure ARC 対応 Kubernetes クラスターを、Azure サービス インスタンスをデプロイするためのターゲットの場所として使用する方法を提供します。

名前 型 説明
name

string

拡張された場所の名前。
type

ExtendedLocationType

ExtendedLocation の種類。

ExtendedLocationType

列挙

ExtendedLocation の型を定義する列挙型が受け入れられます。

値 説明
CustomLocation

CustomLocation タイプ

Frontend

Object

ブローカーのフロントエンド インスタンスの必要なプロパティ

名前 型 規定値 説明
replicas

integer (int32)

minimum: 1
maximum: 16

フロントエンド インスタンス (ポッド) の目的の数。
workers

integer (int32)

minimum: 1
maximum: 16 		2

インスタンス (ポッド) あたりの論理フロントエンド ワーカーの数。

GenerateResourceLimits

Object

GenerateResourceLimits プロパティ

名前 型 規定値 説明
cpu

OperationalMode

Enabled

CPU リソースの制限を有効または無効にする切り替え。

HighPriorityMessagesBackpressureHandling

列挙

バックプレッシャー状態中の高優先度メッセージの処理。

値 説明
Accept

ブローカーがバックプレッシャーのために通常優先度のメッセージを拒否しても、高優先度のメッセージは引き続き受け入れます。
Reject

ブローカーがバックプレッシャーのために通常の優先度メッセージを拒否すると、高優先度のメッセージも拒否します。

KubernetesReference

Object

Kubernetes リファレンス

名前 型 説明
apiGroup

string

APIGroup は、参照されるリソースのグループです。 APIGroup が指定されていない場合は、指定された Kind がコア API グループに含まれている必要があります。 その他のサード パーティの種類の場合は、APIGroup が必要です。
kind

string

種類は、参照されるリソースの種類です
name

string

Name は、参照されているリソースの名前です
namespace

string

名前空間は、参照されているリソースの名前空間です。 このフィールドは、リソースに名前空間がある場合に必要です。

LocalKubernetesReference

Object

Kubernetes リファレンス

名前 型 説明
apiGroup

string

APIGroup は、参照されるリソースのグループです。 APIGroup が指定されていない場合は、指定された Kind がコア API グループに含まれている必要があります。 その他のサード パーティの種類の場合は、APIGroup が必要です。
kind

string

種類は、参照されるリソースの種類です
name

string

Name は、参照されているリソースの名前です

Metrics

Object

診断メトリックのプロパティ

名前 型 規定値 説明
prometheusPort

integer (int32)

minimum: 0
maximum: 65535 		9600

メトリックを公開する prometheus ポート。

OperationalMode

列挙

Mode プロパティ

値 説明
Enabled

有効はTrueと同等です
Disabled

Disabled は False と同等です。

OperatorValues

列挙

有効な演算子は In、NotIn、Exists、DoesNotExist です。

値 説明
In

In 演算子。
NotIn

NotIn 演算子。
Exists

Exists 演算子。
DoesNotExist

DoesNotExist 演算子。

PrivateKeyAlgorithm

列挙

秘密キー アルゴリズムの種類。

値 説明
Ec256

アルゴリズム - ec256。
Ec384

アルゴリズム - ec384。
Ec521

アルゴリズム - ec521。
Ed25519

アルゴリズム - ed25519。
Rsa2048

アルゴリズム - rsa2048。
Rsa4096

アルゴリズム - rsa4096。
Rsa8192

アルゴリズム - rsa8192。

PrivateKeyRotationPolicy

列挙

秘密キーローテーション ポリシー。

値 説明
Always

ローテーションポリシー - 常に。
Never

ローテーションポリシー - なし。

ProvisioningState

列挙

リソースの状態を定義する列挙型。

値 説明
Succeeded

リソースが作成されました。
Failed

リソースの作成に失敗しました。
Canceled

リソースの作成が取り消されました。
Provisioning

リソースがプロビジョニングされています。
Updating

リソースが更新中です。
Deleting

リソースが削除中です。
Accepted

リソースが受け入れられました。

ResourceHealthState

列挙

リソースの正常性状態。

値 説明
Available

リソースは使用可能で、期待どおりに機能しています。
Degraded

リソースの正常性が低下します。
Unavailable

リソースが期待どおりに機能していません。
Unknown

リソースの状態は不明です。

ResourceHealthStatus

Object

資源の健康状態を表します。

名前 型 説明
lastTransitionTime

string

健康状態が最後に変わったタイムスタンプ(RFC3339)です。
lastUpdateTime

string

健康状態が最後に更新されたタイムスタンプ(RFC3339)は、たとえ状態が変わっていなくてもです。
message

string

最後の移行を説明する人間が読めるメッセージです。
reasonCode

string

最後の健康状態移行の原因を説明するユニークなCamelCase理由コード。
status

ResourceHealthState

資源の高レベルの健康状態。

SelfCheck

Object

Broker Diagnostic Self Check プロパティ

名前 型 規定値 説明
intervalSeconds

integer (int32)

minimum: 30
maximum: 300 		30

自己チェック間隔。
mode

OperationalMode

Enabled

自己チェックを有効または無効にする切り替え。
timeoutSeconds

integer (int32)

minimum: 5
maximum: 120 		15

自己チェックのタイムアウト。

SelfTracing

Object

診断自己トレースのプロパティ

名前 型 規定値 説明
intervalSeconds

integer (int32)

minimum: 1
maximum: 300 		30

自己トレース間隔。
mode

OperationalMode

Enabled

自己トレースを有効または無効にする切り替え。

SubscriberMessageDropStrategy

列挙

サブスクライバー キューからメッセージを削除するための列挙型定義戦略。

値 説明
None

メッセージがドロップされることはありません。
DropOldest

最も古いメッセージがドロップされます。

SubscriberQueueLimit

Object

サブスクライバー キューの制限の設定。

名前 型 規定値 説明
length

integer (int64)

minimum: 1

メッセージが削除され始める前のキューの最大長。
strategy

SubscriberMessageDropStrategy

None

キューからのメッセージの削除に使用する戦略。

systemData

Object

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

名前 型 説明
createdAt

string (date-time)

リソース作成のタイムスタンプ (UTC)。
createdBy

string

リソースを作成した ID。
createdByType

createdByType

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

string (date-time)

リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy

string

リソースを最後に変更した ID。
lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。

Traces

Object

Broker 診断トレースのプロパティ

名前 型 規定値 説明
cacheSizeMegabytes

integer (int32)

minimum: 1
maximum: 128 		16

キャッシュ サイズ (メガバイト単位)。
mode

OperationalMode

Enabled

トレースを有効または無効にする切り替え。
selfTracing

SelfTracing

自己トレースプロパティ。
spanChannelCapacity

integer (int32)

minimum: 1000
maximum: 100000 		1000

スパン チャネルの容量。

VolumeClaimResourceRequirements

Object

VolumeClaimResourceRequirements プロパティ

名前 型 説明
claims

VolumeClaimResourceRequirementsClaims[]

Claims には、spec.resourceClaims で定義されている、このコンテナーで使用されるリソースの名前が一覧表示されます。

これはアルファ フィールドであり、DynamicResourceAllocation 機能ゲートを有効にする必要があります。

このフィールドは不変です。 コンテナに対してのみ設定できます。
limits

object

制限は、許可されるコンピューティング リソースの最大量を示します。 詳細情報: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
requests

object

要求では、必要なコンピューティング リソースの最小量が記述されます。 コンテナーに対して要求を省略すると、明示的に指定されている場合は既定で Limits に、それ以外の場合は実装定義値になります。 詳細情報: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

VolumeClaimResourceRequirementsClaims

Object

VolumeClaimResourceRequirementsClaims プロパティ。

名前 型 説明
name

string

リソースの名前。 これは、spec.resourceClaims のリソースの名前と一致する必要があります。

VolumeClaimSpec

Object

VolumeClaimSpec プロパティ

名前 型 説明
accessModes

string[]

AccessModesは、ボリュームが持つべき望ましいaccessモードを含みます。 詳細情報: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
dataSource

LocalKubernetesReference

このフィールドは以下のいずれかを指定するために使用できます:* 既存のVolumeSnapshotオブジェクト(snapshot.storage.k8s.io/VolumeSnapshot) * 既存のPVC(PersistentVolumeClaim) プロビジョナーや外部コントローラーが指定されたデータソースをサポートできる場合、指定されたデータソースの内容に基づいて新しいボリュームを作成します。 AnyVolumeDataSource 機能ゲートが有効になっている場合、このフィールドの内容は DataSourceRef フィールドと常に同じです。
dataSourceRef

KubernetesReference

空でないボリュームが必要な場合に、ボリュームにデータを取り込むオブジェクトを指定します。 空でない API グループ (コア 以外のオブジェクト) または PersistentVolumeClaim オブジェクトのローカル オブジェクトを指定できます。 このフィールドを指定すると、指定したオブジェクトの種類が、インストールされているボリューム 設定または動的プロビジョンタと一致する場合にのみ、ボリューム バインドが成功します。 このフィールドは DataSource フィールドの機能を置き換えます。両方のフィールドが空でない場合は、同じ値を持つ必要があります。 下位互換性のために、両方のフィールド (DataSource と DataSourceRef) は、いずれかのフィールドが空で、もう一方が空でない場合は、自動的に同じ値に設定されます。 DataSource と DataSourceRef には 2 つの重要な違いがあります。* DataSource では 2 つの特定の種類のオブジェクトのみが許可されますが、DataSourceRef では非コア オブジェクトと PersistentVolumeClaim オブジェクトが許可されます。 * DataSource は許可されていない値を無視する (削除する) 間、DataSourceRef はすべての値を保持し、許可されていない値が指定されている場合はエラーを生成します。 (ベータ)このフィールドを使用するには、AnyVolumeDataSource 機能ゲートを有効にする必要があります。
resources

VolumeClaimResourceRequirements

リソースは、ボリュームに必要な最小リソースを表します。 RecoverVolumeExpansionFailure 機能が有効になっている場合、ユーザーは以前の値より低いリソース要件を指定できますが、要求の状態フィールドに記録された容量よりも高い必要があります。 詳細情報: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
selector

VolumeClaimSpecSelector

バインドを検討するボリュームに対するラベル クエリ。
storageClassName

string

要求に必要な StorageClass の名前。 詳細情報: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
volumeMode

string

volumeMode は、要求に必要なボリュームの種類を定義します。 要求仕様に含まれていない場合、ファイルシステムの値は暗黙的に指定されます。これはベータ機能です。
volumeName

string

VolumeName は、この要求をバックアップする PersistentVolume へのバインディング参照です。

VolumeClaimSpecSelector

Object

VolumeClaimSpecSelector プロパティ

名前 型 説明
matchExpressions

VolumeClaimSpecSelectorMatchExpressions[]

MatchExpressions は、ラベル セレクターの要件の一覧です。 要件は ANDed です。
matchLabels

object

MatchLabels は、{key,value} ペアのマップです。 matchLabels マップ内の 1 つの {key,value} は matchExpressions の要素と同じです。この要素のキー フィールドは "key"、演算子は "In" で、値配列には "value" のみが含まれます。 要件は ANDed です。

VolumeClaimSpecSelectorMatchExpressions

Object

VolumeClaimSpecSelectorMatchExpressions プロパティ

名前 型 説明
key

string

キーは、セレクターが適用されるラベル キーです。
operator

OperatorValues

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

string[]

values は文字列値の配列です。 演算子が In または NotIn の場合、値の配列は空でない必要があります。 演算子が Exists または DoesNotExist の場合、値の配列は空である必要があります。 この配列は、戦略的マージ パッチ中に置き換えられます。