Broker - Create Or Update
Skapa en BrokerResource
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}?api-version=2026-07-01
URI-parametrar
| Name | I | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
broker
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$ |
Namnet på asynkron meddelandekö. |
|
instance
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$ |
Namnet på instansen. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
|
subscription
|
path | True |
string (uuid) |
ID för målprenumerationen. Värdet måste vara ett UUID. |
|
api-version
|
query | True |
string minLength: 1 |
Den API-version som ska användas för den här åtgärden. |
Begärandetext
| Name | Typ | Description |
|---|---|---|
| extendedLocation |
Resursens gränsplats. |
|
| properties |
Resursspecifika egenskaper för den här resursen. |
Svar
| Name | Typ | Description |
|---|---|---|
| 200 OK |
Uppdateringsåtgärden "BrokerResource" för resursen lyckades |
|
| 201 Created |
Resursen "BrokerResource" för att skapa åtgärden lyckades Sidhuvuden
|
|
| Other Status Codes |
Ett oväntat felsvar. |
Säkerhet
azure_auth
Azure Active Directory OAuth2-flöde.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
| Name | Description |
|---|---|
| user_impersonation | personifiera ditt användarkonto |
Exempel
|
Broker_Create |
|
Broker_Create |
|
Broker_Create |
|
Broker_Create |
Broker_CreateOrUpdate
Exempelbegäran
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"
}
}
Exempelsvar
{
"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
Exempelbegäran
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"
}
}
Exempelsvar
{
"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
Exempelbegäran
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"
}
}
Exempelsvar
{
"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
Exempelbegäran
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"
}
}
Exempelsvar
{
"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"
}
}
Definitioner
| Name | Description |
|---|---|
|
Advanced |
Avancerade inställningar för broker |
|
Backend |
Önskade egenskaper för serverdelsinstanserna för asynkron meddelandekö |
|
Broker |
Egenskaper för asynkron diagnostikinställning |
|
Broker |
Inställningarna för minnesprofilen för Broker |
|
Broker |
Konfiguration av diskpersistence. När beständighet är aktiverat kommer vissa objekt (icke-prestandakritiska data) som valts för beständighet endast att finnas på disken. Nedan visas de berörda objekten:
Valfritt. Allt finns i minnet om det inte är inställt. Om det är konfigurerat skrivs alla MQTT-sessionstillstånd till disken. |
|
Broker |
Egenskaper för kryptering av asynkron beständighet. |
|
Broker |
Värden för principläge för asynkron beständighet. |
|
Broker |
Egenskaper för broker-resurs |
|
Broker |
Instans broker-resurs |
|
Broker |
Anpassad koordinator behåller meddelandeprincip. |
|
Broker |
Dynamiska inställningar för BrokerRetainMessagesCustomPolicy. |
|
Broker |
Egenskaper för Broker Retain Messages. |
|
Broker |
Anpassad princip för koordinator tillståndsarkiv. |
|
Broker |
Dynamiska inställningar för BrokerStateStoreCustomPolicy. |
|
Broker |
Egenskaper för nyckeltyp för Broker State Store. |
|
Broker |
Egenskaper för principresurser för koordinatortillståndsarkiv. |
|
Broker |
Anpassade principinställningar för Broker State Store. |
|
Broker |
Mäklarstatusstatus. |
|
Broker |
Egenskaper för anpassad prenumerantköprincip. |
|
Broker |
Egenskaper för anpassad princip för koordinator prenumerantkö. |
|
Broker |
Dynamiska inställningar för BrokerSubscriberQueueCustomPolicy. |
| Cardinality |
Kardinalitetsegenskaper |
|
Cert |
Cert Manager-certifikategenskaper |
|
Cert |
Egenskaper för privat nyckel i Cert Manager |
|
Client |
Inställningarna för Klientkonfiguration. |
|
created |
Den typ av identitet som skapade resursen. |
|
Diagnostics |
Egenskaper för diagnostiklogg |
|
Disk |
DiskBackedMessageBuffer-egenskaper |
|
Error |
Ytterligare information om resurshanteringsfelet. |
|
Error |
Felinformationen. |
|
Error |
Felsvar |
|
Extended |
Utökad plats är ett tillägg av Azure-platser. De tillhandahåller ett sätt att använda sina Azure ARC-aktiverade Kubernetes-kluster som målplatser för distribution av Azure-tjänstinstanser. |
|
Extended |
Den uppräkningsdefinieringstyp för ExtendedLocation som accepteras. |
| Frontend |
De önskade egenskaperna för klientdelsinstanserna i Broker |
|
Generate |
Egenskaper för GenerateResourceLimits |
|
High |
Hantering av högprioriterade meddelanden under backtryckstillstånd. |
|
Kubernetes |
Kubernetes-referens |
|
Local |
Kubernetes-referens |
| Metrics |
Egenskaper för diagnostikmått |
|
Operational |
Lägesegenskaper |
|
Operator |
Giltiga operatorer är In, NotIn, Exists och DoesNotExist. |
|
Private |
Algoritmtyper för privata nycklar. |
|
Private |
Roteringsprincip för privat nyckel. |
|
Provisioning |
Uppräkningen som definierar status för resursen. |
|
Resource |
Resursens hälsotillstånd. |
|
Resource |
Representerar hälsotillståndet för en resurs. |
|
Self |
Egenskaper för broker Diagnostic Self check |
|
Self |
Egenskaper för självspårning av diagnostik |
|
Subscriber |
Uppräkningen definierar strategier för att ta bort meddelanden från prenumerantkön. |
|
Subscriber |
Inställningarna för kögräns för prenumeranter. |
|
system |
Metadata som rör skapande och senaste ändring av resursen. |
| Traces |
Egenskaper för asynkron diagnostikspårning |
|
Volume |
VolumeClaimResourceRequirements-egenskaper |
|
Volume |
VolumeClaimResourceRequirementsClaims-egenskaper. |
|
Volume |
VolumeClaimSpec-egenskaper |
|
Volume |
Egenskaper för VolumeClaimSpecSelector |
|
Volume |
VolumeClaimSpecSelectorMatchExpressions-egenskaper |
AdvancedSettings
Avancerade inställningar för broker
| Name | Typ | Standardvärde | Description |
|---|---|---|---|
| clients |
Konfigurationer relaterade till alla klienter. |
||
| encryptInternalTraffic | Enabled |
Inställningen för att aktivera eller inaktivera kryptering av intern trafik. |
|
| internalCerts |
Certifikatrotation och konfiguration av privat nyckel. |
BackendChain
Önskade egenskaper för serverdelsinstanserna för asynkron meddelandekö
| Name | Typ | Standardvärde | Description |
|---|---|---|---|
| partitions |
integer (int32) minimum: 1maximum: 16 |
Önskat antal fysiska serverdelspartitioner. |
|
| redundancyFactor |
integer (int32) minimum: 1maximum: 5 |
Önskat antal serverdelsrepliker (poddar) i en fysisk partition. |
|
| workers |
integer (int32) minimum: 1maximum: 16 |
1 |
Antal logiska serverdelsarbetare per replik (podd). |
BrokerDiagnostics
Egenskaper för asynkron diagnostikinställning
| Name | Typ | Description |
|---|---|---|
| logs |
Diagnostiklogginställningar för resursen. |
|
| metrics |
Måttinställningarna för resursen. |
|
| selfCheck |
Egenskaperna för självkontroll. |
|
| traces |
Spårningsegenskaperna. |
BrokerMemoryProfile
Inställningarna för minnesprofilen för Broker
| Värde | Description |
|---|---|
| Tiny |
Liten minnesprofil. |
| Low |
Låg minnesprofil. |
| Medium |
Medelhög minnesprofil. |
| High |
Hög minnesprofil. |
BrokerPersistence
Konfiguration av diskpersistence.
När beständighet är aktiverat kommer vissa objekt (icke-prestandakritiska data) som valts för beständighet endast att finnas på disken. Nedan visas de berörda objekten:
- Kvarhållna meddelanden kommer endast att lagras på disken.
- WILL-meddelanden kommer endast att lagras på disken.
- DSS-nyckel/värde-par kommer endast att lagras på disk, med undantag för prestandakritiska objekt som tidsinställda lås, som finns kvar i både disk och minne för förbättrad prestanda.
Valfritt. Allt finns i minnet om det inte är inställt. Om det är konfigurerat skrivs alla MQTT-sessionstillstånd till disken.
| Name | Typ | Description |
|---|---|---|
| encryption |
Styr inställningar som rör kryptering av beständighetsdatabasen. Valfritt, aktiverar kryptering som standard. |
|
| maxSize |
string |
Den maximala storleken på meddelandebufferten på disken. Om en PVC-mall anges med hjälp av persistentVolumeClaimSpec används den här storleken som begärande- och begränsningsstorlekar för mallen. Om en PVC-mall inte anges begärs etableringen av den lokala sökvägen med den här storleksgränsen. Required. |
| persistentVolumeClaimSpec |
Använd den angivna mallen för beständiga volymanspråk för att montera en beständig volym. Samma objekt som i diskBackedMessageBuffer, men med en begränsning att access modesfält måste sättas till Om den inte är inställd kommer en standard-PVC med standardegenskaper att användas. Bland annat kommer denna PVC att använda klustrets standard storage-klass, som kanske eller kanske inte använder en lokal path provisioner. Användaren väljer suboptimalt beteende om de lämnar detta oinställt eller sätter det utan storage-klassfältet, och deras klusterstandard är inte en lokal vägklass. |
|
| retain | BrokerRetainMessagesPolicy: |
Styr vilket ämnes kvarhållna meddelanden som ska sparas på disken. |
| stateStore | BrokerStateStorePolicy: |
Styr vilka nycklar som ska sparas på disken för tillståndslagret. |
| subscriberQueue | BrokerSubscriberQueuePolicy: |
Styr vilka meddelandeköer för prenumeranter som ska sparas på disken. Viktigt: För att underlätta återanslutning skrivs metadata för sessionstillstånd ALLTID till disken om någon beständighetsinställning har angetts, även om det här avsnittet inte har angetts. |
BrokerPersistenceEncryption
Egenskaper för kryptering av asynkron beständighet.
| Name | Typ | Description |
|---|---|---|
| mode |
Avgör om kryptering är aktiverat. |
BrokerPersistencePolicyMode
Värden för principläge för asynkron beständighet.
| Värde | Description |
|---|---|
| All |
Principläge för alla. |
| None |
Principläge för Ingen. |
| Custom |
Anger att principen är en anpassad princip. |
BrokerProperties
Egenskaper för broker-resurs
| Name | Typ | Standardvärde | Description |
|---|---|---|---|
| advanced |
Avancerade inställningar för Broker. |
||
| cardinality |
Kardinalitetsinformationen för asynkron meddelandekö. |
||
| diagnostics |
Specifikationen definierar önskade identiteter för diagnostikinställningar för Broker. |
||
| diskBackedMessageBuffer |
Inställningar för diskstödd meddelandebuffert. |
||
| generateResourceLimits |
Den här inställningen styr om Kubernetes CPU-resursgränser begärs. Om du ökar antalet repliker eller arbetare proportionellt ökar mängden begärda CPU-resurser. Om den här inställningen är aktiverad och det inte finns tillräckligt med CPU-resurser genereras ett fel. |
||
| healthState | Unknown |
Resursens hälsotillstånd. |
|
| highPriorityMessagesBackpressureHandling |
Hantering av högprioriterade meddelanden om vanliga prioriterade meddelanden motbelastas. När det sätts till "Acceptera" fortsätter mäklaren att acceptera högprioriterade meddelanden även när vanliga prioriterade meddelanden avvisas på grund av mottryck. När den är inställd på "Avvisa" påverkar backtryck även högprioriterade meddelanden. Inställningen är som standard "Acceptera". |
||
| memoryProfile | Medium |
Minnesprofil för Broker. |
|
| persistence |
Beständighetsinställningarna för mäklaren. |
||
| provisioningState |
Status för den senaste åtgärden. |
||
| status |
Statusen för mäklaren. |
BrokerResource
Instans broker-resurs
| Name | Typ | Description |
|---|---|---|
| extendedLocation |
Resursens gränsplats. |
|
| id |
string (arm-id) |
Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
| name |
string |
Namnet på resursen |
| properties |
Resursspecifika egenskaper för den här resursen. |
|
| systemData |
Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information. |
|
| type |
string |
Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" |
BrokerRetainMessagesCustomPolicy
Anpassad koordinator behåller meddelandeprincip.
| Name | Typ | Description |
|---|---|---|
| mode |
string:
Custom |
"Alla" för att behålla alla meddelanden, "Ingen" för att inte behålla några, "Anpassad" för att endast behålla de angivna ämnena. |
| retainSettings |
Inställningar för principen. |
BrokerRetainMessagesDynamic
Dynamiska inställningar för BrokerRetainMessagesCustomPolicy.
| Name | Typ | Description |
|---|---|---|
| mode |
Läge för BrokerRetainMessagesCustomPolicy. |
BrokerRetainMessagesSettings
Egenskaper för Broker Retain Messages.
| Name | Typ | Description |
|---|---|---|
| dynamic |
Styr om MQTT-klienter kan begära diskpersistence via |
|
| topics |
string[] |
Lista över ämnen under vilka kvarhållna meddelanden skulle sparas på disken. Jokertecken # och + stöds. |
BrokerStateStoreCustomPolicy
Anpassad princip för koordinator tillståndsarkiv.
| Name | Typ | Description |
|---|---|---|
| mode |
string:
Custom |
"Alla" för att behålla alla nycklar, "Ingen" för att inte behålla några, "Anpassad" för att endast behålla de angivna nycklarna. |
| stateStoreSettings |
Inställningar för principen. |
BrokerStateStoreDynamic
Dynamiska inställningar för BrokerStateStoreCustomPolicy.
| Name | Typ | Description |
|---|---|---|
| mode |
Läge för BrokerStateStoreCustomPolicy. |
BrokerStateStoreKeyType
Egenskaper för nyckeltyp för Broker State Store.
| Värde | Description |
|---|---|
| Pattern |
Används för mönstermatchning i glob-stil. |
| String |
Används för att göra exakt matchning, till exempel när en nyckel innehåller tecken som annars skulle kunna matchas som ett mönster (*, ?, [0-9]). |
| Binary |
Används för att matcha en binär nyckel. |
BrokerStateStorePolicyResources
Egenskaper för principresurser för koordinatortillståndsarkiv.
| Name | Typ | Description |
|---|---|---|
| keyType |
Nyckeln för att spara på disken. |
|
| keys |
string[] |
Lista över nycklar som ska sparas på disken, krävs. |
BrokerStateStorePolicySettings
Anpassade principinställningar för Broker State Store.
| Name | Typ | Description |
|---|---|---|
| dynamic |
Styr om MQTT-klienter kan begära diskpersistence via |
|
| stateStoreResources |
Lista över nyckel och nyckeltyp som ska sparas på disken. |
BrokerStatus
Mäklarstatusstatus.
| Name | Typ | Description |
|---|---|---|
| healthState |
Mäklarens hälsotillstånd. |
BrokerSubscriberQueueCustomPolicy
Egenskaper för anpassad prenumerantköprincip.
| Name | Typ | Description |
|---|---|---|
| mode |
string:
Custom |
"Alla" för att behålla alla prenumerantköer, "Ingen" för att inte behålla några, "Anpassad" för att endast behålla de angivna köerna. |
| subscriberQueueSettings |
Anpassad princip, krävs om läget är Anpassad. Prenumerantköer från alla grupper sparas på disken (logiskt OR). |
BrokerSubscriberQueueCustomPolicySettings
Egenskaper för anpassad princip för koordinator prenumerantkö.
| Name | Typ | Description |
|---|---|---|
| dynamic |
Styr om MQTT-klienter kan begära diskpersistence via |
|
| subscriberClientIds |
string[] |
Lista över klient-ID:t för prenumeranterna, jokertecken * stöds. |
BrokerSubscriberQueueDynamic
Dynamiska inställningar för BrokerSubscriberQueueCustomPolicy.
| Name | Typ | Description |
|---|---|---|
| mode |
Läge för BrokerSubscriberQueueCustomPolicy. |
Cardinality
Kardinalitetsegenskaper
| Name | Typ | Description |
|---|---|---|
| backendChain |
Önskade egenskaper för serverdelshanteraren |
|
| frontend |
Önskade egenskaper för klientdelen |
CertManagerCertOptions
Cert Manager-certifikategenskaper
| Name | Typ | Description |
|---|---|---|
| duration |
string |
Certifikatets livslängd. Måste anges med en Go-tid. Varaktighetsformat (h|m|s). T.ex. 240h i 240 timmar och 45m i 45 minuter. |
| privateKey |
Konfiguration av certifikatets privata nyckel. |
|
| renewBefore |
string |
När du ska börja förnya certifikatet. Måste anges med en Go-tid. Varaktighetsformat (h|m|s). T.ex. 240h i 240 timmar och 45m i 45 minuter. |
CertManagerPrivateKey
Egenskaper för privat nyckel i Cert Manager
| Name | Typ | Description |
|---|---|---|
| algorithm |
algoritm för privat nyckel. |
|
| rotationPolicy |
cert-manager rotationPolicy för privat nyckel. |
ClientConfig
Inställningarna för Klientkonfiguration.
| Name | Typ | Description |
|---|---|---|
| maxKeepAliveSeconds |
integer (int32) minimum: 0maximum: 65535 |
Övre gräns för en klients Keep Alive på några sekunder. |
| maxMessageExpirySeconds |
integer (int32) minimum: 1 |
Övre gräns för meddelande förfallointervall i sekunder. |
| maxPacketSizeBytes |
integer (int32) minimum: 1maximum: 268435456 |
Maximal meddelandestorlek för ett paket i Bytes. |
| maxReceiveMaximum |
integer (int32) minimum: 1maximum: 65535 |
Övre gräns för Ta emot maximalt som en klient kan begära i CONNECT-paketet. |
| maxSessionExpirySeconds |
integer (int32) minimum: 1 |
Övre gräns för sessionens förfallointervall i sekunder. |
| subscriberQueueLimit |
Gränsen för antalet köade meddelanden för en prenumerant. |
createdByType
Den typ av identitet som skapade resursen.
| Värde | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DiagnosticsLogs
Egenskaper för diagnostiklogg
| Name | Typ | Standardvärde | Description |
|---|---|---|---|
| level |
string |
info |
Loggnivån Exempel – "felsökning", "info", "warn", "error", "trace". |
DiskBackedMessageBuffer
DiskBackedMessageBuffer-egenskaper
| Name | Typ | Description |
|---|---|---|
| ephemeralVolumeClaimSpec |
Använd den angivna mallen för beständiga volymanspråk för att montera en "allmän tillfällig volym" för meddelandebufferten. Se https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes för mer information. |
|
| maxSize |
string pattern: ^[0-9]+[KMGTPE]$ |
Den maximala storleken på meddelandebufferten på disken. Om en PVC-mall anges med hjälp av en av tillfälligaVolumeClaimSpec eller persistentVolumeClaimSpec, används den här storleken som begärande- och gränsstorlekar för mallen. Om varken efemeralVolumeClaimSpec eller persistentVolumeClaimSpec anges monteras en emptyDir-volym med den här storleken som gräns. Se https://kubernetes.io/docs/concepts/storage/volumes/#emptydir för mer information. |
| persistentVolumeClaimSpec |
Använd den angivna mallen för beständiga volymanspråk för att montera en beständig volym för meddelandebufferten. |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
| Name | Typ | Description |
|---|---|---|
| info |
object |
Ytterligare information. |
| type |
string |
Ytterligare informationstyp. |
ErrorDetail
Felinformationen.
| Name | Typ | Description |
|---|---|---|
| additionalInfo |
Ytterligare information om felet. |
|
| code |
string |
Felkoden. |
| details |
Felinformationen. |
|
| message |
string |
Felmeddelandet. |
| target |
string |
Felmålet. |
ErrorResponse
Felsvar
| Name | Typ | Description |
|---|---|---|
| error |
Felet objektet. |
ExtendedLocation
Utökad plats är ett tillägg av Azure-platser. De tillhandahåller ett sätt att använda sina Azure ARC-aktiverade Kubernetes-kluster som målplatser för distribution av Azure-tjänstinstanser.
| Name | Typ | Description |
|---|---|---|
| name |
string |
Namnet på den utökade platsen. |
| type |
Typ av ExtendedLocation. |
ExtendedLocationType
Den uppräkningsdefinieringstyp för ExtendedLocation som accepteras.
| Värde | Description |
|---|---|
| CustomLocation |
CustomLocation-typ |
Frontend
De önskade egenskaperna för klientdelsinstanserna i Broker
| Name | Typ | Standardvärde | Description |
|---|---|---|---|
| replicas |
integer (int32) minimum: 1maximum: 16 |
Önskat antal klientdelsinstanser (poddar). |
|
| workers |
integer (int32) minimum: 1maximum: 16 |
2 |
Antal logiska klientdelsarbetare per instans (podd). |
GenerateResourceLimits
Egenskaper för GenerateResourceLimits
| Name | Typ | Standardvärde | Description |
|---|---|---|---|
| cpu | Enabled |
Växlingsknappen för att aktivera/inaktivera cpu-resursgränser. |
HighPriorityMessagesBackpressureHandling
Hantering av högprioriterade meddelanden under backtryckstillstånd.
| Värde | Description |
|---|---|
| Accept |
När mäklaren avvisar meddelanden med vanlig prioritet på grund av mottryck fortsätter den att acceptera meddelanden med hög prioritet. |
| Reject |
När mäklaren avvisar meddelanden med ordinarie prioritet på grund av mottryck, avvisar den också meddelanden med hög prioritet. |
KubernetesReference
Kubernetes-referens
| Name | Typ | Description |
|---|---|---|
| apiGroup |
string |
APIGroup är gruppen för den resurs som refereras till. Om APIGroup inte har angetts måste den angivna typen finnas i kärn-API-gruppen. För andra typer av tredje part krävs APIGroup. |
| kind |
string |
Typ är den typ av resurs som refereras till |
| name |
string |
Namn är namnet på resursen som refereras |
| namespace |
string |
Namnområdet är namnområdet för resursen som refereras till. Det här fältet krävs när resursen har ett namnområde. |
LocalKubernetesReference
Kubernetes-referens
| Name | Typ | Description |
|---|---|---|
| apiGroup |
string |
APIGroup är gruppen för den resurs som refereras till. Om APIGroup inte har angetts måste den angivna typen finnas i kärn-API-gruppen. För andra typer av tredje part krävs APIGroup. |
| kind |
string |
Typ är den typ av resurs som refereras till |
| name |
string |
Namn är namnet på resursen som refereras |
Metrics
Egenskaper för diagnostikmått
| Name | Typ | Standardvärde | Description |
|---|---|---|---|
| prometheusPort |
integer (int32) minimum: 0maximum: 65535 |
9600 |
Prometheus-porten för att exponera måtten. |
OperationalMode
Lägesegenskaper
| Värde | Description |
|---|---|
| Enabled |
Aktiverad motsvarar Sant |
| Disabled |
Inaktiverad motsvarar Falskt. |
OperatorValues
Giltiga operatorer är In, NotIn, Exists och DoesNotExist.
| Värde | Description |
|---|---|
| In |
I operatorn. |
| NotIn |
NotIn-operatorn. |
| Exists |
Operatorn Exists. |
| DoesNotExist |
DoesNotExist-operatorn. |
PrivateKeyAlgorithm
Algoritmtyper för privata nycklar.
| Värde | Description |
|---|---|
| Ec256 |
Algoritm - ec256. |
| Ec384 |
Algoritm - ec384. |
| Ec521 |
Algoritm - ec521. |
| Ed25519 |
Algoritm - ed25519. |
| Rsa2048 |
Algoritm - rsa2048. |
| Rsa4096 |
Algoritm - rsa4096. |
| Rsa8192 |
Algoritm - rsa8192. |
PrivateKeyRotationPolicy
Roteringsprincip för privat nyckel.
| Värde | Description |
|---|---|
| Always |
Rotationspolicy – alltid. |
| Never |
Rotationspolicy - aldrig. |
ProvisioningState
Uppräkningen som definierar status för resursen.
| Värde | Description |
|---|---|
| Succeeded |
Resursen har skapats. |
| Failed |
Det gick inte att skapa resurser. |
| Canceled |
Resursskapandet avbröts. |
| Provisioning |
Resursen etableras. |
| Updating |
Resursen uppdateras. |
| Deleting |
Resursen tas bort. |
| Accepted |
Resursen har godkänts. |
ResourceHealthState
Resursens hälsotillstånd.
| Värde | Description |
|---|---|
| Available |
Resursen är tillgänglig och fungerar som förväntat. |
| Degraded |
Resurshälsan försämras. |
| Unavailable |
Resursen fungerar inte som förväntat. |
| Unknown |
Resurstillståndet är okänt. |
ResourceHealthStatus
Representerar hälsotillståndet för en resurs.
| Name | Typ | Description |
|---|---|---|
| lastTransitionTime |
string |
Tidsstämpeln (RFC3339) när hälsostatusen senast ändrades. |
| lastUpdateTime |
string |
Tidsstämpeln (RFC3339) när hälsostatusen senast uppdaterades, även om statusen inte ändrades. |
| message |
string |
Ett mänskligt läsbart meddelande som beskriver den senaste övergången. |
| reasonCode |
string |
Unik CamelCase resonationskod som beskriver orsaken till den senaste hälsotillståndsövergången. |
| status |
Resursens höga hälsostatus. |
SelfCheck
Egenskaper för broker Diagnostic Self check
| Name | Typ | Standardvärde | Description |
|---|---|---|---|
| intervalSeconds |
integer (int32) minimum: 30maximum: 300 |
30 |
Självkontrollintervallet. |
| mode | Enabled |
Växlingsknappen för att aktivera/inaktivera självkontroll. |
|
| timeoutSeconds |
integer (int32) minimum: 5maximum: 120 |
15 |
Tidsgränsen för självkontroll. |
SelfTracing
Egenskaper för självspårning av diagnostik
| Name | Typ | Standardvärde | Description |
|---|---|---|---|
| intervalSeconds |
integer (int32) minimum: 1maximum: 300 |
30 |
Självspårningsintervallet. |
| mode | Enabled |
Växlingsknappen för att aktivera/inaktivera självspårning. |
SubscriberMessageDropStrategy
Uppräkningen definierar strategier för att ta bort meddelanden från prenumerantkön.
| Värde | Description |
|---|---|
| None |
Meddelanden tas aldrig bort. |
| DropOldest |
Det äldsta meddelandet tas bort. |
SubscriberQueueLimit
Inställningarna för kögräns för prenumeranter.
| Name | Typ | Standardvärde | Description |
|---|---|---|---|
| length |
integer (int64) minimum: 1 |
Den maximala längden på kön innan meddelanden börjar tas bort. |
|
| strategy | None |
Den strategi som ska användas för att ta bort meddelanden från kön. |
systemData
Metadata som rör skapande och senaste ändring av resursen.
| Name | Typ | Description |
|---|---|---|
| createdAt |
string (date-time) |
Tidsstämpeln för resursskapande (UTC). |
| createdBy |
string |
Identiteten som skapade resursen. |
| createdByType |
Den typ av identitet som skapade resursen. |
|
| lastModifiedAt |
string (date-time) |
Tidsstämpeln för resursens senaste ändring (UTC) |
| lastModifiedBy |
string |
Identiteten som senast ändrade resursen. |
| lastModifiedByType |
Den typ av identitet som senast ändrade resursen. |
Traces
Egenskaper för asynkron diagnostikspårning
| Name | Typ | Standardvärde | Description |
|---|---|---|---|
| cacheSizeMegabytes |
integer (int32) minimum: 1maximum: 128 |
16 |
Cachestorleken i megabyte. |
| mode | Enabled |
Växlingsknappen för att aktivera/inaktivera spårningar. |
|
| selfTracing |
Egenskaperna för självspårning. |
||
| spanChannelCapacity |
integer (int32) minimum: 1000maximum: 100000 |
1000 |
Span-kanalkapaciteten. |
VolumeClaimResourceRequirements
VolumeClaimResourceRequirements-egenskaper
| Name | Typ | Description |
|---|---|---|
| claims |
Claims visar namnen på resurser, definierade i spec.resourceClaims, som används av den här containern. Det här är ett alfafält och kräver att funktionsgrinden DynamicResourceAllocation aktiveras. Det här fältet är oföränderligt. Den kan bara ställas in för behållare. |
|
| limits |
object |
Gränser beskriver den maximala mängden beräkningsresurser som tillåts. Mer information: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
| requests |
object |
Begäranden beskriver den minsta mängd beräkningsresurser som krävs. Om begäranden utelämnas för en container är det standardvärdet Gränser om det uttryckligen anges, i annat fall till ett implementeringsdefinierat värde. Mer information: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
VolumeClaimResourceRequirementsClaims
VolumeClaimResourceRequirementsClaims-egenskaper.
| Name | Typ | Description |
|---|---|---|
| name |
string |
Namn på resursen. Detta måste matcha namnet på en resurs i spec.resourceClaims. |
VolumeClaimSpec
VolumeClaimSpec-egenskaper
| Name | Typ | Description |
|---|---|---|
| accessModes |
string[] |
AccessModes innehåller de önskade access-lägen som volymen ska ha. Mer information: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
| dataSource |
Detta fält kan användas för att specificera antingen: * Ett befintligt VolumeSnapshot-objekt (snapshot.storage. k8s.io/VolumeSnapshot) * En befintlig PVC (PersistentVolumeClaim) Om provisioneraren eller en extern kontroller kan stödja den specificerade datakällan, kommer den att skapa en ny volym baserad på innehållet i den angivna datakällan. Om funktionsporten AnyVolumeDataSource är aktiverad har det här fältet alltid samma innehåll som fältet DataSourceRef. |
|
| dataSourceRef |
Anger det objekt som volymen ska fyllas från med data, om en volym som inte är tom önskas. Detta kan vara ett lokalt objekt från en icke-tom API-grupp (icke-kärnobjekt) eller ett PersistentVolumeClaim-objekt. När det här fältet har angetts lyckas volymbindningen endast om typen av det angivna objektet matchar någon installerad volymfyllare eller dynamisk provisioner. Det här fältet ersätter funktionerna i fältet DataSource och om båda fälten inte är tomma måste de ha samma värde. För bakåtkompatibilitet ställs båda fälten (DataSource och DataSourceRef) in på samma värde automatiskt om en av dem är tom och den andra inte är tom. Det finns två viktiga skillnader mellan DataSource och DataSourceRef: * DataSource tillåter endast två specifika typer av objekt, men DataSourceRef tillåter alla objekt som inte är kärnobjekt, samt PersistentVolumeClaim-objekt. * DataSource ignorerar otillåtna värden (släpper dem), men DataSourceRef bevarar alla värden och genererar ett fel om ett otillåtet värde har angetts. (Beta) Om du använder det här fältet måste funktionsporten AnyVolumeDataSource vara aktiverad. |
|
| resources |
Resurser representerar de minsta resurser som volymen ska ha. Om funktionen RecoverVolumeExpansionFailure är aktiverad kan användarna ange resurskrav som är lägre än tidigare värde men som fortfarande måste vara högre än kapaciteten som registrerats i statusfältet för anspråket. Mer information: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
|
| selector |
En etikettfråga över volymer att överväga för bindning. |
|
| storageClassName |
string |
Namnet på lagringsklassen som krävs av anspråket. Mer information: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
| volumeMode |
string |
volumeMode definierar vilken typ av volym som krävs av anspråket. Filsystemets värde är underförstått när det inte ingår i anspråksspecifikationen. Det här är en betafunktion. |
| volumeName |
string |
VolumeName är bindningsreferensen till PersistentVolume som stöder det här anspråket. |
VolumeClaimSpecSelector
Egenskaper för VolumeClaimSpecSelector
| Name | Typ | Description |
|---|---|---|
| matchExpressions |
MatchExpressions är en lista över krav för etikettväljare. Kraven är ANDed. |
|
| matchLabels |
object |
MatchLabels är en karta över {key,value}-par. En enda {nyckel,värde} i matchLabels-kartan motsvarar ett element av matchExpressions, vars nyckelfält är "key", operatorn är "In" och värdematrisen innehåller endast "värde". Kraven är ANDed. |
VolumeClaimSpecSelectorMatchExpressions
VolumeClaimSpecSelectorMatchExpressions-egenskaper
| Name | Typ | Description |
|---|---|---|
| key |
string |
nyckel är den etikettnyckel som väljaren gäller för. |
| operator |
operatorn representerar en nyckels relation till en uppsättning värden. Giltiga operatorer är In, NotIn, Exists och DoesNotExist. |
|
| values |
string[] |
värden är en matris med strängvärden. Om operatorn är I eller NotIn måste värdematrisen vara tom. Om operatorn är Finns eller DoesNotExist måste värdematrisen vara tom. Den här matrisen ersätts under en strategisk sammanslagningskorrigering. |