你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Broker - Create Or Update

服务:: IoT Operations

API 版本:: 2025-10-01

创建 BrokerResource

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}?api-version=2025-10-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	意外的错误响应。

名称

类型

说明

200 OK

BrokerResource

资源“BrokerResource”更新作成功

201 Created

BrokerResource

资源“BrokerResource”创建作成功

标头

Azure-AsyncOperation: string
Retry-After: integer

Other Status Codes

ErrorResponse

意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Broker_CreateOrUpdate

Broker_CreateOrUpdate_Complex

Broker_CreateOrUpdate_Minimal

Broker_CreateOrUpdate_Simple

Broker_CreateOrUpdate

示例请求

HTTP

PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2025-10-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"
  },
  "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_Complex

示例请求

HTTP

PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2025-10-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

示例请求

HTTP

PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2025-10-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

示例请求

HTTP

PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2025-10-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	经纪人高级设置
BackendChain	代理后端实例的所需属性
BrokerDiagnostics	代理诊断设置属性
BrokerMemoryProfile	代理的内存配置文件设置
BrokerPersistence	磁盘持久性配置。启用持久性后，选择用于持久性的某些项（非性能关键数据）将仅驻留在磁盘上。以下是受影响的项目：保留的邮件将仅存储在磁盘上。 WILL 消息将仅存储在磁盘上。 DSS 键/值对将仅存储在磁盘上，但性能关键项（如定时锁）除外，这些项保留在磁盘和内存中以提高性能。可选。如果未设置，则所有内容都在内存中。注意：如果配置，则所有 MQTT 会话状态都将写入磁盘。
BrokerPersistenceEncryption	代理持久性加密属性。
BrokerPersistencePolicyMode	代理持久性策略模式值。
BrokerProperties	代理资源属性
BrokerResource	实例代理资源
BrokerRetainMessagesCustomPolicy	Custom Broker 保留消息策略。
BrokerRetainMessagesDynamic	BrokerRetainMessagesCustomPolicy 的动态设置。
BrokerRetainMessagesSettings	代理保留消息属性。
BrokerStateStoreCustomPolicy	代理状态存储自定义策略。
BrokerStateStoreDynamic	BrokerStateStoreCustomPolicy 的动态设置。
BrokerStateStoreKeyType	代理状态存储密钥类型属性。
BrokerStateStorePolicyResources	Broker State Store 策略资源属性。
BrokerStateStorePolicySettings	代理状态存储自定义策略设置。
BrokerSubscriberQueueCustomPolicy	自定义订阅者队列策略属性。
BrokerSubscriberQueueCustomPolicySettings	代理订阅者队列自定义策略属性。
BrokerSubscriberQueueDynamic	BrokerSubscriberQueueCustomPolicy 的动态设置。
Cardinality	基数属性
CertManagerCertOptions	证书管理器证书属性
CertManagerPrivateKey	Cert Manager 私钥属性
ClientConfig	客户端配置的设置。
createdByType	创建资源的标识的类型。
DiagnosticsLogs	诊断日志属性
DiskBackedMessageBuffer	DiskBackedMessageBuffer 属性
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ExtendedLocation	扩展位置是 Azure 位置的扩展。它们提供了一种使用已启用 Azure ARC 的 Kubernetes 群集作为部署 Azure 服务实例的目标位置的方法。
ExtendedLocationType	接受的枚举定义 ExtendedLocation 类型。
Frontend	代理前端实例的所需属性
GenerateResourceLimits	GenerateResourceLimits 属性
KubernetesReference	Kubernetes 参考
LocalKubernetesReference	Kubernetes 参考
Metrics	诊断指标属性
OperationalMode	模式属性
OperatorValues	有效运算符为 In、NotIn、Exists 和 DoesNotExist。
PrivateKeyAlgorithm	私钥算法类型。
PrivateKeyRotationPolicy	私钥轮换策略。
ProvisioningState	枚举定义资源的状态。
ResourceHealthState	资源的运行状况。
SelfCheck	代理诊断自检属性
SelfTracing	诊断自跟踪属性
SubscriberMessageDropStrategy	枚举定义了从订阅者队列中删除消息的策略。
SubscriberQueueLimit	订阅者队列限制的设置。
systemData	与创建和上次修改资源相关的元数据。
Traces	代理诊断跟踪属性
VolumeClaimResourceRequirements	VolumeClaimResourceRequirements 属性
VolumeClaimResourceRequirementsClaims	VolumeClaimResourceRequirementsClaims 属性。
VolumeClaimSpec	VolumeClaimSpec 属性
VolumeClaimSpecSelector	VolumeClaimSpecSelector 属性
VolumeClaimSpecSelectorMatchExpressions	VolumeClaimSpecSelectorMatchExpressions 属性

