Broker - Create Or Update
Een BrokerResource maken
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}?api-version=2026-07-01
URI-parameters
| Name | In | Vereist | Type | Description |
|---|---|---|---|---|
|
broker
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$ |
Naam van broker. |
|
instance
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$ |
Naam van exemplaar. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
De naam van de resource group. De naam is hoofdletterongevoelig. |
|
subscription
|
path | True |
string (uuid) |
De ID van het doelabonnement. De waarde moet een UUID zijn. |
|
api-version
|
query | True |
string minLength: 1 |
De API-versie die voor deze bewerking moet worden gebruikt. |
Aanvraagbody
| Name | Type | Description |
|---|---|---|
| extendedLocation |
Edge-locatie van de resource. |
|
| properties |
De resourcespecifieke eigenschappen voor deze resource. |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 200 OK |
De updatebewerking van Resource 'BrokerResource' is geslaagd |
|
| 201 Created |
Resource 'BrokerResource' create bewerking geslaagd Kopteksten
|
|
| Other Status Codes |
Een onverwachte foutreactie. |
Beveiliging
azure_auth
OAuth2-stroom voor Azure Active Directory.
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
| Name | Description |
|---|---|
| user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
|
Broker_Create |
|
Broker_Create |
|
Broker_Create |
|
Broker_Create |
Broker_CreateOrUpdate
Voorbeeldaanvraag
PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2026-07-01
{
"properties": {
"advanced": {
"clients": {
"maxSessionExpirySeconds": 3859,
"maxMessageExpirySeconds": 3263,
"maxPacketSizeBytes": 3029,
"subscriberQueueLimit": {
"length": 6,
"strategy": "None"
},
"maxReceiveMaximum": 2365,
"maxKeepAliveSeconds": 3744
},
"encryptInternalTraffic": "Enabled",
"internalCerts": {
"duration": "bchrc",
"renewBefore": "xkafmpgjfifkwwrhkswtopdnne",
"privateKey": {
"algorithm": "Ec256",
"rotationPolicy": "Always"
}
}
},
"cardinality": {
"backendChain": {
"partitions": 11,
"redundancyFactor": 5,
"workers": 15
},
"frontend": {
"replicas": 2,
"workers": 6
}
},
"diagnostics": {
"logs": {
"level": "rnmwokumdmebpmfxxxzvvjfdywotav"
},
"metrics": {
"prometheusPort": 7581
},
"selfCheck": {
"mode": "Enabled",
"intervalSeconds": 158,
"timeoutSeconds": 14
},
"traces": {
"mode": "Enabled",
"cacheSizeMegabytes": 28,
"selfTracing": {
"mode": "Enabled",
"intervalSeconds": 22
},
"spanChannelCapacity": 1000
}
},
"diskBackedMessageBuffer": {
"maxSize": "500M",
"ephemeralVolumeClaimSpec": {
"volumeName": "c",
"volumeMode": "rxvpksjuuugqnqzeiprocknbn",
"storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
"accessModes": [
"nuluhigrbb"
],
"dataSource": {
"apiGroup": "npqapyksvvpkohujx",
"kind": "wazgyb",
"name": "cwhsgxxcxsyppoefm"
},
"dataSourceRef": {
"apiGroup": "mnfnykznjjsoqpfsgdqioupt",
"kind": "odynqzekfzsnawrctaxg",
"name": "envszivbbmixbyddzg",
"namespace": "etcfzvxqd"
},
"resources": {
"limits": {
"key2719": "hmphcrgctu"
},
"requests": {
"key2909": "txocprnyrsgvhfrg"
}
},
"selector": {
"matchExpressions": [
{
"key": "e",
"operator": "In",
"values": [
"slmpajlywqvuyknipgztsonqyybt"
]
}
],
"matchLabels": {
"key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
}
}
},
"persistentVolumeClaimSpec": {
"volumeName": "c",
"volumeMode": "rxvpksjuuugqnqzeiprocknbn",
"storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
"accessModes": [
"nuluhigrbb"
],
"dataSource": {
"apiGroup": "npqapyksvvpkohujx",
"kind": "wazgyb",
"name": "cwhsgxxcxsyppoefm"
},
"dataSourceRef": {
"apiGroup": "mnfnykznjjsoqpfsgdqioupt",
"kind": "odynqzekfzsnawrctaxg",
"name": "envszivbbmixbyddzg",
"namespace": "etcfzvxqd"
},
"resources": {
"limits": {
"key2719": "hmphcrgctu"
},
"requests": {
"key2909": "txocprnyrsgvhfrg"
}
},
"selector": {
"matchExpressions": [
{
"key": "e",
"operator": "In",
"values": [
"slmpajlywqvuyknipgztsonqyybt"
]
}
],
"matchLabels": {
"key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
}
}
}
},
"generateResourceLimits": {
"cpu": "Enabled"
},
"memoryProfile": "Tiny",
"highPriorityMessagesBackpressureHandling": "Accept"
},
"extendedLocation": {
"name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
"type": "CustomLocation"
}
}
Voorbeeldrespons
{
"properties": {
"advanced": {
"clients": {
"maxSessionExpirySeconds": 3859,
"maxMessageExpirySeconds": 3263,
"maxPacketSizeBytes": 3029,
"subscriberQueueLimit": {
"length": 6,
"strategy": "None"
},
"maxReceiveMaximum": 2365,
"maxKeepAliveSeconds": 3744
},
"encryptInternalTraffic": "Enabled",
"internalCerts": {
"duration": "bchrc",
"renewBefore": "xkafmpgjfifkwwrhkswtopdnne",
"privateKey": {
"algorithm": "Ec256",
"rotationPolicy": "Always"
}
}
},
"cardinality": {
"backendChain": {
"partitions": 11,
"redundancyFactor": 5,
"workers": 15
},
"frontend": {
"replicas": 2,
"workers": 6
}
},
"diagnostics": {
"logs": {
"level": "rnmwokumdmebpmfxxxzvvjfdywotav"
},
"metrics": {
"prometheusPort": 7581
},
"selfCheck": {
"mode": "Enabled",
"intervalSeconds": 158,
"timeoutSeconds": 14
},
"traces": {
"mode": "Enabled",
"cacheSizeMegabytes": 28,
"selfTracing": {
"mode": "Enabled",
"intervalSeconds": 22
},
"spanChannelCapacity": 1000
}
},
"diskBackedMessageBuffer": {
"maxSize": "500M",
"ephemeralVolumeClaimSpec": {
"volumeName": "c",
"volumeMode": "rxvpksjuuugqnqzeiprocknbn",
"storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
"accessModes": [
"nuluhigrbb"
],
"dataSource": {
"apiGroup": "npqapyksvvpkohujx",
"kind": "wazgyb",
"name": "cwhsgxxcxsyppoefm"
},
"dataSourceRef": {
"apiGroup": "mnfnykznjjsoqpfsgdqioupt",
"kind": "odynqzekfzsnawrctaxg",
"name": "envszivbbmixbyddzg",
"namespace": "etcfzvxqd"
},
"resources": {
"limits": {
"key2719": "hmphcrgctu"
},
"requests": {
"key2909": "txocprnyrsgvhfrg"
}
},
"selector": {
"matchExpressions": [
{
"key": "e",
"operator": "In",
"values": [
"slmpajlywqvuyknipgztsonqyybt"
]
}
],
"matchLabels": {
"key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
}
}
},
"persistentVolumeClaimSpec": {
"volumeName": "c",
"volumeMode": "rxvpksjuuugqnqzeiprocknbn",
"storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
"accessModes": [
"nuluhigrbb"
],
"dataSource": {
"apiGroup": "npqapyksvvpkohujx",
"kind": "wazgyb",
"name": "cwhsgxxcxsyppoefm"
},
"dataSourceRef": {
"apiGroup": "mnfnykznjjsoqpfsgdqioupt",
"kind": "odynqzekfzsnawrctaxg",
"name": "envszivbbmixbyddzg",
"namespace": "etcfzvxqd"
},
"resources": {
"limits": {
"key2719": "hmphcrgctu"
},
"requests": {
"key2909": "txocprnyrsgvhfrg"
}
},
"selector": {
"matchExpressions": [
{
"key": "e",
"operator": "In",
"values": [
"slmpajlywqvuyknipgztsonqyybt"
]
}
],
"matchLabels": {
"key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
}
}
}
},
"generateResourceLimits": {
"cpu": "Enabled"
},
"memoryProfile": "Tiny",
"highPriorityMessagesBackpressureHandling": "Accept",
"provisioningState": "Succeeded"
},
"extendedLocation": {
"name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
"type": "CustomLocation"
},
"id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
"name": "dowrkel",
"type": "Microsoft.IoTOperations/instances/brokers",
"systemData": {
"createdBy": "contosouser",
"createdByType": "User",
"createdAt": "2024-08-09T18:13:29.389Z",
"lastModifiedBy": "contosouser",
"lastModifiedByType": "User",
"lastModifiedAt": "2024-08-09T18:13:29.389Z"
}
}
Azure-AsyncOperation: https://contoso.com/operationstatus
{
"properties": {
"advanced": {
"clients": {
"maxSessionExpirySeconds": 3859,
"maxMessageExpirySeconds": 3263,
"maxPacketSizeBytes": 3029,
"subscriberQueueLimit": {
"length": 6,
"strategy": "None"
},
"maxReceiveMaximum": 2365,
"maxKeepAliveSeconds": 3744
},
"encryptInternalTraffic": "Enabled",
"internalCerts": {
"duration": "bchrc",
"renewBefore": "xkafmpgjfifkwwrhkswtopdnne",
"privateKey": {
"algorithm": "Ec256",
"rotationPolicy": "Always"
}
}
},
"cardinality": {
"backendChain": {
"partitions": 11,
"redundancyFactor": 5,
"workers": 15
},
"frontend": {
"replicas": 2,
"workers": 6
}
},
"diagnostics": {
"logs": {
"level": "rnmwokumdmebpmfxxxzvvjfdywotav"
},
"metrics": {
"prometheusPort": 7581
},
"selfCheck": {
"mode": "Enabled",
"intervalSeconds": 158,
"timeoutSeconds": 14
},
"traces": {
"mode": "Enabled",
"cacheSizeMegabytes": 28,
"selfTracing": {
"mode": "Enabled",
"intervalSeconds": 22
},
"spanChannelCapacity": 1000
}
},
"diskBackedMessageBuffer": {
"maxSize": "500M",
"ephemeralVolumeClaimSpec": {
"volumeName": "c",
"volumeMode": "rxvpksjuuugqnqzeiprocknbn",
"storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
"accessModes": [
"nuluhigrbb"
],
"dataSource": {
"apiGroup": "npqapyksvvpkohujx",
"kind": "wazgyb",
"name": "cwhsgxxcxsyppoefm"
},
"dataSourceRef": {
"apiGroup": "mnfnykznjjsoqpfsgdqioupt",
"kind": "odynqzekfzsnawrctaxg",
"name": "envszivbbmixbyddzg",
"namespace": "etcfzvxqd"
},
"resources": {
"limits": {
"key2719": "hmphcrgctu"
},
"requests": {
"key2909": "txocprnyrsgvhfrg"
}
},
"selector": {
"matchExpressions": [
{
"key": "e",
"operator": "In",
"values": [
"slmpajlywqvuyknipgztsonqyybt"
]
}
],
"matchLabels": {
"key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
}
}
},
"persistentVolumeClaimSpec": {
"volumeName": "c",
"volumeMode": "rxvpksjuuugqnqzeiprocknbn",
"storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
"accessModes": [
"nuluhigrbb"
],
"dataSource": {
"apiGroup": "npqapyksvvpkohujx",
"kind": "wazgyb",
"name": "cwhsgxxcxsyppoefm"
},
"dataSourceRef": {
"apiGroup": "mnfnykznjjsoqpfsgdqioupt",
"kind": "odynqzekfzsnawrctaxg",
"name": "envszivbbmixbyddzg",
"namespace": "etcfzvxqd"
},
"resources": {
"limits": {
"key2719": "hmphcrgctu"
},
"requests": {
"key2909": "txocprnyrsgvhfrg"
}
},
"selector": {
"matchExpressions": [
{
"key": "e",
"operator": "In",
"values": [
"slmpajlywqvuyknipgztsonqyybt"
]
}
],
"matchLabels": {
"key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
}
}
}
},
"generateResourceLimits": {
"cpu": "Enabled"
},
"memoryProfile": "Tiny",
"highPriorityMessagesBackpressureHandling": "Accept",
"provisioningState": "Succeeded"
},
"extendedLocation": {
"name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
"type": "CustomLocation"
},
"id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
"name": "dowrkel",
"type": "Microsoft.IoTOperations/instances/brokers",
"systemData": {
"createdBy": "contosouser",
"createdByType": "User",
"createdAt": "2024-08-09T18:13:29.389Z",
"lastModifiedBy": "contosouser",
"lastModifiedByType": "User",
"lastModifiedAt": "2024-08-09T18:13:29.389Z"
}
}
Broker_CreateOrUpdate_Complex
Voorbeeldaanvraag
PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2026-07-01
{
"properties": {
"cardinality": {
"backendChain": {
"partitions": 2,
"redundancyFactor": 2,
"workers": 2
},
"frontend": {
"replicas": 2,
"workers": 2
}
},
"diskBackedMessageBuffer": {
"maxSize": "50M"
},
"generateResourceLimits": {
"cpu": "Enabled"
},
"memoryProfile": "Medium"
},
"extendedLocation": {
"name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
"type": "CustomLocation"
}
}
Voorbeeldrespons
{
"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"
}
}
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
Voorbeeldaanvraag
PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2026-07-01
{
"properties": {
"memoryProfile": "Tiny"
},
"extendedLocation": {
"name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
"type": "CustomLocation"
}
}
Voorbeeldrespons
{
"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"
}
}
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
Voorbeeldaanvraag
PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2026-07-01
{
"properties": {
"cardinality": {
"backendChain": {
"partitions": 2,
"redundancyFactor": 2,
"workers": 2
},
"frontend": {
"replicas": 2,
"workers": 2
}
},
"generateResourceLimits": {
"cpu": "Enabled"
},
"memoryProfile": "Low"
},
"extendedLocation": {
"name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
"type": "CustomLocation"
}
}
Voorbeeldrespons
{
"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"
}
}
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"
}
}
Definities
| Name | Description |
|---|---|
|
Advanced |
Geavanceerde instellingen voor broker |
|
Backend |
Gewenste eigenschappen van de back-endinstanties van de broker |
|
Broker |
Eigenschappen van diagnostische instelling broker |
|
Broker |
De geheugenprofielinstellingen van de Broker |
|
Broker |
Configuratie van schijfpersistentie. Wanneer persistentie is ingeschakeld, bevinden bepaalde items (niet-prestatiekritieke gegevens) die zijn geselecteerd voor persistentie zich alleen op schijf. Hieronder staan de betrokken items:
Optional. Alles is in het geheugen als het niet is ingesteld. Opmerking: indien geconfigureerd, worden alle MQTT-sessiestatussen naar schijf geschreven. |
|
Broker |
Eigenschappen van versleuteling van persistentie van brokers. |
|
Broker |
Waarden van de Broker Persistence Policy Mode. |
|
Broker |
Eigenschappen van brokerresource |
|
Broker |
Instantiebrokerresource |
|
Broker |
Aangepaste makelaar behoudt berichtbeleid. |
|
Broker |
Dynamische instellingen van BrokerRetainMessagesCustomPolicy. |
|
Broker |
Makelaar Berichten eigenschappen behouden. |
|
Broker |
Aangepast beleid van de Broker State Store. |
|
Broker |
Dynamische instellingen van BrokerStateStoreCustomPolicy. |
|
Broker |
Makelaar State Store Key Type eigenschappen. |
|
Broker |
Makelaar Staat Winkelbeleid Resources eigenschappen. |
|
Broker |
Aangepaste beleidsinstellingen voor Broker State Store. |
|
Broker |
Status van makelaarsstatus. |
|
Broker |
Aangepaste eigenschappen van het wachtrijbeleid voor abonnees. |
|
Broker |
Eigenschappen van aangepast beleid voor de wachtrij van makelaarsabonnees. |
|
Broker |
Dynamische instellingen van BrokerSubscriberQueueCustomPolicy. |
| Cardinality |
Kardinaliteitseigenschappen |
|
Cert |
Eigenschappen van Cert Manager-certificaat |
|
Cert |
Eigenschappen van persoonlijke sleutel van Cert Manager |
|
Client |
De instellingen van clientconfiguratie. |
|
created |
Het identiteitstype dat de resource heeft gemaakt. |
|
Diagnostics |
Eigenschappen van diagnostisch logboek |
|
Disk |
Eigenschappen van DiskBackedMessageBuffer |
|
Error |
Aanvullende informatie over de resourcebeheerfout. |
|
Error |
Het foutdetail. |
|
Error |
Foutreactie |
|
Extended |
Uitgebreide locatie is een uitbreiding van Azure-locaties. Ze bieden een manier om hun Kubernetes-clusters met Azure ARC te gebruiken als doellocaties voor het implementeren van Azure-servicesexemplaren. |
|
Extended |
Het enum definieert het type ExtendedLocation dat is geaccepteerd. |
| Frontend |
De gewenste eigenschappen van de front-endinstanties van de broker |
|
Generate |
GenerateResourceLimits-eigenschappen |
|
High |
Afhandeling van berichten met hoge prioriteit tijdens de terugdruktoestand. |
|
Kubernetes |
Kubernetes-verwijzing |
|
Local |
Kubernetes-verwijzing |
| Metrics |
Eigenschappen van diagnostische metrische gegevens |
|
Operational |
Moduseigenschappen |
|
Operator |
Geldige operators zijn In, NotIn, Exists en DoesNotExist. |
|
Private |
Typen persoonlijke sleutelalgoritmen. |
|
Private |
Beleid voor rotatie van persoonlijke sleutels. |
|
Provisioning |
De opsomming waarin de status van de resource wordt gedefinieerd. |
|
Resource |
De gezondheidstoestand van de bron. |
|
Resource |
Geeft de gezondheidstoestand van een hulpbron weer. |
|
Self |
Eigenschappen voor zelfcontrole van broker |
|
Self |
Eigenschappen voor zelftracering voor diagnostische gegevens |
|
Subscriber |
Het enum definieert strategieën voor het verwijderen van berichten uit de abonneewachtrij. |
|
Subscriber |
De instellingen van De wachtrijlimiet voor abonnees. |
|
system |
Metagegevens met betrekking tot het maken en de laatste wijziging van de resource. |
| Traces |
Eigenschappen van brokerdiagnose tracering |
|
Volume |
Eigenschappen volumeClaimResourceRequirements |
|
Volume |
Eigenschappen van VolumeClaimResourceRequirementsClaims. |
|
Volume |
Eigenschappen VolumeClaimSpec |
|
Volume |
Eigenschappen volumeClaimSpecSelector |
|
Volume |
Eigenschappen volumeClaimSpecSelectorMatchExpressions |
AdvancedSettings
Geavanceerde instellingen voor broker
| Name | Type | Default value | Description |
|---|---|---|---|
| clients |
Configuraties met betrekking tot alle clients. |
||
| encryptInternalTraffic | Enabled |
De instelling voor het in- of uitschakelen van versleuteling van intern verkeer. |
|
| internalCerts |
Certificaatrotatie en configuratie van persoonlijke sleutels. |
BackendChain
Gewenste eigenschappen van de back-endinstanties van de broker
| Name | Type | Default value | Description |
|---|---|---|---|
| partitions |
integer (int32) minimum: 1maximum: 16 |
Het gewenste aantal fysieke back-endpartities. |
|
| redundancyFactor |
integer (int32) minimum: 1maximum: 5 |
De gewenste aantallen back-endreplica's (pods) in een fysieke partitie. |
|
| workers |
integer (int32) minimum: 1maximum: 16 |
1 |
Aantal logische back-endmedewerkers per replica (pod). |
BrokerDiagnostics
Eigenschappen van diagnostische instelling broker
| Name | Type | Description |
|---|---|---|
| logs |
Diagnostische logboekinstellingen voor de resource. |
|
| metrics |
De instellingen voor metrische gegevens voor de resource. |
|
| selfCheck |
De eigenschappen van de zelfcontrole. |
|
| traces |
De traceringseigenschappen. |
BrokerMemoryProfile
De geheugenprofielinstellingen van de Broker
| Waarde | Description |
|---|---|
| Tiny |
Klein geheugenprofiel. |
| Low |
Laag geheugenprofiel. |
| Medium |
Gemiddeld geheugenprofiel. |
| High |
Hoog geheugenprofiel. |
BrokerPersistence
Configuratie van schijfpersistentie.
Wanneer persistentie is ingeschakeld, bevinden bepaalde items (niet-prestatiekritieke gegevens) die zijn geselecteerd voor persistentie zich alleen op schijf. Hieronder staan de betrokken items:
- Bewaarde berichten worden alleen op schijf opgeslagen.
- WILL-berichten worden alleen op schijf opgeslagen.
- DSS-sleutel/waarde-paren worden alleen op schijf opgeslagen, met uitzondering van prestatiekritieke items zoals getimede vergrendelingen, die zowel op de schijf als in het geheugen blijven staan voor betere prestaties.
Optional. Alles is in het geheugen als het niet is ingesteld. Opmerking: indien geconfigureerd, worden alle MQTT-sessiestatussen naar schijf geschreven.
| Name | Type | Description |
|---|---|---|
| encryption |
Hiermee bepaalt u de instellingen met betrekking tot de versleuteling van de persistentiedatabase. Optioneel, standaard ingesteld op het inschakelen van versleuteling. |
|
| maxSize |
string |
De maximale grootte van de berichtbuffer op schijf. Als een PVC-sjabloon is opgegeven met behulp van persistentVolumeClaimSpec, wordt deze grootte gebruikt als de aanvraag- en limietgrootte van die sjabloon. Als er geen PVC-sjabloon is opgegeven, wordt vervolgens de provisioner voor het lokale pad aangevraagd met deze groottelimiet. Required. |
| persistentVolumeClaimSpec |
Gebruik de opgegeven claimsjabloon voor persistent volume om een persistent volume te koppelen. Zelfde object als in diskBackedMessageBuffer, maar met de beperking dat access modi-veld moet worden ingesteld op Als deze optie niet is ingeschakeld, wordt een standaard-PVC met standaardeigenschappen gebruikt. Onder andere gebruikt deze PVC de cluster default storage class, die mogelijk wel of niet een local path provisioner gebruikt. De gebruiker kiest voor suboptimaal gedrag als hij dit niet stelt of zonder het storage class-veld instelt, en hun clusterstandaard is geen lokale padklasse. |
|
| retain | BrokerRetainMessagesPolicy: |
Hiermee bepaalt u welke bewaarde berichten van het onderwerp op schijf moeten worden bewaard. |
| stateStore | BrokerStateStorePolicy: |
Hiermee bepaalt u welke toetsen op schijf moeten worden bewaard voor het statusarchief. |
| subscriberQueue | BrokerSubscriberQueuePolicy: |
Hiermee bepaalt u welke berichtwachtrijen van abonnees op schijf moeten worden bewaard. Belangrijk: om het opnieuw verbinden te vergemakkelijken, worden metagegevens van de sessiestatus ALTIJD naar de schijf geschreven als er een persistentie-instelling is opgegeven, zelfs als deze sectie niet is ingesteld. |
BrokerPersistenceEncryption
Eigenschappen van versleuteling van persistentie van brokers.
| Name | Type | Description |
|---|---|---|
| mode |
Hiermee bepaalt u of versleuteling is ingeschakeld. |
BrokerPersistencePolicyMode
Waarden van de Broker Persistence Policy Mode.
| Waarde | Description |
|---|---|
| All |
Beleidsmodus voor iedereen. |
| None |
Beleidsmodus voor Geen. |
| Custom |
Geeft aan dat het beleid een aangepast beleid is. |
BrokerProperties
Eigenschappen van brokerresource
| Name | Type | Default value | Description |
|---|---|---|---|
| advanced |
Geavanceerde instellingen van Broker. |
||
| cardinality |
De kardinaliteitsdetails van de broker. |
||
| diagnostics |
Specificatie definieert de gewenste identiteiten van diagnostische instellingen van Broker. |
||
| diskBackedMessageBuffer |
Instellingen van door schijf ondersteunde berichtbuffer. |
||
| generateResourceLimits |
Met deze instelling bepaalt u of kubernetes CPU-resourcelimieten worden aangevraagd. Door het aantal replica's of werkrollen te verhogen, wordt de hoeveelheid aangevraagde CPU-resources evenredig verhoogd. Als deze instelling is ingeschakeld en er onvoldoende CPU-resources zijn, wordt er een fout verzonden. |
||
| healthState | Unknown |
De gezondheidstoestand van de bron. |
|
| highPriorityMessagesBackpressureHandling |
Afhandeling van berichten met hoge prioriteit in het geval dat berichten met reguliere prioriteit worden teruggezet. Wanneer ingesteld op "Accepteren", blijft de broker berichten met hoge prioriteit accepteren, zelfs terwijl berichten met reguliere prioriteit worden afgewezen vanwege tegendruk. Wanneer ingesteld op "Afwijzen", beïnvloedt terugdruk ook berichten met hoge prioriteit. Standaard staat het op "Accepteren". |
||
| memoryProfile | Medium |
Geheugenprofiel van Broker. |
|
| persistence |
De persistentie-instellingen van de broker. |
||
| provisioningState |
De status van de laatste bewerking. |
||
| status |
De status van de makelaar. |
BrokerResource
Instantiebrokerresource
| Name | Type | Description |
|---|---|---|
| extendedLocation |
Edge-locatie van de resource. |
|
| id |
string (arm-id) |
Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}" |
| name |
string |
De naam van de resource |
| properties |
De resourcespecifieke eigenschappen voor deze resource. |
|
| systemData |
Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens. |
|
| type |
string |
Het type bron. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts' |
BrokerRetainMessagesCustomPolicy
Aangepaste makelaar behoudt berichtbeleid.
| Name | Type | Description |
|---|---|---|
| mode |
string:
Custom |
'Alle' om alle bewaarde berichten te behouden, 'Geen' om geen berichten te behouden, 'Aangepast' om alleen de opgegeven onderwerpen te behouden. |
| retainSettings |
Instellingen voor het beleid. |
BrokerRetainMessagesDynamic
Dynamische instellingen van BrokerRetainMessagesCustomPolicy.
| Name | Type | Description |
|---|---|---|
| mode |
Modus van de BrokerRetainMessagesCustomPolicy. |
BrokerRetainMessagesSettings
Makelaar Berichten eigenschappen behouden.
| Name | Type | Description |
|---|---|---|
| dynamic |
Hiermee bepaalt u of MQTT-clients schijfpersistentie kunnen aanvragen via |
|
| topics |
string[] |
Lijst met onderwerpen waaronder bewaarde berichten op schijf worden bewaard. Jokertekens # en + worden ondersteund. |
BrokerStateStoreCustomPolicy
Aangepast beleid van de Broker State Store.
| Name | Type | Description |
|---|---|---|
| mode |
string:
Custom |
'Alle' om alle sleutels te behouden, 'Geen' om geen sleutels te behouden, 'Aangepast' om alleen de opgegeven sleutels te behouden. |
| stateStoreSettings |
Instellingen voor het beleid. |
BrokerStateStoreDynamic
Dynamische instellingen van BrokerStateStoreCustomPolicy.
| Name | Type | Description |
|---|---|---|
| mode |
Modus van de BrokerStateStoreCustomPolicy. |
BrokerStateStoreKeyType
Makelaar State Store Key Type eigenschappen.
| Waarde | Description |
|---|---|
| Pattern |
Gebruikt voor het matchen van patronen in glob-stijl. |
| String |
Wordt gebruikt om exact overeen te komen, bijvoorbeeld wanneer een sleutel tekens bevat die anders als een patroon zouden kunnen worden gematcht (*, ?, [0-9]). |
| Binary |
Wordt gebruikt om een binaire sleutel te matchen. |
BrokerStateStorePolicyResources
Makelaar Staat Winkelbeleid Resources eigenschappen.
| Name | Type | Description |
|---|---|---|
| keyType |
De sleutel om op schijf te blijven staan. |
|
| keys |
string[] |
Lijst met sleutels die op schijf moeten blijven staan, vereist. |
BrokerStateStorePolicySettings
Aangepaste beleidsinstellingen voor Broker State Store.
| Name | Type | Description |
|---|---|---|
| dynamic |
Hiermee bepaalt u of MQTT-clients schijfpersistentie kunnen aanvragen via |
|
| stateStoreResources |
Lijst met sleutels en sleuteltypen die op schijf moeten blijven staan. |
BrokerStatus
Status van makelaarsstatus.
| Name | Type | Description |
|---|---|---|
| healthState |
De gezondheidstoestand van de Broker. |
BrokerSubscriberQueueCustomPolicy
Aangepaste eigenschappen van het wachtrijbeleid voor abonnees.
| Name | Type | Description |
|---|---|---|
| mode |
string:
Custom |
'Alle' om alle abonneewachtrijen te behouden, 'Geen' om geen wachtrijen te behouden, 'Aangepast' om alleen de opgegeven wachtrijen te behouden. |
| subscriberQueueSettings |
Aangepast beleid, vereist als de modus Aangepast is. Abonneewachtrijen van alle groepen worden persistent naar schijf (logische OR). |
BrokerSubscriberQueueCustomPolicySettings
Eigenschappen van aangepast beleid voor de wachtrij van makelaarsabonnees.
| Name | Type | Description |
|---|---|---|
| dynamic |
Hiermee bepaalt u of MQTT-clients schijfpersistentie kunnen aanvragen via |
|
| subscriberClientIds |
string[] |
Lijst met client-ID's van de abonnees, jokerteken * ondersteund. |
BrokerSubscriberQueueDynamic
Dynamische instellingen van BrokerSubscriberQueueCustomPolicy.
| Name | Type | Description |
|---|---|---|
| mode |
Modus van de BrokerSubscriberQueueCustomPolicy. |
Cardinality
Kardinaliteitseigenschappen
| Name | Type | Description |
|---|---|---|
| backendChain |
De gewenste eigenschappen van de back-endbroker |
|
| frontend |
De gewenste eigenschappen van de front-end |
CertManagerCertOptions
Eigenschappen van Cert Manager-certificaat
| Name | Type | Description |
|---|---|---|
| duration |
string |
Levensduur van het certificaat. Moet worden opgegeven met een Go-tijd. Duurnotatie (h|m|s). Bijvoorbeeld 240 uur gedurende 240 uur en 45m gedurende 45 minuten. |
| privateKey |
Configuratie van de persoonlijke sleutel van het certificaat. |
|
| renewBefore |
string |
Wanneer moet u het certificaat vernieuwen. Moet worden opgegeven met een Go-tijd. Duurnotatie (h|m|s). Bijvoorbeeld 240 uur gedurende 240 uur en 45m gedurende 45 minuten. |
CertManagerPrivateKey
Eigenschappen van persoonlijke sleutel van Cert Manager
| Name | Type | Description |
|---|---|---|
| algorithm |
algoritme voor persoonlijke sleutel. |
|
| rotationPolicy |
cert-manager privésleutelrotatieBeleid. |
ClientConfig
De instellingen van clientconfiguratie.
| Name | Type | Description |
|---|---|---|
| maxKeepAliveSeconds |
integer (int32) minimum: 0maximum: 65535 |
Bovengrens van keep alive van een client, in seconden. |
| maxMessageExpirySeconds |
integer (int32) minimum: 1 |
Bovengrens van het verloopinterval van bericht, in seconden. |
| maxPacketSizeBytes |
integer (int32) minimum: 1maximum: 268435456 |
Maximale berichtgrootte voor een pakket in bytes. |
| maxReceiveMaximum |
integer (int32) minimum: 1maximum: 65535 |
Bovengrens van Receive Maximum die een client kan aanvragen in het CONNECT-pakket. |
| maxSessionExpirySeconds |
integer (int32) minimum: 1 |
Bovengrens van sessieverloopinterval, in seconden. |
| subscriberQueueLimit |
De limiet voor het aantal berichten in de wachtrij voor een abonnee. |
createdByType
Het identiteitstype dat de resource heeft gemaakt.
| Waarde | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DiagnosticsLogs
Eigenschappen van diagnostisch logboek
| Name | Type | Default value | Description |
|---|---|---|---|
| level |
string |
info |
Het logboekniveau. Voorbeelden: 'debug', 'info', 'warn', 'error', 'trace'. |
DiskBackedMessageBuffer
Eigenschappen van DiskBackedMessageBuffer
| Name | Type | Description |
|---|---|---|
| ephemeralVolumeClaimSpec |
Gebruik de opgegeven sjabloon voor permanente volumeclaims om een 'algemeen kortstondig volume' voor de berichtbuffer te koppelen. Zie https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes voor meer informatie. |
|
| maxSize |
string pattern: ^[0-9]+[KMGTPE]$ |
De maximale grootte van de berichtbuffer op schijf. Als een PVC-sjabloon wordt opgegeven met behulp van een van kortstondigeVolumeClaimSpec of persistentVolumeClaimSpec, wordt deze grootte gebruikt als de aanvraag en limietgrootte van die sjabloon. Als noch kortstondigeVolumeClaimSpec noch persistentVolumeClaimSpec zijn opgegeven, wordt een leegDir-volume als limiet gekoppeld aan deze grootte. Zie https://kubernetes.io/docs/concepts/storage/volumes/#emptydir voor meer informatie. |
| persistentVolumeClaimSpec |
Gebruik de opgegeven sjabloon voor permanente volumeclaims om een permanent volume voor de berichtbuffer te koppelen. |
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
| Name | Type | Description |
|---|---|---|
| info |
object |
De aanvullende informatie. |
| type |
string |
Het extra informatietype. |
ErrorDetail
Het foutdetail.
| Name | Type | Description |
|---|---|---|
| additionalInfo |
Aanvullende informatie over de fout. |
|
| code |
string |
De foutcode. |
| details |
De foutgegevens. |
|
| message |
string |
Het foutbericht. |
| target |
string |
Het foutdoelwit. |
ErrorResponse
Foutreactie
| Name | Type | Description |
|---|---|---|
| error |
Het foutobject. |
ExtendedLocation
Uitgebreide locatie is een uitbreiding van Azure-locaties. Ze bieden een manier om hun Kubernetes-clusters met Azure ARC te gebruiken als doellocaties voor het implementeren van Azure-servicesexemplaren.
| Name | Type | Description |
|---|---|---|
| name |
string |
De naam van de uitgebreide locatie. |
| type |
Type UitgebreideLocatie. |
ExtendedLocationType
Het enum definieert het type ExtendedLocation dat is geaccepteerd.
| Waarde | Description |
|---|---|
| CustomLocation |
CustomLocation-type |
Frontend
De gewenste eigenschappen van de front-endinstanties van de broker
| Name | Type | Default value | Description |
|---|---|---|---|
| replicas |
integer (int32) minimum: 1maximum: 16 |
Het gewenste aantal front-endexemplaren (pods). |
|
| workers |
integer (int32) minimum: 1maximum: 16 |
2 |
Aantal logische front-endwerkers per exemplaar (pod). |
GenerateResourceLimits
GenerateResourceLimits-eigenschappen
| Name | Type | Default value | Description |
|---|---|---|---|
| cpu | Enabled |
De wisselknop om cpu-resourcelimieten in of uit te schakelen. |
HighPriorityMessagesBackpressureHandling
Afhandeling van berichten met hoge prioriteit tijdens de terugdruktoestand.
| Waarde | Description |
|---|---|
| Accept |
Wanneer de broker berichten met reguliere prioriteit afwijst vanwege tegendruk, blijft hij berichten met hoge prioriteit accepteren. |
| Reject |
Wanneer de broker berichten met reguliere prioriteit afwijst vanwege tegendruk, wijst hij ook berichten met hoge prioriteit af. |
KubernetesReference
Kubernetes-verwijzing
| Name | Type | Description |
|---|---|---|
| apiGroup |
string |
APIGroup is de groep waarnaar wordt verwezen voor de resource. Als APIGroup niet is opgegeven, moet het opgegeven type zich in de kern-API-groep bevinden. Voor andere typen van derden is APIGroup vereist. |
| kind |
string |
Soort is het type resource waarnaar wordt verwezen |
| name |
string |
Naam is de naam van de resource waarnaar wordt verwezen |
| namespace |
string |
Naamruimte is de naamruimte van de resource waarnaar wordt verwezen. Dit veld is vereist wanneer de resource een naamruimte heeft. |
LocalKubernetesReference
Kubernetes-verwijzing
| Name | Type | Description |
|---|---|---|
| apiGroup |
string |
APIGroup is de groep waarnaar wordt verwezen voor de resource. Als APIGroup niet is opgegeven, moet het opgegeven type zich in de kern-API-groep bevinden. Voor andere typen van derden is APIGroup vereist. |
| kind |
string |
Soort is het type resource waarnaar wordt verwezen |
| name |
string |
Naam is de naam van de resource waarnaar wordt verwezen |
Metrics
Eigenschappen van diagnostische metrische gegevens
| Name | Type | Default value | Description |
|---|---|---|---|
| prometheusPort |
integer (int32) minimum: 0maximum: 65535 |
9600 |
De prometheus-poort om de metrische gegevens beschikbaar te maken. |
OperationalMode
Moduseigenschappen
| Waarde | Description |
|---|---|
| Enabled |
Ingeschakeld is gelijk aan Waar |
| Disabled |
Uitgeschakeld is gelijk aan Onwaar. |
OperatorValues
Geldige operators zijn In, NotIn, Exists en DoesNotExist.
| Waarde | Description |
|---|---|
| In |
In operator. |
| NotIn |
NotIn-operator. |
| Exists |
Bestaat operator. |
| DoesNotExist |
DoesNotExist-operator. |
PrivateKeyAlgorithm
Typen persoonlijke sleutelalgoritmen.
| Waarde | Description |
|---|---|
| Ec256 |
Algoritme - ec256. |
| Ec384 |
Algoritme - ec384. |
| Ec521 |
Algoritme - ec521. |
| Ed25519 |
Algoritme - ed25519. |
| Rsa2048 |
Algoritme - rsa2048. |
| Rsa4096 |
Algoritme - rsa4096. |
| Rsa8192 |
Algoritme - rsa8192. |
PrivateKeyRotationPolicy
Beleid voor rotatie van persoonlijke sleutels.
| Waarde | Description |
|---|---|
| Always |
Roulatiebeleid - altijd. |
| Never |
Roulatiebeleid - Nooit. |
ProvisioningState
De opsomming waarin de status van de resource wordt gedefinieerd.
| Waarde | Description |
|---|---|
| Succeeded |
Er is een bron gemaakt. |
| Failed |
Het maken van bronnen is mislukt. |
| Canceled |
Het maken van grondstoffen is geannuleerd. |
| Provisioning |
Resource wordt ingericht. |
| Updating |
Bron wordt bijgewerkt. |
| Deleting |
Bron wordt verwijderd. |
| Accepted |
Bron is geaccepteerd. |
ResourceHealthState
De gezondheidstoestand van de bron.
| Waarde | Description |
|---|---|
| Available |
Resource is beschikbaar en functioneert zoals verwacht. |
| Degraded |
De gezondheid van hulpbronnen wordt aangetast. |
| Unavailable |
De resource werkt niet zoals verwacht. |
| Unknown |
De status van de bron is onbekend. |
ResourceHealthStatus
Geeft de gezondheidstoestand van een hulpbron weer.
| Name | Type | Description |
|---|---|---|
| lastTransitionTime |
string |
De tijdstempel (RFC3339) wanneer de gezondheidsstatus voor het laatst veranderde. |
| lastUpdateTime |
string |
De tijdstempel (RFC3339) wanneer de gezondheidsstatus voor het laatst werd bijgewerkt, zelfs als de status niet veranderde. |
| message |
string |
Een door mensen leesbaar bericht dat de laatste overgang beschrijft. |
| reasonCode |
string |
Unieke CamelCase redencode die de oorzaak van de overgang in de laatste gezondheidstoestand beschrijft. |
| status |
De hoge gezondheidstoestand van de hulpbron. |
SelfCheck
Eigenschappen voor zelfcontrole van broker
| Name | Type | Default value | Description |
|---|---|---|---|
| intervalSeconds |
integer (int32) minimum: 30maximum: 300 |
30 |
Het interval voor zelfcontrole. |
| mode | Enabled |
De wisselknop om zelfcontrole in of uit te schakelen. |
|
| timeoutSeconds |
integer (int32) minimum: 5maximum: 120 |
15 |
De time-out voor zelfcontrole. |
SelfTracing
Eigenschappen voor zelftracering voor diagnostische gegevens
| Name | Type | Default value | Description |
|---|---|---|---|
| intervalSeconds |
integer (int32) minimum: 1maximum: 300 |
30 |
Het interval voor zelftracering. |
| mode | Enabled |
De wisselknop om zelftracering in of uit te schakelen. |
SubscriberMessageDropStrategy
Het enum definieert strategieën voor het verwijderen van berichten uit de abonneewachtrij.
| Waarde | Description |
|---|---|
| None |
Berichten worden nooit gedropt. |
| DropOldest |
Het oudste bericht wordt verwijderd. |
SubscriberQueueLimit
De instellingen van De wachtrijlimiet voor abonnees.
| Name | Type | Default value | Description |
|---|---|---|---|
| length |
integer (int64) minimum: 1 |
De maximale lengte van de wachtrij voordat berichten worden verwijderd. |
|
| strategy | None |
De strategie voor het verwijderen van berichten uit de wachtrij. |
systemData
Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
| Name | Type | Description |
|---|---|---|
| createdAt |
string (date-time) |
De tijdstempel van het aanmaken van resources (UTC). |
| createdBy |
string |
De identiteit die de resource heeft gemaakt. |
| createdByType |
Het identiteitstype dat de resource heeft gemaakt. |
|
| lastModifiedAt |
string (date-time) |
De tijdstempel van de laatste wijziging van de resource (UTC) |
| lastModifiedBy |
string |
De identiteit die de resource voor het laatst heeft gewijzigd. |
| lastModifiedByType |
Het type identiteit dat de resource voor het laatst heeft gewijzigd. |
Traces
Eigenschappen van brokerdiagnose tracering
| Name | Type | Default value | Description |
|---|---|---|---|
| cacheSizeMegabytes |
integer (int32) minimum: 1maximum: 128 |
16 |
De cachegrootte in megabytes. |
| mode | Enabled |
De wisselknop om traceringen in of uit te schakelen. |
|
| selfTracing |
De eigenschappen voor selftracering. |
||
| spanChannelCapacity |
integer (int32) minimum: 1000maximum: 100000 |
1000 |
De capaciteit van het spankanaal. |
VolumeClaimResourceRequirements
Eigenschappen volumeClaimResourceRequirements
| Name | Type | Description |
|---|---|---|
| claims |
Claims bevat de namen van resources, gedefinieerd in spec.resourceClaims, die door deze container worden gebruikt. Dit is een alfaveld en vereist het inschakelen van de DynamicResourceAllocation-functiepoort. Dit veld is onveranderlijk. Het kan alleen worden ingesteld voor containers. |
|
| limits |
object |
Limieten beschrijven de maximale hoeveelheid toegestane rekenresources. Meer informatie: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
| requests |
object |
Aanvragen beschrijven de minimale hoeveelheid rekenresources die vereist zijn. Als aanvragen voor een container worden weggelaten, wordt deze standaard ingesteld op Limieten als dat expliciet is opgegeven, anders naar een door de implementatie gedefinieerde waarde. Meer informatie: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
VolumeClaimResourceRequirementsClaims
Eigenschappen van VolumeClaimResourceRequirementsClaims.
| Name | Type | Description |
|---|---|---|
| name |
string |
Naam van de resource. Dit moet overeenkomen met de naam van een resource in spec.resourceClaims. |
VolumeClaimSpec
Eigenschappen VolumeClaimSpec
| Name | Type | Description |
|---|---|---|
| accessModes |
string[] |
AccessModes bevat de gewenste access-modi die het volume zou moeten hebben. Meer informatie: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
| dataSource |
Dit veld kan worden gebruikt om ofwel te specificeren: * Een bestaand VolumeSnapshot-object (snapshot.storage. k8s.io/VolumeSnapshot) * Een bestaande PVC (PersistentVolumeClaim) Als de provisioner of een externe controller de gespecificeerde databron kan ondersteunen, zal deze een nieuw volume aanmaken op basis van de inhoud van de gespecificeerde databron. Als de functiepoort AnyVolumeDataSource is ingeschakeld, heeft dit veld altijd dezelfde inhoud als het veld DataSourceRef. |
|
| dataSourceRef |
Hiermee geeft u het object waaruit het volume moet worden gevuld met gegevens, als een niet-leeg volume gewenst is. Dit kan elk lokaal object zijn van een niet-lege API-groep (niet-kernobject) of een PersistentVolumeClaim-object. Wanneer dit veld is opgegeven, slaagt volumebinding alleen als het type van het opgegeven object overeenkomt met een geïnstalleerde volumepopulator of dynamische inrichting. Dit veld vervangt de functionaliteit van het gegevensbronveld en als beide velden niet leeg zijn, moeten ze dezelfde waarde hebben. Voor compatibiliteit met eerdere versies worden beide velden (DataSource en DataSourceRef) automatisch ingesteld op dezelfde waarde als een van deze velden leeg is en de andere niet leeg is. Er zijn twee belangrijke verschillen tussen DataSource en DataSourceRef: * Hoewel DataSource slechts twee specifieke typen objecten toestaat, staat DataSourceRef elk niet-kernobject en PersistentVolumeClaim-objecten toe. * Hoewel In DataSource niet-toegestane waarden worden genegeerd (ze verwijderen), behoudt DataSourceRef alle waarden en genereert een fout als er een niet-toegestane waarde is opgegeven. (Bèta) Als u dit veld gebruikt, moet de functiepoort AnyVolumeDataSource zijn ingeschakeld. |
|
| resources |
Resources vertegenwoordigen de minimale resources die het volume moet hebben. Als de functie RecoverVolumeExpansionFailure is ingeschakeld, mogen gebruikers resourcevereisten opgeven die lager zijn dan de vorige waarde, maar moeten ze nog steeds hoger zijn dan de capaciteit die is vastgelegd in het statusveld van de claim. Meer informatie: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
|
| selector |
Een labelquery over volumes die moeten worden overwogen voor binding. |
|
| storageClassName |
string |
Naam van de StorageClass die is vereist voor de claim. Meer informatie: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
| volumeMode |
string |
volumeMode definieert welk type volume vereist is voor de claim. De waarde van het bestandssysteem wordt geïmpliceerd wanneer deze niet is opgenomen in de claimspecificatie. Dit is een bètafunctie. |
| volumeName |
string |
VolumeName is de bindingverwijzing naar de PersistentVolume-back-up van deze claim. |
VolumeClaimSpecSelector
Eigenschappen volumeClaimSpecSelector
| Name | Type | Description |
|---|---|---|
| matchExpressions |
MatchExpressions is een lijst met labelkiezervereisten. De vereisten zijn ANDed. |
|
| matchLabels |
object |
MatchLabels is een kaart van {key,value} paren. Eén {key,value} in de matchLabels-kaart is gelijk aan een element van matchExpressions, waarvan het sleutelveld 'sleutel' is, de operator 'In' is en de waardenmatrix bevat alleen 'waarde'. De vereisten zijn ANDed. |
VolumeClaimSpecSelectorMatchExpressions
Eigenschappen volumeClaimSpecSelectorMatchExpressions
| Name | Type | Description |
|---|---|---|
| key |
string |
sleutel is de labelsleutel waarop de selector van toepassing is. |
| operator |
de operator vertegenwoordigt de relatie van een sleutel met een set waarden. Geldige operators zijn In, NotIn, Exists en DoesNotExist. |
|
| values |
string[] |
waarden is een matrix met tekenreekswaarden. Als de operator In of NotIn is, moet de waardenmatrix niet leeg zijn. Als de operator Bestaat of DoesNotExist is, moet de matrix met waarden leeg zijn. Deze matrix wordt vervangen tijdens een strategische samenvoegpatch. |