Broker - Create Or Update
Vytvořte zdroj makléře
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}?api-version=2025-10-01
Parametry identifikátoru URI
| Name | V | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
broker
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$ |
Název zprostředkovatele. |
|
instance
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$ |
Název instance. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Název skupiny prostředků. Název nerozlišuje malá a velká písmena. |
|
subscription
|
path | True |
string (uuid) |
ID cílového předplatného. Hodnota musí být UUID. |
|
api-version
|
query | True |
string minLength: 1 |
Verze rozhraní API, která se má použít pro tuto operaci. |
Text požadavku
| Name | Typ | Description |
|---|---|---|
| extendedLocation |
Hraniční umístění prostředku. |
|
| properties |
Vlastnosti specifické pro prostředek pro tento prostředek. |
Odpovědi
| Name | Typ | Description |
|---|---|---|
| 200 OK |
Operace aktualizace prostředku BrokerResource byla úspěšná |
|
| 201 Created |
Operace vytvoření prostředku BrokerResource byla úspěšná Hlavičky
|
|
| Other Status Codes |
Neočekávaná chybová odpověď |
Zabezpečení
azure_auth
Tok OAuth2 v Azure Active Directory
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
| Name | Description |
|---|---|
| user_impersonation | zosobnění uživatelského účtu |
Příklady
|
Broker_Create |
|
Broker_Create |
|
Broker_Create |
|
Broker_Create |
Broker_CreateOrUpdate
Ukázkový požadavek
PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2025-10-01
{
"properties": {
"advanced": {
"clients": {
"maxSessionExpirySeconds": 3859,
"maxMessageExpirySeconds": 3263,
"maxPacketSizeBytes": 3029,
"subscriberQueueLimit": {
"length": 6,
"strategy": "None"
},
"maxReceiveMaximum": 2365,
"maxKeepAliveSeconds": 3744
},
"encryptInternalTraffic": "Enabled",
"internalCerts": {
"duration": "bchrc",
"renewBefore": "xkafmpgjfifkwwrhkswtopdnne",
"privateKey": {
"algorithm": "Ec256",
"rotationPolicy": "Always"
}
}
},
"cardinality": {
"backendChain": {
"partitions": 11,
"redundancyFactor": 5,
"workers": 15
},
"frontend": {
"replicas": 2,
"workers": 6
}
},
"diagnostics": {
"logs": {
"level": "rnmwokumdmebpmfxxxzvvjfdywotav"
},
"metrics": {
"prometheusPort": 7581
},
"selfCheck": {
"mode": "Enabled",
"intervalSeconds": 158,
"timeoutSeconds": 14
},
"traces": {
"mode": "Enabled",
"cacheSizeMegabytes": 28,
"selfTracing": {
"mode": "Enabled",
"intervalSeconds": 22
},
"spanChannelCapacity": 1000
}
},
"diskBackedMessageBuffer": {
"maxSize": "500M",
"ephemeralVolumeClaimSpec": {
"volumeName": "c",
"volumeMode": "rxvpksjuuugqnqzeiprocknbn",
"storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
"accessModes": [
"nuluhigrbb"
],
"dataSource": {
"apiGroup": "npqapyksvvpkohujx",
"kind": "wazgyb",
"name": "cwhsgxxcxsyppoefm"
},
"dataSourceRef": {
"apiGroup": "mnfnykznjjsoqpfsgdqioupt",
"kind": "odynqzekfzsnawrctaxg",
"name": "envszivbbmixbyddzg",
"namespace": "etcfzvxqd"
},
"resources": {
"limits": {
"key2719": "hmphcrgctu"
},
"requests": {
"key2909": "txocprnyrsgvhfrg"
}
},
"selector": {
"matchExpressions": [
{
"key": "e",
"operator": "In",
"values": [
"slmpajlywqvuyknipgztsonqyybt"
]
}
],
"matchLabels": {
"key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
}
}
},
"persistentVolumeClaimSpec": {
"volumeName": "c",
"volumeMode": "rxvpksjuuugqnqzeiprocknbn",
"storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
"accessModes": [
"nuluhigrbb"
],
"dataSource": {
"apiGroup": "npqapyksvvpkohujx",
"kind": "wazgyb",
"name": "cwhsgxxcxsyppoefm"
},
"dataSourceRef": {
"apiGroup": "mnfnykznjjsoqpfsgdqioupt",
"kind": "odynqzekfzsnawrctaxg",
"name": "envszivbbmixbyddzg",
"namespace": "etcfzvxqd"
},
"resources": {
"limits": {
"key2719": "hmphcrgctu"
},
"requests": {
"key2909": "txocprnyrsgvhfrg"
}
},
"selector": {
"matchExpressions": [
{
"key": "e",
"operator": "In",
"values": [
"slmpajlywqvuyknipgztsonqyybt"
]
}
],
"matchLabels": {
"key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
}
}
}
},
"generateResourceLimits": {
"cpu": "Enabled"
},
"memoryProfile": "Tiny"
},
"extendedLocation": {
"name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
"type": "CustomLocation"
}
}
Ukázková odpověď
{
"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_Complex
Ukázkový požadavek
PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2025-10-01
{
"properties": {
"cardinality": {
"backendChain": {
"partitions": 2,
"redundancyFactor": 2,
"workers": 2
},
"frontend": {
"replicas": 2,
"workers": 2
}
},
"diskBackedMessageBuffer": {
"maxSize": "50M"
},
"generateResourceLimits": {
"cpu": "Enabled"
},
"memoryProfile": "Medium"
},
"extendedLocation": {
"name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
"type": "CustomLocation"
}
}
Ukázková odpověď
{
"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
Ukázkový požadavek
PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2025-10-01
{
"properties": {
"memoryProfile": "Tiny"
},
"extendedLocation": {
"name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
"type": "CustomLocation"
}
}
Ukázková odpověď
{
"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
Ukázkový požadavek
PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2025-10-01
{
"properties": {
"cardinality": {
"backendChain": {
"partitions": 2,
"redundancyFactor": 2,
"workers": 2
},
"frontend": {
"replicas": 2,
"workers": 2
}
},
"generateResourceLimits": {
"cpu": "Enabled"
},
"memoryProfile": "Low"
},
"extendedLocation": {
"name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
"type": "CustomLocation"
}
}
Ukázková odpověď
{
"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"
}
}
Definice
| Name | Description |
|---|---|
|
Advanced |
Pokročilá nastavení brokera |
|
Backend |
Požadované vlastnosti back-endových instancí brokera |
|
Broker |
Vlastnosti nastavení diagnostiky zprostředkovatele |
|
Broker |
Nastavení paměťového profilu Brokeru |
|
Broker |
Konfigurace trvalosti disku. Pokud je trvalost povolena, určité položky (data nekritická z hlediska výkonu) vybrané pro trvalost budou uloženy pouze na disku. Níže jsou uvedeny dotčené položky:
Optional. Vše je v paměti, pokud není nastaveno. Poznámka: Pokud je nakonfigurováno, všechny stavy relace MQTT se zapisují na disk. |
|
Broker |
Vlastnosti šifrování trvalosti zprostředkovatele. |
|
Broker |
Hodnoty režimu zásad trvalosti zprostředkovatele. |
|
Broker |
Vlastnosti prostředku zprostředkovatele |
|
Broker |
Prostředek zprostředkovatele instancí |
|
Broker |
Zásady zachování zpráv vlastního zprostředkovatele. |
|
Broker |
Dynamické nastavení BrokerRetainMessagesCustomPolicy. |
|
Broker |
Zprostředkovatel Zachovat vlastnosti Zprávy. |
|
Broker |
Vlastní zásady úložiště stavů brokera. |
|
Broker |
Dynamické nastavení BrokerStateStoreCustomPolicy. |
|
Broker |
Vlastnosti typu klíče úložiště stavů zprostředkovatele. |
|
Broker |
Vlastnosti prostředků zásad úložiště stavů zprostředkovatele. |
|
Broker |
Vlastní nastavení zásad úložiště stavů zprostředkovatele. |
|
Broker |
Vlastní vlastnosti zásad fronty odběratelů. |
|
Broker |
Vlastnosti vlastních zásad fronty odběratelů zprostředkovatele. |
|
Broker |
Dynamické nastavení BrokerSubscriberQueueCustomPolicy. |
| Cardinality |
Vlastnosti kardinality |
|
Cert |
Vlastnosti certifikátu Správce certifikátů |
|
Cert |
Vlastnosti privátního klíče Správce certifikátů |
|
Client |
Nastavení konfigurace klienta. |
|
created |
Typ identity, která prostředek vytvořila. |
|
Diagnostics |
Vlastnosti diagnostického protokolu |
|
Disk |
Vlastnosti DiskBackedMessageBuffer |
|
Error |
Další informace o chybě správy prostředků |
|
Error |
Podrobnosti o chybě. |
|
Error |
Chybová odpověď |
|
Extended |
Rozšířená lokalita je rozšířením lokalit Azure. Poskytují způsob, jak používat clustery Kubernetes s podporou Azure ARC jako cílová umístění pro nasazení instancí služeb Azure. |
|
Extended |
Typ definující výčet ExtendedLocation byl přijat. |
| Frontend |
Požadované vlastnosti frontendových instancí brokera |
|
Generate |
Vlastnosti GenerateResourceLimits |
|
Kubernetes |
Referenční informace ke Kubernetes |
|
Local |
Referenční informace ke Kubernetes |
| Metrics |
Vlastnosti diagnostických metrik |
|
Operational |
Vlastnosti režimu |
|
Operator |
Platné operátory jsou In, NotIn, Exists a DoesNotExist. |
|
Private |
Typy algoritmů privátního klíče. |
|
Private |
Zásady obměny privátních klíčů. |
|
Provisioning |
Výčet definující stav zdroje. |
|
Resource |
Stav prostředku. |
|
Self |
Vlastnosti samokontroly diagnostiky zprostředkovatele |
|
Self |
Diagnostické vlastnosti samotrasování |
|
Subscriber |
Výčet definující strategie pro vyřazování zpráv z fronty odběratelů. |
|
Subscriber |
Nastavení limitu fronty odběratelů. |
|
system |
Metadata týkající se vytvoření a poslední změny prostředku. |
| Traces |
Vlastnosti diagnostického trasování zprostředkovatele |
|
Volume |
Vlastnosti produktu VolumeClaimResourceRequirements |
|
Volume |
VolumeClaimResourceRequirementsClaims. |
|
Volume |
Vlastnosti VolumeClaimSpec |
|
Volume |
Vlastnosti nástroje VolumeClaimSpecSelector |
|
Volume |
Vlastnosti VolumeClaimSpecSelectorMatchExpressions |
AdvancedSettings
Pokročilá nastavení brokera
| Name | Typ | Default value | Description |
|---|---|---|---|
| clients |
Konfigurace související se všemi klienty |
||
| encryptInternalTraffic | Enabled |
Nastavení pro povolení nebo zakázání šifrování interního provozu. |
|
| internalCerts |
Obměně certifikátů a konfigurace privátního klíče |
BackendChain
Požadované vlastnosti back-endových instancí brokera
| Name | Typ | Default value | Description |
|---|---|---|---|
| partitions |
integer (int32) minimum: 1maximum: 16 |
Požadovaný počet fyzických back-endových oddílů. |
|
| redundancyFactor |
integer (int32) minimum: 1maximum: 5 |
Požadovaný počet back-endových replik (podů) ve fyzickém oddílu. |
|
| workers |
integer (int32) minimum: 1maximum: 16 |
1 |
Počet logických back-endových pracovních procesů na repliku (pod). |
BrokerDiagnostics
Vlastnosti nastavení diagnostiky zprostředkovatele
| Name | Typ | Description |
|---|---|---|
| logs |
Nastavení diagnostického protokolu pro prostředek |
|
| metrics |
Nastavení metrik pro prostředek. |
|
| selfCheck |
Vlastnosti kontroly sebe sama. |
|
| traces |
Vlastnosti trasování. |
BrokerMemoryProfile
Nastavení paměťového profilu Brokeru
| Hodnota | Description |
|---|---|
| Tiny |
Malý paměťový profil. |
| Low |
Profil s nízkou pamětí. |
| Medium |
Střední paměťový profil. |
| High |
Profil s vysokou pamětí. |
BrokerPersistence
Konfigurace trvalosti disku.
Pokud je trvalost povolena, určité položky (data nekritická z hlediska výkonu) vybrané pro trvalost budou uloženy pouze na disku. Níže jsou uvedeny dotčené položky:
- Uchovávané zprávy budou uloženy pouze na disku.
- Zprávy WILL budou uloženy pouze na disku.
- Páry klíč/hodnota DSS budou uloženy pouze na disku, s výjimkou položek kritických z hlediska výkonu, jako jsou časované zámky, které zůstávají na disku i v paměti pro zlepšení výkonu.
Optional. Vše je v paměti, pokud není nastaveno. Poznámka: Pokud je nakonfigurováno, všechny stavy relace MQTT se zapisují na disk.
| Name | Typ | Description |
|---|---|---|
| encryption |
Řídí nastavení související se šifrováním databáze trvalosti. Volitelné, výchozí nastavení povolí šifrování. |
|
| maxSize |
string |
Maximální velikost vyrovnávací paměti zprávy na disku. Pokud je šablona PVC zadána pomocí persistentVolumeClaimSpec, použije se tato velikost jako požadavek a omezí velikost této šablony. Pokud není zadána šablona PVC, je požadován zřizovač místní cesty s tímto omezením velikosti. Povinné. |
| persistentVolumeClaimSpec |
K připojení trvalého svazku použijte určenou šablonu deklarace trvalého svazku. Stejný objekt jako v diskBackedMessageBuffer, ale s omezením, že pole režimů přístupu musí být nastaveno na . Pokud tato možnost není nastavená, použije se výchozí PVC s výchozími vlastnostmi. Tento PVC bude mimo jiné používat výchozí třídu úložiště clusteru, která může, ale nemusí používat zřizovatele místních cest. Uživatel se rozhodne pro suboptimální chování, pokud toto nastavení ponechá nenastavené nebo jej nastaví bez pole třídy úložiště a jeho výchozí nastavení clusteru není místní třídou cesty. |
|
| retain | BrokerRetainMessagesPolicy: |
Určuje, které zprávy z tématu by měly být uloženy na disku. |
| stateStore | BrokerStateStorePolicy: |
Určuje, které klíče by měly být uloženy na disku pro úložiště stavů. |
| subscriberQueue | BrokerSubscriberQueuePolicy: |
Určuje, které fronty zpráv odběratele mají být uloženy na disku. Důležité: pro usnadnění opětovného připojení se metadata stavu relace VŽDY zapisují na disk, pokud je zadáno jakékoli nastavení trvalosti, i když tato část není nastavena. |
BrokerPersistenceEncryption
Vlastnosti šifrování trvalosti zprostředkovatele.
| Name | Typ | Description |
|---|---|---|
| mode |
Určuje, zda je povoleno šifrování. |
BrokerPersistencePolicyMode
Hodnoty režimu zásad trvalosti zprostředkovatele.
| Hodnota | Description |
|---|---|
| All |
Režim zásad pro všechny. |
| None |
Režim zásad pro Žádný. |
| Custom |
Označuje, že zásada je vlastní zásadou. |
BrokerProperties
Vlastnosti prostředku zprostředkovatele
| Name | Typ | Default value | Description |
|---|---|---|---|
| advanced |
Upřesňující nastavení zprostředkovatele. |
||
| cardinality |
Podrobnosti kardinality zprostředkovatele. |
||
| diagnostics |
Specifikace definuje požadované identity nastavení diagnostiky zprostředkovatele. |
||
| diskBackedMessageBuffer |
Nastavení vyrovnávací paměti zpráv na disku. |
||
| generateResourceLimits |
Toto nastavení určuje, jestli jsou požadovány limity prostředků procesoru Kubernetes. Zvýšení počtu replik nebo pracovních procesů úměrně zvyšuje množství požadovaných prostředků procesoru. Pokud je toto nastavení povolené a není k dispozici dostatek prostředků procesoru, vygeneruje se chyba. |
||
| healthState | Unknown |
Stav prostředku. |
|
| memoryProfile | Medium |
Profil paměti zprostředkovatele. |
|
| persistence |
Nastavení perzistence Brokera. |
||
| provisioningState |
Stav poslední operace. |
BrokerResource
Prostředek zprostředkovatele instancí
| Name | Typ | Description |
|---|---|---|
| extendedLocation |
Hraniční umístění prostředku. |
|
| id |
string (arm-id) |
Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
| name |
string |
Název prostředku |
| properties |
Vlastnosti specifické pro prostředek pro tento prostředek. |
|
| systemData |
Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil. |
|
| type |
string |
Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts |
BrokerRetainMessagesCustomPolicy
Zásady zachování zpráv vlastního zprostředkovatele.
| Name | Typ | Description |
|---|---|---|
| mode |
string:
Custom |
"Vše" pro zachování všech zpráv, "Žádné" pro zachování žádné, "Vlastní" pro zachování pouze určených témat. |
| retainSettings |
Nastavení zásady. |
BrokerRetainMessagesDynamic
Dynamické nastavení BrokerRetainMessagesCustomPolicy.
| Name | Typ | Description |
|---|---|---|
| mode |
Režim BrokerRetainMessagesCustomPolicy. |
BrokerRetainMessagesSettings
Zprostředkovatel Zachovat vlastnosti Zprávy.
| Name | Typ | Description |
|---|---|---|
| dynamic |
Určuje, zda klienti MQTT mohou požádat o perzistenci disku prostřednictvím |
|
| topics |
string[] |
Seznam témat, ve kterých budou uchovávané zprávy uloženy na disku. Zástupné znaky # a + podporovány. |
BrokerStateStoreCustomPolicy
Vlastní zásady úložiště stavů brokera.
| Name | Typ | Description |
|---|---|---|
| mode |
string:
Custom |
"Vše" pro zachování všech klíčů, "Žádné" pro zachování žádných, "Vlastní" pro zachování pouze určených klíčů. |
| stateStoreSettings |
Nastavení zásady. |
BrokerStateStoreDynamic
Dynamické nastavení BrokerStateStoreCustomPolicy.
| Name | Typ | Description |
|---|---|---|
| mode |
Režim BrokerStateStoreCustomPolicy. |
BrokerStateStoreKeyType
Vlastnosti typu klíče úložiště stavů zprostředkovatele.
| Hodnota | Description |
|---|---|
| Pattern |
Používá se pro porovnávání vzorů ve stylu glob. |
| String |
Slouží k přesné shodě, například když klíč obsahuje znaky, které by jinak mohly být porovnány jako vzor (*, ?, [0-9]). |
| Binary |
Slouží k vyhledání binárního klíče. |
BrokerStateStorePolicyResources
Vlastnosti prostředků zásad úložiště stavů zprostředkovatele.
| Name | Typ | Description |
|---|---|---|
| keyType |
Klíč k zachování na disku. |
|
| keys |
string[] |
Seznam klíčů pro uchování na disku, povinný. |
BrokerStateStorePolicySettings
Vlastní nastavení zásad úložiště stavů zprostředkovatele.
| Name | Typ | Description |
|---|---|---|
| dynamic |
Určuje, zda klienti MQTT mohou požádat o perzistenci disku prostřednictvím |
|
| stateStoreResources |
Seznam klíčů a typů klíčů, které se mají uchovat na disku. |
BrokerSubscriberQueueCustomPolicy
Vlastní vlastnosti zásad fronty odběratelů.
| Name | Typ | Description |
|---|---|---|
| mode |
string:
Custom |
"Vše" pro zachování všech fronty odběratelů, "Žádné" pro zachování žádné, "Vlastní" pro zachování pouze zadaných front. |
| subscriberQueueSettings |
Vlastní zásada, která je vyžadována, pokud je mode nastaven na Vlastní. Fronty odběratelů ze všech skupin jsou uloženy na disku (logické OR). |
BrokerSubscriberQueueCustomPolicySettings
Vlastnosti vlastních zásad fronty odběratelů zprostředkovatele.
| Name | Typ | Description |
|---|---|---|
| dynamic |
Určuje, zda klienti MQTT mohou požádat o perzistenci disku prostřednictvím |
|
| subscriberClientIds |
string[] |
Seznam ID klientů předplatitelů, zástupný znak * podporováno. |
BrokerSubscriberQueueDynamic
Dynamické nastavení BrokerSubscriberQueueCustomPolicy.
| Name | Typ | Description |
|---|---|---|
| mode |
Režim BrokerSubscriberQueueCustomPolicy. |
Cardinality
Vlastnosti kardinality
| Name | Typ | Description |
|---|---|---|
| backendChain |
Požadované vlastnosti zprostředkovatele back-endu |
|
| frontend |
Požadované vlastnosti front-endu |
CertManagerCertOptions
Vlastnosti certifikátu Správce certifikátů
| Name | Typ | Description |
|---|---|---|
| duration |
string |
Životnost certifikátu. Je nutné zadat pomocí času Go. Formát doby trvání (h|m|s). Např. 240h po dobu 240 hodin a 45 min. po dobu 45 minut. |
| privateKey |
Konfigurace privátního klíče certifikátu |
|
| renewBefore |
string |
Kdy začít obnovovat certifikát. Je nutné zadat pomocí času Go. Formát doby trvání (h|m|s). Např. 240h po dobu 240 hodin a 45 min. po dobu 45 minut. |
CertManagerPrivateKey
Vlastnosti privátního klíče Správce certifikátů
| Name | Typ | Description |
|---|---|---|
| algorithm |
algoritmus pro privátní klíč. |
|
| rotationPolicy |
rotace privátního klíče cert-managerZásady. |
ClientConfig
Nastavení konfigurace klienta.
| Name | Typ | Description |
|---|---|---|
| maxKeepAliveSeconds |
integer (int32) minimum: 0maximum: 65535 |
Horní mez udržování klienta v sekundách. |
| maxMessageExpirySeconds |
integer (int32) minimum: 1 |
Horní mez intervalu vypršení platnosti zprávy v sekundách. |
| maxPacketSizeBytes |
integer (int32) minimum: 1maximum: 268435456 |
Maximální velikost zprávy pro paket v bajtech |
| maxReceiveMaximum |
integer (int32) minimum: 1maximum: 65535 |
Horní mez maximálního příjmu, kterou klient může požadovat v paketu CONNECT. |
| maxSessionExpirySeconds |
integer (int32) minimum: 1 |
Horní mez intervalu vypršení platnosti relace v sekundách. |
| subscriberQueueLimit |
Omezení počtu zpráv zařazených do fronty pro odběratele. |
createdByType
Typ identity, která prostředek vytvořila.
| Hodnota | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DiagnosticsLogs
Vlastnosti diagnostického protokolu
| Name | Typ | Default value | Description |
|---|---|---|---|
| level |
string |
info |
Úroveň protokolování Příklady – debug, info, warn, error, trace. |
DiskBackedMessageBuffer
Vlastnosti DiskBackedMessageBuffer
| Name | Typ | Description |
|---|---|---|
| ephemeralVolumeClaimSpec |
K připojení obecného dočasného svazku pro vyrovnávací paměť zprávy použijte zadanou šablonu deklarace trvalého svazku. Podrobnosti najdete v https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes. |
|
| maxSize |
string pattern: ^[0-9]+[KMGTPE]$ |
Maximální velikost vyrovnávací paměti zprávy na disku. Pokud je šablona PVC zadaná pomocí některé z dočasnýchvolumeralVolumeClaimSpec nebo persistentVolumeClaimSpec, použije se tato velikost jako požadavek a omezení velikosti této šablony. Pokud není zadán žádný dočasnýVolumemeClaimSpec ani persistentVolumeClaimSpec, pak je prázdný svazekDir připojen s touto velikostí jako jeho limit. Podrobnosti najdete v https://kubernetes.io/docs/concepts/storage/volumes/#emptydir. |
| persistentVolumeClaimSpec |
K připojení trvalého svazku pro vyrovnávací paměť zprávy použijte zadanou šablonu deklarace identity trvalého svazku. |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
| Name | Typ | Description |
|---|---|---|
| info |
object |
Další informace. |
| type |
string |
Další typ informací. |
ErrorDetail
Podrobnosti o chybě.
| Name | Typ | Description |
|---|---|---|
| additionalInfo |
Další informace o chybě. |
|
| code |
string |
Kód chyby. |
| details |
Podrobnosti o chybě. |
|
| message |
string |
Chybová zpráva. |
| target |
string |
Cíl chyby. |
ErrorResponse
Chybová odpověď
| Name | Typ | Description |
|---|---|---|
| error |
Objekt chyby. |
ExtendedLocation
Rozšířená lokalita je rozšířením lokalit Azure. Poskytují způsob, jak používat clustery Kubernetes s podporou Azure ARC jako cílová umístění pro nasazení instancí služeb Azure.
| Name | Typ | Description |
|---|---|---|
| name |
string |
Název rozšířeného umístění. |
| type |
Typ ExtendedLocation. |
ExtendedLocationType
Typ definující výčet ExtendedLocation byl přijat.
| Hodnota | Description |
|---|---|
| CustomLocation |
Typ CustomLocation |
Frontend
Požadované vlastnosti frontendových instancí brokera
| Name | Typ | Default value | Description |
|---|---|---|---|
| replicas |
integer (int32) minimum: 1maximum: 16 |
Požadovaný počet instancí front-endu (podů). |
|
| workers |
integer (int32) minimum: 1maximum: 16 |
2 |
Počet logických front-endových pracovních procesů na instanci (pod). |
GenerateResourceLimits
Vlastnosti GenerateResourceLimits
| Name | Typ | Default value | Description |
|---|---|---|---|
| cpu | Enabled |
Přepínač pro povolení nebo zakázání limitů prostředků procesoru. |
KubernetesReference
Referenční informace ke Kubernetes
| Name | Typ | Description |
|---|---|---|
| apiGroup |
string |
SKUPINA APIGroup je skupina pro odkazovaný prostředek. Pokud není zadána skupina APIGroup, musí být zadaný druh v základní skupině rozhraní API. Pro všechny ostatní typy třetích stran se vyžaduje skupina APIGroup. |
| kind |
string |
Druh je typ odkazovaného prostředku. |
| name |
string |
Název je název odkazovaného prostředku. |
| namespace |
string |
Obor názvů je obor názvů odkazovaného prostředku. Toto pole je povinné, pokud má prostředek obor názvů. |
LocalKubernetesReference
Referenční informace ke Kubernetes
| Name | Typ | Description |
|---|---|---|
| apiGroup |
string |
SKUPINA APIGroup je skupina pro odkazovaný prostředek. Pokud není zadána skupina APIGroup, musí být zadaný druh v základní skupině rozhraní API. Pro všechny ostatní typy třetích stran se vyžaduje skupina APIGroup. |
| kind |
string |
Druh je typ odkazovaného prostředku. |
| name |
string |
Název je název odkazovaného prostředku. |
Metrics
Vlastnosti diagnostických metrik
| Name | Typ | Default value | Description |
|---|---|---|---|
| prometheusPort |
integer (int32) minimum: 0maximum: 65535 |
9600 |
Port prometheus pro zveřejnění metrik. |
OperationalMode
Vlastnosti režimu
| Hodnota | Description |
|---|---|
| Enabled |
Povoleno je ekvivalentní True |
| Disabled |
Zakázáno je ekvivalentní hodnotě False. |
OperatorValues
Platné operátory jsou In, NotIn, Exists a DoesNotExist.
| Hodnota | Description |
|---|---|
| In |
V operátoru. |
| NotIn |
Operátor NotIn. |
| Exists |
Operátor existuje. |
| DoesNotExist |
DoesNotExist – operátor. |
PrivateKeyAlgorithm
Typy algoritmů privátního klíče.
| Hodnota | Description |
|---|---|
| Ec256 |
Algoritmus - ec256. |
| Ec384 |
Algoritmus - ec384. |
| Ec521 |
Algoritmus - ec521. |
| Ed25519 |
Algoritmus - ed25519. |
| Rsa2048 |
Algoritmus - rsa2048. |
| Rsa4096 |
Algoritmus - rsa4096. |
| Rsa8192 |
Algoritmus - rsa8192. |
PrivateKeyRotationPolicy
Zásady obměny privátních klíčů.
| Hodnota | Description |
|---|---|
| Always |
Zásady rotace - Vždy. |
| Never |
Rotation Policy - Nikdy. |
ProvisioningState
Výčet definující stav zdroje.
| Hodnota | Description |
|---|---|
| Succeeded |
Zdroj byl vytvořen. |
| Failed |
Vytvoření zdroje se nezdařilo. |
| Canceled |
Vytváření zdrojů bylo zrušeno. |
| Provisioning |
Prostředek se zřizuje. |
| Updating |
Zdroj se aktualizuje. |
| Deleting |
Prostředek se odstraňuje. |
| Accepted |
Zdroj byl přijat. |
ResourceHealthState
Stav prostředku.
| Hodnota | Description |
|---|---|
| Available |
Zdroj je k dispozici a funguje podle očekávání. |
| Degraded |
Stav prostředků je omezený. |
| Unavailable |
Prostředek nefunguje podle očekávání. |
| Unknown |
Stav prostředku není znám. |
SelfCheck
Vlastnosti samokontroly diagnostiky zprostředkovatele
| Name | Typ | Default value | Description |
|---|---|---|---|
| intervalSeconds |
integer (int32) minimum: 30maximum: 300 |
30 |
Interval kontroly sebe sama. |
| mode | Enabled |
Přepínač pro povolení nebo zakázání samoobslužné kontroly. |
|
| timeoutSeconds |
integer (int32) minimum: 5maximum: 120 |
15 |
Časový limit pro vlastní kontrolu. |
SelfTracing
Diagnostické vlastnosti samotrasování
| Name | Typ | Default value | Description |
|---|---|---|---|
| intervalSeconds |
integer (int32) minimum: 1maximum: 300 |
30 |
Interval vlastního trasování. |
| mode | Enabled |
Přepínač pro povolení nebo zakázání vlastního trasování. |
SubscriberMessageDropStrategy
Výčet definující strategie pro vyřazování zpráv z fronty odběratelů.
| Hodnota | Description |
|---|---|
| None |
Zprávy nejsou nikdy vyřazeny. |
| DropOldest |
Nejstarší zpráva je zahozena. |
SubscriberQueueLimit
Nastavení limitu fronty odběratelů.
| Name | Typ | Default value | Description |
|---|---|---|---|
| length |
integer (int64) minimum: 1 |
Maximální délka fronty před zahájením vyřazení zpráv. |
|
| strategy | None |
Strategie, která se má použít pro vyřazení zpráv z fronty |
systemData
Metadata týkající se vytvoření a poslední změny prostředku.
| Name | Typ | Description |
|---|---|---|
| createdAt |
string (date-time) |
Časové razítko vytvoření prostředku (UTC). |
| createdBy |
string |
Identita, která prostředek vytvořila. |
| createdByType |
Typ identity, která prostředek vytvořila. |
|
| lastModifiedAt |
string (date-time) |
Časové razítko poslední změny zdroje (UTC) |
| lastModifiedBy |
string |
Identita, která naposledy změnila prostředek. |
| lastModifiedByType |
Typ identity, která naposledy změnila prostředek. |
Traces
Vlastnosti diagnostického trasování zprostředkovatele
| Name | Typ | Default value | Description |
|---|---|---|---|
| cacheSizeMegabytes |
integer (int32) minimum: 1maximum: 128 |
16 |
Velikost mezipaměti v megabajtech. |
| mode | Enabled |
Přepínač pro povolení nebo zakázání trasování. |
|
| selfTracing |
Vlastnosti vlastního trasování. |
||
| spanChannelCapacity |
integer (int32) minimum: 1000maximum: 100000 |
1000 |
Kapacita kanálu span. |
VolumeClaimResourceRequirements
Vlastnosti produktu VolumeClaimResourceRequirements
| Name | Typ | Description |
|---|---|---|
| claims |
Deklarace identity uvádí názvy prostředků definovaných v spec.resourceClaims, které jsou používány tímto kontejnerem. Jedná se o pole alfa a vyžaduje povolení brány funkce DynamicResourceAllocation. Toto pole je neměnné. Lze ji nastavit pouze pro kontejnery. |
|
| limits |
object |
Omezení popisují maximální povolený počet výpočetních prostředků. Další informace: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
| requests |
object |
Požadavky popisují minimální požadovaný objem výpočetních prostředků. Pokud pro kontejner vynecháte požadavky, ve výchozím nastavení se nastaví omezení, pokud je explicitně zadáno, jinak na hodnotu definovanou implementací. Další informace: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
VolumeClaimResourceRequirementsClaims
VolumeClaimResourceRequirementsClaims.
| Name | Typ | Description |
|---|---|---|
| name |
string |
Název prostředku To se musí shodovat s názvem prostředku v spec.resourceClaims. |
VolumeClaimSpec
Vlastnosti VolumeClaimSpec
| Name | Typ | Description |
|---|---|---|
| accessModes |
string[] |
AccessModes obsahuje požadované režimy přístupu, které má mít svazek. Další informace: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
| dataSource |
Toto pole lze použít k určení: * Existující objekt VolumeSnapshot (snapshot.storage.k8s.io/VolumeSnapshot) * Existující PVC (PersistentVolumeClaim) Pokud zřizovací nebo externí kontroler může podporovat zadaný zdroj dat, vytvoří nový svazek na základě obsahu zadaného zdroje dat. Pokud je povolená brána funkce AnyVolumeDataSource, bude mít toto pole vždy stejný obsah jako pole DataSourceRef. |
|
| dataSourceRef |
Určuje objekt, ze kterého se má svazek naplnit daty, pokud je vyžadován neprázdný svazek. Může se jednat o jakýkoli místní objekt z neprázdné skupiny rozhraní API (nejádrový objekt) nebo objektu PersistentVolumeClaim. Pokud je toto pole zadáno, vazba svazku bude úspěšná pouze v případě, že typ zadaného objektu odpovídá některému nainstalovanému překupovači svazku nebo dynamickému zřizování. Toto pole nahradí funkčnost pole Zdroj dat a pokud jsou obě pole neprázdná, musí mít stejnou hodnotu. Pro zpětnou kompatibilitu se obě pole (DataSource a DataSourceRef) nastaví na stejnou hodnotu automaticky, pokud je jedna z nich prázdná a druhá je neprázdná. Existují dva důležité rozdíly mezi DataSource a DataSourceRef: * Zatímco DataSource umožňuje pouze dva konkrétní typy objektů, DataSourceRef umožňuje jakýkoli jiný než základní objekt, stejně jako PersistentVolumeClaim objekty. * Zatímco DataSource ignoruje nepovolené hodnoty (vyřazuje je), DataSourceRef zachová všechny hodnoty a vygeneruje chybu, pokud je zadána nepovolené hodnoty. (Beta verze) Použití tohoto pole vyžaduje povolení brány funkcí AnyVolumeDataSource. |
|
| resources |
Prostředky představují minimální prostředky, které má svazek mít. Pokud je povolená funkce RecoverVolumeExpansionFailure, můžou uživatelé zadat požadavky na prostředky, které jsou nižší než předchozí hodnota, ale musí být stále vyšší než kapacita zaznamenaná v poli stavu deklarace identity. Další informace: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
|
| selector |
Dotaz popisku nad svazky, který je potřeba zvážit pro vazbu. |
|
| storageClassName |
string |
Název třídy StorageClass vyžadované deklarací identity Další informace: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
| volumeMode |
string |
volumeMode definuje, jaký typ svazku vyžaduje deklarace identity. Hodnota systému souborů je implicitní, pokud není zahrnuta ve specifikaci deklarace identity. Toto je beta funkce. |
| volumeName |
string |
VolumeName je odkaz na vazbu na PersistentVolume, který tuto deklaraci identity zálohuje. |
VolumeClaimSpecSelector
Vlastnosti nástroje VolumeClaimSpecSelector
| Name | Typ | Description |
|---|---|---|
| matchExpressions |
MatchExpressions je seznam požadavků selektoru popisků. Požadavky jsou ANDed. |
|
| matchLabels |
object |
MatchLabels je mapa párů {key,value}. Jeden {klíč,value} v mapě matchLabels je ekvivalentní elementu matchExpressions, jehož pole klíče je "klíč", operátor je "In" a pole hodnot obsahuje pouze "value". Požadavky jsou ANDed. |
VolumeClaimSpecSelectorMatchExpressions
Vlastnosti VolumeClaimSpecSelectorMatchExpressions
| Name | Typ | Description |
|---|---|---|
| key |
string |
key je klávesa popisku, na kterou selektor vztahuje. |
| operator |
operátor představuje vztah klíče k sadě hodnot. Platné operátory jsou In, NotIn, Exists a DoesNotExist. |
|
| values |
string[] |
hodnoty jsou pole řetězcových hodnot. Pokud je operátor In nebo NotIn, musí být pole hodnot neprázdné. Pokud je operátor Exists nebo DoesNotExist, musí být pole hodnot prázdné. Toto pole se nahradí během strategické opravy sloučení. |