AdvancedSettings

对象

经纪人高级设置

名称	类型	默认值	说明
clients	ClientConfig		与所有客户端相关的配置。
encryptInternalTraffic	OperationalMode	Enabled	启用或禁用内部流量加密的设置。
internalCerts	CertManagerCertOptions		证书轮换和私钥配置。

BackendChain

对象

代理后端实例的所需属性

名称	类型	默认值	说明
partitions	integer (int32) minimum: 1 maximum: 16		所需的物理后端分区数。
redundancyFactor	integer (int32) minimum: 1 maximum: 5		物理分区中所需的后端副本数（Pod）。
workers	integer (int32) minimum: 1 maximum: 16	1	每个副本（Pod）的逻辑后端辅助角色数。

BrokerDiagnostics

对象

代理诊断设置属性

名称	类型	说明
logs	DiagnosticsLogs	资源的诊断日志设置。
metrics	Metrics	资源的指标设置。
selfCheck	SelfCheck	自检查属性。
traces	Traces	跟踪属性。

BrokerMemoryProfile

枚举

代理的内存配置文件设置

值	说明
Tiny	微小的内存配置文件。
Low	低内存配置文件。
Medium	中等内存配置文件。
High	高内存配置文件。

BrokerPersistence

对象

磁盘持久性配置。

启用持久性后，选择用于持久性的某些项（非性能关键数据）将仅驻留在磁盘上。以下是受影响的项目：

保留的邮件将仅存储在磁盘上。
WILL 消息将仅存储在磁盘上。
DSS 键/值对将仅存储在磁盘上，但性能关键项（如定时锁）除外，这些项保留在磁盘和内存中以提高性能。

可选。如果未设置，则所有内容都在内存中。注意：如果配置，则所有 MQTT 会话状态都将写入磁盘。

名称	类型	说明
encryption	BrokerPersistenceEncryption	控制与持久性数据库加密相关的设置。可选，默认启用加密。
maxSize	string	磁盘上消息缓冲区的最大大小。如果使用 persistentVolumeClaimSpec 指定 PVC 模板，则此大小将用作该模板的请求和限制大小。如果未指定 PVC 模板，则请求具有此大小限制的本地路径预配程序。必填。
persistentVolumeClaimSpec	VolumeClaimSpec	使用指定的持久卷声明模板装载持久卷。与 diskBackedMessageBuffer 中的对象相同，但有一个限制，即访问模式字段必须设置为 `ReadWriteOncePod`。如果未设置，将使用具有默认属性的默认 PVC。除其他外，此 PVC 将使用集群默认存储类，该类可能使用也可能不使用本地路径配置程序。如果用户未设置此设置或在没有存储类字段的情况下设置它，并且其集群默认值不是本地路径类，则用户选择加入次优行为。
retain	BrokerRetainMessagesPolicy: BrokerRetainMessagesCustomPolicy	控制应将哪个主题的保留消息保存到磁盘。
stateStore	BrokerStateStorePolicy: BrokerStateStoreCustomPolicy	控制应将哪些键保存到状态存储的磁盘。
subscriberQueue	BrokerSubscriberQueuePolicy: BrokerSubscriberQueueCustomPolicy	控制哪些订阅者消息队列应持久保存到磁盘。重要提示：为了便于重新连接，如果指定了任何持久性设置，会话状态元数据始终写入磁盘，即使未设置此部分也是如此。

