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

Broker - Create Or Update

参考

服务:: IoT Operations

API 版本:: 2025-04-01

创建 BrokerResource

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}?api-version=2025-04-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	True	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-04-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": "qmbrfwcpwwhggszhrdjv",
    "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": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "dowrkel",
  "type": "xshjnsdgadygb",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "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": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "dowrkel",
  "type": "xshjnsdgadygb",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "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-04-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": "qmbrfwcpwwhggszhrdjv",
    "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": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "llptmlifnqqwairx",
  "type": "qwrfzxjfxvismlqvigot",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "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": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "llptmlifnqqwairx",
  "type": "qwrfzxjfxvismlqvigot",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "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-04-01

{
  "properties": {
    "memoryProfile": "Tiny"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "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": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "dowrkel",
  "type": "xshjnsdgadygb",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "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": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "dowrkel",
  "type": "xshjnsdgadygb",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "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-04-01

{
  "properties": {
    "cardinality": {
      "backendChain": {
        "partitions": 2,
        "redundancyFactor": 2,
        "workers": 2
      },
      "frontend": {
        "replicas": 2,
        "workers": 2
      }
    },
    "generateResourceLimits": {
      "cpu": "Enabled"
    },
    "memoryProfile": "Low"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "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": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "dowrkel",
  "type": "xshjnsdgadygb",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "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": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "dowrkel",
  "type": "xshjnsdgadygb",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

定义

名称	说明
AdvancedSettings	中转站高级设置
BackendChain	中转站后端实例的所需属性
BrokerDiagnostics	Broker 诊断设置属性
BrokerMemoryProfile	Broker 的内存配置文件设置
BrokerProperties	Broker 资源属性
BrokerResource	实例代理资源
Cardinality	基数属性
CertManagerCertOptions	证书管理器证书属性
CertManagerPrivateKey	证书管理器私钥属性
ClientConfig	客户端配置的设置。
createdByType	创建资源的标识的类型。
DiagnosticsLogs	诊断日志属性
DiskBackedMessageBuffer	DiskBackedMessageBuffer 属性
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ExtendedLocation	扩展位置是 Azure 位置的扩展。他们提供了一种使用已启用 Azure ARC 的 Kubernetes 群集作为部署 Azure 服务实例的目标位置的方法。
ExtendedLocationType	已接受 ExtendedLocation 的枚举类型。
Frontend	Broker 前端实例的所需属性
GenerateResourceLimits	GenerateResourceLimits 属性
KubernetesReference	Kubernetes 参考
LocalKubernetesReference	Kubernetes 参考
Metrics	诊断指标属性
OperationalMode	模式属性
OperatorValues	有效运算符为 In、NotIn、Exists 和 DoesNotExist。
PrivateKeyAlgorithm	私钥算法类型。
PrivateKeyRotationPolicy	私钥轮换策略。
ProvisioningState	定义资源状态的枚举。
SelfCheck	中转站诊断自我检查属性
SelfTracing	诊断自我跟踪属性
SubscriberMessageDropStrategy	用于从订阅服务器队列中删除消息的枚举策略。
SubscriberQueueLimit	订阅服务器队列限制的设置。
systemData	与创建和上次修改资源相关的元数据。
Traces	Broker 诊断跟踪属性
VolumeClaimResourceRequirements	VolumeClaimResourceRequirements 属性
VolumeClaimSpec	VolumeClaimSpec 属性
VolumeClaimSpecSelector	VolumeClaimSpecSelector 属性
VolumeClaimSpecSelectorMatchExpressions	VolumeClaimSpecSelectorMatchExpressions 属性

AdvancedSettings

Object

中转站高级设置

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

BackendChain

Object

中转站后端实例的所需属性

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

Object

Broker 诊断设置属性

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

BrokerMemoryProfile

枚举

Broker 的内存配置文件设置

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

BrokerProperties

Object

Broker 资源属性

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

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 资源管理器元数据。
type	string	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

Cardinality

Object

基数属性

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

CertManagerCertOptions

Object

证书管理器证书属性

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

CertManagerPrivateKey

Object

证书管理器私钥属性

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

ClientConfig

Object

客户端配置的设置。

名称	类型	说明
maxKeepAliveSeconds	integer (int32) minimum: 0 maximum: 65535	客户端“保持活动状态”的上限（以秒为单位）。
maxMessageExpirySeconds	integer (int32) minimum: 1 maximum: 4294967295	消息过期间隔上限（以秒为单位）。
maxPacketSizeBytes	integer (int32) minimum: 1 maximum: 268435456	数据包的最大消息大小（以字节为单位）。
maxReceiveMaximum	integer (int32) minimum: 1 maximum: 65535	客户端可以在 CONNECT 数据包中请求的接收最大值上限。
maxSessionExpirySeconds	integer (int32) minimum: 1 maximum: 4294967295	会话到期间隔上限（以秒为单位）。
subscriberQueueLimit	SubscriberQueueLimit	订阅服务器排队消息数的限制。

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

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 模板，则此大小将用作该模板的请求和限制大小。如果既未指定临时VolumeClaimSpec，也没有指定 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

Broker 前端实例的所需属性

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

GenerateResourceLimits

Object

GenerateResourceLimits 属性

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

KubernetesReference

Object

Kubernetes 参考

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

LocalKubernetesReference

Object

Kubernetes 参考

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

Metrics

Object

诊断指标属性

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

OperationalMode

枚举

模式属性

值	说明
Disabled	Disabled 等效于 False。
Enabled	Enabled 等效于 True

OperatorValues

枚举

有效运算符为 In、NotIn、Exists 和 DoesNotExist。

值	说明
DoesNotExist	DoesNotExist 运算符。
Exists	Exists 运算符。
In	In 运算符。
NotIn	NotIn 运算符。

PrivateKeyAlgorithm

枚举

私钥算法类型。

值	说明
Ec256	算法 - ec256。
Ec384	算法 - ec384。
Ec521	算法 - ec521。
Ed25519	算法 - ed25519。
Rsa2048	算法 - rsa2048。
Rsa4096	算法 - rsa4096。
Rsa8192	算法 - rsa8192。

PrivateKeyRotationPolicy

枚举

私钥轮换策略。

值	说明
Always	轮换策略 - 始终。
Never	轮换策略 - 从不。

ProvisioningState

枚举

定义资源状态的枚举。

值	说明
Accepted	资源已被接受。
Canceled	资源创建已取消。
Deleting	资源正在删除。
Failed	资源创建失败。
Provisioning	正在预配资源。
Succeeded	已创建资源。
Updating	资源正在更新。

SelfCheck

Object

中转站诊断自我检查属性

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

枚举

用于从订阅服务器队列中删除消息的枚举策略。

值	说明
DropOldest	删除最早的消息。
None	永远不会删除消息。

SubscriberQueueLimit

Object

订阅服务器队列限制的设置。

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

systemData

Object

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

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

Traces

Object

Broker 诊断跟踪属性

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

VolumeClaimResourceRequirements

Object

VolumeClaimResourceRequirements 属性

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

VolumeClaimSpec

Object

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

Object

VolumeClaimSpecSelector 属性

名称	类型	说明
matchExpressions	VolumeClaimSpecSelectorMatchExpressions[]	MatchExpressions 是标签选择器要求的列表。要求是 ANDed。
matchLabels	object	MatchLabels 是 {key，value} 对的映射。 matchLabels 映射中的单个 {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，则值数组必须为空。此数组在战略合并修补期间被替换。

通过

Broker - Create Or Update

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

Broker_CreateOrUpdate

示例请求

示例响应

Broker_CreateOrUpdate_Complex

示例请求

示例响应

Broker_CreateOrUpdate_Minimal

示例请求

示例响应

Broker_CreateOrUpdate_Simple

示例请求

示例响应

定义

AdvancedSettings

BackendChain

BrokerDiagnostics

BrokerMemoryProfile

BrokerProperties

BrokerResource

Cardinality

CertManagerCertOptions

CertManagerPrivateKey

ClientConfig

createdByType

DiagnosticsLogs

DiskBackedMessageBuffer

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedLocation

ExtendedLocationType

Frontend

GenerateResourceLimits

KubernetesReference

LocalKubernetesReference

Metrics

OperationalMode

OperatorValues

PrivateKeyAlgorithm

PrivateKeyRotationPolicy

ProvisioningState

SelfCheck

SelfTracing

SubscriberMessageDropStrategy

SubscriberQueueLimit

systemData

Traces

VolumeClaimResourceRequirements

VolumeClaimSpec

VolumeClaimSpecSelector

VolumeClaimSpecSelectorMatchExpressions

其他资源