BrokerPersistenceEncryption

对象

代理持久性加密属性。

名称	类型	说明
mode	OperationalMode	确定是否启用了加密。

BrokerPersistencePolicyMode

枚举

代理持久性策略模式值。

值	说明
All	“全部”策略模式。
None	策略模式为“无”。
Custom	指示策略是自定义策略。

BrokerProperties

对象

代理资源属性

名称	类型	默认值	说明
advanced	AdvancedSettings		Broker 的高级设置。
cardinality	Cardinality		中转站的基数详细信息。
diagnostics	BrokerDiagnostics		规范定义中转站诊断设置的所需标识。
diskBackedMessageBuffer	DiskBackedMessageBuffer		磁盘支持的消息缓冲区的设置。
generateResourceLimits	GenerateResourceLimits		此设置控制是否请求 Kubernetes CPU 资源限制。增加副本或辅助角色的数量会相应地增加请求的 CPU 资源量。如果启用此设置并且 CPU 资源不足，则会发出错误。
healthState	ResourceHealthState	Unknown	资源的运行状况。
memoryProfile	BrokerMemoryProfile	Medium	Broker 的内存配置文件。
persistence	BrokerPersistence		代理的持久性设置。
provisioningState	ProvisioningState		上次操作的状态。

BrokerResource

对象

实例代理资源

名称	类型	说明
extendedLocation	ExtendedLocation	资源的边缘位置。
id	string (arm-id)	资源的完全限定资源 ID。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties	BrokerProperties	此资源的资源特定属性。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源类型。例如，“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

BrokerRetainMessagesCustomPolicy

对象

Custom Broker 保留消息策略。

名称	类型	说明
mode	string: Custom	“All”保留所有保留消息，“None”不保留任何消息，“Custom”仅保留指定的主题。
retainSettings	BrokerRetainMessagesSettings	策略的设置。

BrokerRetainMessagesDynamic

对象

BrokerRetainMessagesCustomPolicy 的动态设置。

名称	类型	说明
mode	OperationalMode	BrokerRetainMessagesCustomPolicy 的模式。

BrokerRetainMessagesSettings

对象

代理保留消息属性。

名称	类型	说明
dynamic	BrokerRetainMessagesDynamic	控制 MQTT 客户端是否可以通过用户属性请求 `MQTTv5` 磁盘持久性。与其他组（逻辑 OR）一起工作。
topics	string[]	保留消息将持久化到磁盘的主题列表。支持通配符 # 和 +。

BrokerStateStoreCustomPolicy

对象

代理状态存储自定义策略。

名称	类型	说明
mode	string: Custom	'All' 持久化所有键，'None' 不持久化任何键，'Custom' 仅持久化指定的键。
stateStoreSettings	BrokerStateStorePolicySettings	策略的设置。

BrokerStateStoreDynamic

对象

BrokerStateStoreCustomPolicy 的动态设置。

名称	类型	说明
mode	OperationalMode	BrokerStateStoreCustomPolicy 的模式。

BrokerStateStoreKeyType

枚举

代理状态存储密钥类型属性。

值	说明
Pattern	用于球形样式图案匹配。
String	用于执行精确匹配，例如，当键包含可能匹配为模式（*，？， [0-9]）的字符时。
Binary	用于匹配二进制键。

BrokerStateStorePolicyResources

对象

Broker State Store 策略资源属性。

名称	类型	说明
keyType	BrokerStateStoreKeyType	要持久化到磁盘的密钥。
keys	string[]	要保留到磁盘的密钥列表，必填。

BrokerStateStorePolicySettings

对象

代理状态存储自定义策略设置。

名称	类型	说明
dynamic	BrokerStateStoreDynamic	控制 MQTT 客户端是否可以通过用户属性请求 `MQTTv5` 磁盘持久性。与其他组（逻辑 OR）一起工作。
stateStoreResources	BrokerStateStorePolicyResources[]	要保留到磁盘的密钥和密钥类型的列表。

BrokerSubscriberQueueCustomPolicy

对象

自定义订阅者队列策略属性。

名称	类型	说明
mode	string: Custom	'All' 保留所有订阅者队列，'None' 不保留任何队列，'Custom' 仅保留指定的队列。
subscriberQueueSettings	BrokerSubscriberQueueCustomPolicySettings	自定义策略，如果模式为自定义，则为必填项。所有组中的订阅者队列都保留到磁盘（逻辑 OR）。

BrokerSubscriberQueueCustomPolicySettings

对象

代理订阅者队列自定义策略属性。

名称	类型	说明
dynamic	BrokerSubscriberQueueDynamic	控制 MQTT 客户端是否可以通过用户属性请求 `MQTTv5` 磁盘持久性。与其他组（逻辑 OR）一起工作。
subscriberClientIds	string[]	订阅者的客户端 ID 列表，支持通配符 *。

BrokerSubscriberQueueDynamic

对象

BrokerSubscriberQueueCustomPolicy 的动态设置。

名称	类型	说明
mode	OperationalMode	BrokerSubscriberQueueCustomPolicy 的模式。

Cardinality

对象

基数属性

名称	类型	说明
backendChain	BackendChain	后端中转站所需的属性
frontend	Frontend	前端所需属性

CertManagerCertOptions

对象

证书管理器证书属性

名称	类型	说明
duration	string	证书的生存期。必须使用 Go 时间指定。持续时间格式（h\|m\|s）。例如 240 小时 240 小时 45 米，45 分钟。
privateKey	CertManagerPrivateKey	证书私钥的配置。
renewBefore	string	何时开始续订证书。必须使用 Go 时间指定。持续时间格式（h\|m\|s）。例如 240 小时 240 小时 45 米，45 分钟。

CertManagerPrivateKey

对象

Cert Manager 私钥属性

名称	类型	说明
algorithm	PrivateKeyAlgorithm	私钥的算法。
rotationPolicy	PrivateKeyRotationPolicy	cert-manager 私钥 rotationPolicy。

ClientConfig

对象

客户端配置的设置。

名称	类型	说明
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

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

DiagnosticsLogs

对象

诊断日志属性

名称	类型	默认值	说明
level	string	info	日志级别。示例 - “debug”、“info”、“warn”、“error”、“trace”。

DiskBackedMessageBuffer

对象

DiskBackedMessageBuffer 属性

名称	类型	说明
ephemeralVolumeClaimSpec	VolumeClaimSpec	使用指定的永久性卷声明模板为消息缓冲区装载“泛型临时卷”。有关详细信息，请参阅 https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes。
maxSize	string pattern: ^[0-9]+[KMGTPE]$	磁盘上消息缓冲区的最大大小。如果使用 ephemeralVolumeClaimSpec 或 persistentVolumeClaimSpec 之一指定 PVC 模板，则此大小将用作该模板的请求和限制大小。如果既未指定临时VolumeClaimSpec，也没有指定 persistentVolumeClaimSpec，则以此大小作为其限制装载 emptyDir 卷。有关详细信息，请参阅 https://kubernetes.io/docs/concepts/storage/volumes/#emptydir。
persistentVolumeClaimSpec	VolumeClaimSpec	使用指定的永久性卷声明模板为消息缓冲区装载永久性卷。

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

对象

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

对象

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ExtendedLocation

对象

扩展位置是 Azure 位置的扩展。它们提供了一种使用已启用 Azure ARC 的 Kubernetes 群集作为部署 Azure 服务实例的目标位置的方法。

名称	类型	说明
name	string	扩展位置的名称。
type	ExtendedLocationType	ExtendedLocation 的类型。

ExtendedLocationType

枚举

接受的枚举定义 ExtendedLocation 类型。

值	说明
CustomLocation	CustomLocation 类型

Frontend

对象

代理前端实例的所需属性

名称	类型	默认值	说明
replicas	integer (int32) minimum: 1 maximum: 16		所需的前端实例数（Pod）。
workers	integer (int32) minimum: 1 maximum: 16	2	每个实例（Pod）的逻辑前端辅助角色数。

GenerateResourceLimits

对象

GenerateResourceLimits 属性

名称	类型	默认值	说明
cpu	OperationalMode	Enabled	用于启用/禁用 CPU 资源限制的开关。

KubernetesReference

对象

Kubernetes 参考

名称	类型	说明
apiGroup	string	APIGroup 是所引用资源的组。如果未指定 APIGroup，则指定的 Kind 必须位于核心 API 组中。对于任何其他第三方类型，需要 APIGroup。
kind	string	类型是所引用的资源类型
name	string	名称是所引用的资源的名称
namespace	string	命名空间是所引用资源的命名空间。当资源具有命名空间时，此字段是必需的。

LocalKubernetesReference

对象

Kubernetes 参考

名称	类型	说明
apiGroup	string	APIGroup 是所引用资源的组。如果未指定 APIGroup，则指定的 Kind 必须位于核心 API 组中。对于任何其他第三方类型，需要 APIGroup。
kind	string	类型是所引用的资源类型
name	string	名称是所引用的资源的名称

Metrics

对象

诊断指标属性

名称	类型	默认值	说明
prometheusPort	integer (int32) minimum: 0 maximum: 65535	9600	用于公开指标的 prometheus 端口。

OperationalMode

枚举

模式属性

值	说明
Enabled	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	资源状态未知。

SelfCheck

对象

代理诊断自检属性

名称	类型	默认值	说明
intervalSeconds	integer (int32) minimum: 30 maximum: 300	30	自我检查间隔。
mode	OperationalMode	Enabled	用于启用/禁用自我检查的开关。
timeoutSeconds	integer (int32) minimum: 5 maximum: 120	15	自我检查的超时。

SelfTracing

对象

诊断自跟踪属性

名称	类型	默认值	说明
intervalSeconds	integer (int32) minimum: 1 maximum: 300	30	自我跟踪间隔。
mode	OperationalMode	Enabled	用于启用/禁用自我跟踪的开关。

SubscriberMessageDropStrategy

枚举

枚举定义了从订阅者队列中删除消息的策略。

值	说明
None	消息永远不会被丢弃。
DropOldest	删除最旧的消息。

SubscriberQueueLimit

对象

订阅者队列限制的设置。

名称	类型	默认值	说明
length	integer (int64) minimum: 1		消息开始删除之前队列的最大长度。
strategy	SubscriberMessageDropStrategy	None	用于从队列中删除消息的策略。

systemData

对象

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

Traces

对象

代理诊断跟踪属性

名称	类型	默认值	说明
cacheSizeMegabytes	integer (int32) minimum: 1 maximum: 128	16	缓存大小（以 MB 为单位）。
mode	OperationalMode	Enabled	用于启用/禁用跟踪的开关。
selfTracing	SelfTracing		自我跟踪属性。
spanChannelCapacity	integer (int32) minimum: 1000 maximum: 100000	1000	范围通道容量。

VolumeClaimResourceRequirements

对象

VolumeClaimResourceRequirements 属性

名称

类型

说明

claims

VolumeClaimResourceRequirementsClaims[]

Claims 列出了此容器使用的 spec.resourceClaims 中定义的资源的名称。

这是一个 alpha 字段，需要启用 DynamicResourceAllocation 功能门控。

此字段是不可变的。它只能为容器设置。

limits

object

限制描述允许的最大计算资源量。详细信息：https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

object

请求描述所需的最小计算资源量。如果为容器省略请求，则默认为“限制”（如果显式指定）否则为实现定义的值。详细信息：https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

VolumeClaimResourceRequirementsClaims

对象

VolumeClaimResourceRequirementsClaims 属性。

名称	类型	说明
name	string	资源的名称。这必须与 spec.resourceClaims 中的资源名称匹配。

VolumeClaimSpec

对象

VolumeClaimSpec 属性

名称	类型	说明
accessModes	string[]	AccessModes 包含卷应具有的所需访问模式。详细信息：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 之间存在两个重要差异：* 虽然 DataSource 只允许两种特定类型的对象，但 DataSourceRef 允许任何非核心对象，以及 PersistentVolumeClaim 对象。 * 虽然 DataSource 忽略不允许的值（删除它们），但 DataSourceRef 会保留所有值，并在指定不允许的值时生成错误。（Beta）使用此字段需要启用 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 定义声明所需的卷类型。声明规范中未包含时，将隐含文件系统的值。这是一项 beta 功能。
volumeName	string	VolumeName 是对支持此声明的 PersistentVolume 的绑定引用。

VolumeClaimSpecSelector

对象

VolumeClaimSpecSelector 属性

名称	类型	说明
matchExpressions	VolumeClaimSpecSelectorMatchExpressions[]	MatchExpressions 是标签选择器要求的列表。要求是 ANDed。
matchLabels	object	MatchLabels 是 {key，value} 对的映射。 matchLabels 映射中的单个 {key，value} 等效于 matchExpressions 的元素，其键字段为“key”，运算符为“In”，值数组仅包含“value”。要求是 ANDed。

VolumeClaimSpecSelectorMatchExpressions

对象

VolumeClaimSpecSelectorMatchExpressions 属性

名称	类型	说明
key	string	键是选择器应用于的标签键。
operator	OperatorValues	运算符表示键与一组值的关系。有效运算符为 In、NotIn、Exists 和 DoesNotExist。
values	string[]	values 是字符串值的数组。如果运算符为 In 或 NotIn，则值数组必须为非空。如果运算符为 Exists 或 DoesNotExist，则值数组必须为空。此数组在战略合并修补期间被替换。

通过

Broker - Create Or Update

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

Broker_CreateOrUpdate

示例请求

示例响应

Broker_CreateOrUpdate_Complex

示例请求

示例响应

Broker_CreateOrUpdate_Minimal

示例请求

示例响应

Broker_CreateOrUpdate_Simple

示例请求

示例响应

定义

AdvancedSettings

BackendChain

BrokerDiagnostics

BrokerMemoryProfile

BrokerPersistence

BrokerPersistenceEncryption

BrokerPersistencePolicyMode

BrokerProperties

BrokerResource

BrokerRetainMessagesCustomPolicy

BrokerRetainMessagesDynamic

BrokerRetainMessagesSettings

BrokerStateStoreCustomPolicy

BrokerStateStoreDynamic

BrokerStateStoreKeyType

BrokerStateStorePolicyResources

BrokerStateStorePolicySettings

BrokerSubscriberQueueCustomPolicy

BrokerSubscriberQueueCustomPolicySettings

BrokerSubscriberQueueDynamic

Cardinality

CertManagerCertOptions

CertManagerPrivateKey

ClientConfig

createdByType

DiagnosticsLogs

DiskBackedMessageBuffer

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedLocation

ExtendedLocationType

Frontend

GenerateResourceLimits

KubernetesReference

LocalKubernetesReference

Metrics

OperationalMode

OperatorValues

PrivateKeyAlgorithm

PrivateKeyRotationPolicy

ProvisioningState

ResourceHealthState

SelfCheck

SelfTracing

SubscriberMessageDropStrategy

SubscriberQueueLimit

systemData

Traces

VolumeClaimResourceRequirements

VolumeClaimResourceRequirementsClaims

VolumeClaimSpec

VolumeClaimSpecSelector

VolumeClaimSpecSelectorMatchExpressions