Broker - Create Or Update
Créer un courtierRessource
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}?api-version=2025-10-01
Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
broker
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$ |
Nom du répartiteur. |
|
instance
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$ |
Nom de l’instance. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Nom du groupe de ressources. Le nom ne respecte pas la casse. |
|
subscription
|
path | True |
string (uuid) |
ID de l’abonnement cible. La valeur doit être un UUID. |
|
api-version
|
query | True |
string minLength: 1 |
Version de l’API à utiliser pour cette opération. |
Corps de la demande
| Nom | Type | Description |
|---|---|---|
| extendedLocation |
Emplacement de périphérie de la ressource. |
|
| properties |
Propriétés spécifiques à la ressource pour cette ressource. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
Réussite de l’opération de mise à jour de la ressource 'BrokerResource' |
|
| 201 Created |
Réussite de l’opération de création de la ressource 'BrokerResource' En-têtes
|
|
| Other Status Codes |
Réponse d’erreur inattendue. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory.
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
| Nom | Description |
|---|---|
| user_impersonation | emprunter l’identité de votre compte d’utilisateur |
Exemples
|
Broker_Create |
|
Broker_Create |
|
Broker_Create |
|
Broker_Create |
Broker_CreateOrUpdate
Exemple de requête
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"
}
}
Exemple de réponse
{
"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
Exemple de requête
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"
}
}
Exemple de réponse
{
"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
Exemple de requête
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"
}
}
Exemple de réponse
{
"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
Exemple de requête
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"
}
}
Exemple de réponse
{
"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"
}
}
Définitions
| Nom | Description |
|---|---|
|
Advanced |
Paramètres avancés du courtier |
|
Backend |
Propriétés souhaitées des instances backend du broker |
|
Broker |
Propriétés des paramètres de diagnostic du broker |
|
Broker |
Les paramètres de profil de mémoire du Broker |
|
Broker |
Configuration de la persistance du disque. Lorsque la persistance est activée, certains éléments (données non critiques pour les performances) sélectionnés pour la persistance résident uniquement sur le disque. Vous trouverez ci-dessous les articles concernés :
Optional. Tout est en mémoire s’il n’est pas réglé. Remarque : s’il est configuré, tous les états de session MQTT sont écrits sur le disque. |
|
Broker |
Propriétés de chiffrement de persistance du répartiteur. |
|
Broker |
Valeurs du mode de stratégie de persistance du broker. |
|
Broker |
Propriétés de Broker Resource |
|
Broker |
Ressource Instance Broker |
|
Broker |
Stratégie de rétention des messages Custom Broker. |
|
Broker |
Paramètres dynamiques de BrokerRetainMessagesCustomPolicy. |
|
Broker |
Propriétés Broker Retain Messages. |
|
Broker |
Politique personnalisée du magasin d’état du courtier. |
|
Broker |
Paramètres dynamiques de BrokerStateStoreCustomPolicy. |
|
Broker |
Propriétés du type de clé de la banque d’état du courtier. |
|
Broker |
Propriétés des ressources de stratégie de magasin d’état du courtier. |
|
Broker |
Paramètres de stratégie personnalisés du magasin d’état du courtier. |
|
Broker |
Propriétés de la stratégie de file d’attente d’abonné personnalisée. |
|
Broker |
Propriétés de la stratégie personnalisée de la file d’attente d’abonnés du broker. |
|
Broker |
Paramètres dynamiques de BrokerSubscriberQueueCustomPolicy. |
| Cardinality |
Propriétés de cardinalité |
|
Cert |
Cert Manager Propriétés du certificat |
|
Cert |
Propriétés de la clé privée Cert Manager |
|
Client |
Les paramètres de Configuration du Client. |
|
created |
Type d’identité qui a créé la ressource. |
|
Diagnostics |
Propriétés du journal de diagnostic |
|
Disk |
Propriétés de DiskBackedMessageBuffer |
|
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
|
Error |
Détail de l’erreur. |
|
Error |
Réponse d’erreur |
|
Extended |
L’emplacement étendu est une extension des emplacements Azure. Ils permettent d’utiliser leurs clusters Kubernetes avec Azure ARC comme emplacements cibles pour le déploiement d’instances de services Azure. |
|
Extended |
L’énumération définissant le type de ExtendedLocation acceptée. |
| Frontend |
Les propriétés souhaitées des instances frontales du Broker |
|
Generate |
Propriétés GenerateResourceLimits |
|
Kubernetes |
Référence Kubernetes |
|
Local |
Référence Kubernetes |
| Metrics |
Propriétés des métriques de diagnostic |
|
Operational |
Propriétés du mode |
|
Operator |
Les opérateurs valides sont In, NotIn, Exists et DoesNotExist. |
|
Private |
Types d’algorithmes de clé privée. |
|
Private |
Politique de rotation des clés privées. |
|
Provisioning |
L’énumération définissant le statut de la ressource. |
|
Resource |
L’état de santé de la ressource. |
|
Self |
Propriétés de l’auto-vérification de Broker Diagnostic |
|
Self |
Propriétés de diagnostic de l’auto-traçage |
|
Subscriber |
L’énumération définissant les stratégies de suppression des messages de la file d’attente des abonnés. |
|
Subscriber |
Les paramètres de la limite de file d’attente d’abonnés. |
|
system |
Métadonnées relatives à la création et à la dernière modification de la ressource. |
| Traces |
Propriétés de Broker Diagnostic Trace |
|
Volume |
Propriétés VolumeClaimResourceRequirements |
|
Volume |
Propriétés VolumeClaimResourceRequirementsClaims. |
|
Volume |
Propriétés de VolumeClaimSpec |
|
Volume |
Propriétés de VolumeClaimSpecSelector |
|
Volume |
Propriétés VolumeClaimSpecSelectorMatchExpressions |
AdvancedSettings
Paramètres avancés du courtier
| Nom | Type | Valeur par défaut | Description |
|---|---|---|---|
| clients |
Configurations liées à tous les clients. |
||
| encryptInternalTraffic | Enabled |
Paramètre permettant d’activer ou de désactiver le chiffrement du trafic interne. |
|
| internalCerts |
Rotation des certificats et configuration de clé privée. |
BackendChain
Propriétés souhaitées des instances backend du broker
| Nom | Type | Valeur par défaut | Description |
|---|---|---|---|
| partitions |
integer (int32) minimum: 1maximum: 16 |
Nombre souhaité de partitions principales physiques. |
|
| redundancyFactor |
integer (int32) minimum: 1maximum: 5 |
Nombre souhaité de réplicas back-end (pods) dans une partition physique. |
|
| workers |
integer (int32) minimum: 1maximum: 16 |
1 |
Nombre de workers principaux logiques par réplica (pod). |
BrokerDiagnostics
Propriétés des paramètres de diagnostic du broker
| Nom | Type | Description |
|---|---|---|
| logs |
Paramètres du journal de diagnostic pour la ressource. |
|
| metrics |
Paramètres des métriques de la ressource. |
|
| selfCheck |
Propriétés de vérification automatique. |
|
| traces |
Propriétés de trace. |
BrokerMemoryProfile
Les paramètres de profil de mémoire du Broker
| Valeur | Description |
|---|---|
| Tiny |
Profil de mémoire minuscule. |
| Low |
Profil de mémoire faible. |
| Medium |
Profil de mémoire moyen. |
| High |
Profil de mémoire élevé. |
BrokerPersistence
Configuration de la persistance du disque.
Lorsque la persistance est activée, certains éléments (données non critiques pour les performances) sélectionnés pour la persistance résident uniquement sur le disque. Vous trouverez ci-dessous les articles concernés :
- Les messages conservés seront stockés sur le disque uniquement.
- Les messages WILL seront stockés sur le disque uniquement.
- Les paires clé/valeur DSS seront stockées sur le disque uniquement, à l’exception des éléments critiques pour les performances tels que les verrous temporisés, qui restent à la fois sur le disque et dans la mémoire pour améliorer les performances.
Optional. Tout est en mémoire s’il n’est pas réglé. Remarque : s’il est configuré, tous les états de session MQTT sont écrits sur le disque.
| Nom | Type | Description |
|---|---|---|
| encryption |
Contrôle les paramètres liés au chiffrement de la base de données de persistance. Facultatif, par défaut, l’activation du chiffrement. |
|
| maxSize |
string |
Taille maximale de la mémoire tampon de message sur le disque. Si un modèle PVC est spécifié à l’aide de persistentVolumeClaimSpec, cette taille est utilisée comme taille de demande et de limite de ce modèle. Si aucun modèle PVC n’est spécifié, le provisionneur de chemin d’accès local est demandé avec cette limite de taille. Obligatoire. |
| persistentVolumeClaimSpec |
Utilisez le modèle de revendication de volume persistant spécifié pour monter un volume persistant. Même objet que dans diskBackedMessageBuffer, mais avec une limitation selon laquelle le champ des modes d’accès doit être défini sur S’il n’est pas défini, un PVC par défaut avec des propriétés par défaut sera utilisé. Entre autres choses, cette preuve PVC utilisera la classe de stockage par défaut du cluster, qui peut ou non utiliser un provisionneur de chemin d’accès local. L’utilisateur opte pour un comportement sous-optimal s’il laisse ce non défini ou s’il le définit sans le champ de classe de stockage, et la valeur par défaut de son cluster n’est pas une classe de chemin d’accès locale. |
|
| retain | BrokerRetainMessagesPolicy: |
Contrôle les messages conservés de la rubrique qui doivent être conservés sur le disque. |
| stateStore | BrokerStateStorePolicy: |
Contrôle les clés qui doivent être conservées sur le disque pour le magasin d’état. |
| subscriberQueue | BrokerSubscriberQueuePolicy: |
Contrôle les files d’attente de messages d’abonné qui doivent être conservées sur le disque. Important : pour faciliter la reconnexion, les métadonnées d’état de session sont TOUJOURS écrites sur le disque si un paramètre de persistance est spécifié, même si cette section n’est pas définie. |
BrokerPersistenceEncryption
Propriétés de chiffrement de persistance du répartiteur.
| Nom | Type | Description |
|---|---|---|
| mode |
Détermine si le chiffrement est activé. |
BrokerPersistencePolicyMode
Valeurs du mode de stratégie de persistance du broker.
| Valeur | Description |
|---|---|
| All |
Mode de stratégie pour tous. |
| None |
Mode de stratégie pour Aucun. |
| Custom |
Indique qu’il s’agit d’une stratégie personnalisée. |
BrokerProperties
Propriétés de Broker Resource
| Nom | Type | Valeur par défaut | Description |
|---|---|---|---|
| advanced |
Paramètres avancés du répartiteur. |
||
| cardinality |
Détails de cardinalité du répartiteur. |
||
| diagnostics |
Spec définit les identités souhaitées des paramètres de diagnostic Broker. |
||
| diskBackedMessageBuffer |
Paramètres de la mémoire tampon de message sauvegardée sur disque. |
||
| generateResourceLimits |
Ce paramètre contrôle si les limites de ressources du processeur Kubernetes sont demandées. L’augmentation du nombre de réplicas ou de workers augmente proportionnellement la quantité de ressources processeur demandées. Si ce paramètre est activé et qu’il n’y a pas de ressources processeur insuffisantes, une erreur est émise. |
||
| healthState | Unknown |
L’état de santé de la ressource. |
|
| memoryProfile | Medium |
Profil mémoire de Broker. |
|
| persistence |
Les paramètres de persistance du broker. |
||
| provisioningState |
État de la dernière opération. |
BrokerResource
Ressource Instance Broker
| Nom | Type | Description |
|---|---|---|
| extendedLocation |
Emplacement de périphérie de la ressource. |
|
| id |
string (arm-id) |
ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} » |
| name |
string |
Nom de la ressource |
| properties |
Propriétés spécifiques à la ressource pour cette ressource. |
|
| systemData |
Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy. |
|
| type |
string |
Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » |
BrokerRetainMessagesCustomPolicy
Stratégie de rétention des messages Custom Broker.
| Nom | Type | Description |
|---|---|---|
| mode |
string:
Custom |
'All' pour conserver tous les messages, 'None' pour n’en conserver aucun, 'Custom' pour ne conserver que les rubriques spécifiées. |
| retainSettings |
Paramètres de la stratégie. |
BrokerRetainMessagesDynamic
Paramètres dynamiques de BrokerRetainMessagesCustomPolicy.
| Nom | Type | Description |
|---|---|---|
| mode |
Mode de BrokerRetainMessagesCustomPolicy. |
BrokerRetainMessagesSettings
Propriétés Broker Retain Messages.
| Nom | Type | Description |
|---|---|---|
| dynamic |
Contrôle si les clients MQTT peuvent demander la persistance du disque via |
|
| topics |
string[] |
Liste des rubriques sous lesquelles les messages conservés seraient conservés sur le disque. Caractères génériques # et + pris en charge. |
BrokerStateStoreCustomPolicy
Politique personnalisée du magasin d’état du courtier.
| Nom | Type | Description |
|---|---|---|
| mode |
string:
Custom |
'All' pour conserver toutes les clés, 'None' pour n’en conserver aucune, 'Custom' pour ne conserver que les clés spécifiées. |
| stateStoreSettings |
Paramètres de la stratégie. |
BrokerStateStoreDynamic
Paramètres dynamiques de BrokerStateStoreCustomPolicy.
| Nom | Type | Description |
|---|---|---|
| mode |
Mode de BrokerStateStoreCustomPolicy. |
BrokerStateStoreKeyType
Propriétés du type de clé de la banque d’état du courtier.
| Valeur | Description |
|---|---|
| Pattern |
Utilisé pour la correspondance de motifs de style glob. |
| String |
Utilisé pour faire une correspondance exacte, par exemple, lorsqu’une touche contient des caractères qui pourraient autrement correspondre en tant que motif (*, ?, [0-9]). |
| Binary |
Utilisé pour faire correspondre une clé binaire. |
BrokerStateStorePolicyResources
Propriétés des ressources de stratégie de magasin d’état du courtier.
| Nom | Type | Description |
|---|---|---|
| keyType |
Clé de persistance sur le disque. |
|
| keys |
string[] |
Liste des clés à conserver sur le disque, obligatoire. |
BrokerStateStorePolicySettings
Paramètres de stratégie personnalisés du magasin d’état du courtier.
| Nom | Type | Description |
|---|---|---|
| dynamic |
Contrôle si les clients MQTT peuvent demander la persistance du disque via |
|
| stateStoreResources |
Liste des clés et des types de clés à conserver sur le disque. |
BrokerSubscriberQueueCustomPolicy
Propriétés de la stratégie de file d’attente d’abonné personnalisée.
| Nom | Type | Description |
|---|---|---|
| mode |
string:
Custom |
'All' pour conserver toutes les files d’attente d’abonnés, 'None' pour n’en conserver aucune, 'Custom' pour conserver uniquement les files d’attente spécifiées. |
| subscriberQueueSettings |
Stratégie personnalisée, obligatoire si le mode est Personnalisé. Les files d’attente d’abonnés de tous les groupes sont conservées sur le disque (OU logique). |
BrokerSubscriberQueueCustomPolicySettings
Propriétés de la stratégie personnalisée de la file d’attente d’abonnés du broker.
| Nom | Type | Description |
|---|---|---|
| dynamic |
Contrôle si les clients MQTT peuvent demander la persistance du disque via |
|
| subscriberClientIds |
string[] |
Liste des ID client des abonnés, caractère générique * pris en charge. |
BrokerSubscriberQueueDynamic
Paramètres dynamiques de BrokerSubscriberQueueCustomPolicy.
| Nom | Type | Description |
|---|---|---|
| mode |
Mode de BrokerSubscriberQueueCustomPolicy. |
Cardinality
Propriétés de cardinalité
| Nom | Type | Description |
|---|---|---|
| backendChain |
Propriétés souhaitées du répartiteur principal |
|
| frontend |
Propriétés souhaitées du serveur frontal |
CertManagerCertOptions
Cert Manager Propriétés du certificat
| Nom | Type | Description |
|---|---|---|
| duration |
string |
Durée de vie du certificat. Doit être spécifié à l’aide d’une heure de go. Format de durée (h|m|s). Par exemple, 240h pendant 240 heures et 45m pendant 45 minutes. |
| privateKey |
Configuration de la clé privée de certificat. |
|
| renewBefore |
string |
Quand commencer le renouvellement du certificat. Doit être spécifié à l’aide d’une heure de go. Format de durée (h|m|s). Par exemple, 240h pendant 240 heures et 45m pendant 45 minutes. |
CertManagerPrivateKey
Propriétés de la clé privée Cert Manager
| Nom | Type | Description |
|---|---|---|
| algorithm |
algorithme pour la clé privée. |
|
| rotationPolicy |
cert-manager private key rotationPolicy. |
ClientConfig
Les paramètres de Configuration du Client.
| Nom | Type | Description |
|---|---|---|
| maxKeepAliveSeconds |
integer (int32) minimum: 0maximum: 65535 |
Limite supérieure de Keep Alive d’un client, en secondes. |
| maxMessageExpirySeconds |
integer (int32) minimum: 1 |
Limite supérieure de l’intervalle d’expiration du message, en secondes. |
| maxPacketSizeBytes |
integer (int32) minimum: 1maximum: 268435456 |
Taille maximale du message pour un paquet en octets. |
| maxReceiveMaximum |
integer (int32) minimum: 1maximum: 65535 |
Limite supérieure de réception maximale qu’un client peut demander dans le paquet CONNECT. |
| maxSessionExpirySeconds |
integer (int32) minimum: 1 |
Limite supérieure de l’intervalle d’expiration de session, en secondes. |
| subscriberQueueLimit |
Limite du nombre de messages mis en file d’attente pour un abonné. |
createdByType
Type d’identité qui a créé la ressource.
| Valeur | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DiagnosticsLogs
Propriétés du journal de diagnostic
| Nom | Type | Valeur par défaut | Description |
|---|---|---|---|
| level |
string |
info |
Niveau du journal. Exemples : « debug », « info », « warn », « error », « trace ». |
DiskBackedMessageBuffer
Propriétés de DiskBackedMessageBuffer
| Nom | Type | Description |
|---|---|---|
| ephemeralVolumeClaimSpec |
Utilisez le modèle de revendication de volume persistant spécifié pour monter un « volume éphémère générique » pour la mémoire tampon de message. Pour plus d’informations, consultez https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes. |
|
| maxSize |
string pattern: ^[0-9]+[KMGTPE]$ |
Taille maximale de la mémoire tampon de message sur le disque. Si un modèle PVC est spécifié à l’aide de l’un des modèles éphémèresVolumeClaimSpec ou persistentVolumeClaimSpec, cette taille est utilisée comme demande et limite les tailles de ce modèle. Si ni éphémèreVolumeClaimSpec ni persistentVolumeClaimSpec ne sont spécifiés, un volume emptyDir est monté avec cette taille comme limite. Pour plus d’informations, consultez https://kubernetes.io/docs/concepts/storage/volumes/#emptydir. |
| persistentVolumeClaimSpec |
Utilisez le modèle de revendication de volume persistant spécifié pour monter un volume persistant pour la mémoire tampon de message. |
ErrorAdditionalInfo
Informations supplémentaires sur l’erreur de gestion des ressources.
| Nom | Type | Description |
|---|---|---|
| info |
object |
Informations supplémentaires. |
| type |
string |
Type d’informations supplémentaire. |
ErrorDetail
Détail de l’erreur.
| Nom | Type | Description |
|---|---|---|
| additionalInfo |
Informations supplémentaires sur l’erreur. |
|
| code |
string |
Code d’erreur. |
| details |
Détails de l’erreur. |
|
| message |
string |
Message d’erreur. |
| target |
string |
Cible d’erreur. |
ErrorResponse
Réponse d’erreur
| Nom | Type | Description |
|---|---|---|
| error |
Objet d’erreur. |
ExtendedLocation
L’emplacement étendu est une extension des emplacements Azure. Ils permettent d’utiliser leurs clusters Kubernetes avec Azure ARC comme emplacements cibles pour le déploiement d’instances de services Azure.
| Nom | Type | Description |
|---|---|---|
| name |
string |
Nom de l’emplacement étendu. |
| type |
Type de ExtendedLocation. |
ExtendedLocationType
L’énumération définissant le type de ExtendedLocation acceptée.
| Valeur | Description |
|---|---|
| CustomLocation |
Type de CustomLocation |
Frontend
Les propriétés souhaitées des instances frontales du Broker
| Nom | Type | Valeur par défaut | Description |
|---|---|---|---|
| replicas |
integer (int32) minimum: 1maximum: 16 |
Nombre souhaité d’instances frontales (pods). |
|
| workers |
integer (int32) minimum: 1maximum: 16 |
2 |
Nombre de workers frontend logiques par instance (pod). |
GenerateResourceLimits
Propriétés GenerateResourceLimits
| Nom | Type | Valeur par défaut | Description |
|---|---|---|---|
| cpu | Enabled |
Bascule pour activer/désactiver les limites des ressources processeur. |
KubernetesReference
Référence Kubernetes
| Nom | Type | Description |
|---|---|---|
| apiGroup |
string |
APIGroup est le groupe pour la ressource référencée. Si APIGroup n’est pas spécifié, le type spécifié doit se trouver dans le groupe d’API principal. Pour tous les autres types tiers, APIGroup est requis. |
| kind |
string |
Type de ressource référencée |
| name |
string |
Le nom est le nom de la ressource référencée |
| namespace |
string |
L’espace de noms est l’espace de noms de la ressource référencée. Ce champ est obligatoire lorsque la ressource a un espace de noms. |
LocalKubernetesReference
Référence Kubernetes
| Nom | Type | Description |
|---|---|---|
| apiGroup |
string |
APIGroup est le groupe pour la ressource référencée. Si APIGroup n’est pas spécifié, le type spécifié doit se trouver dans le groupe d’API principal. Pour tous les autres types tiers, APIGroup est requis. |
| kind |
string |
Type de ressource référencée |
| name |
string |
Le nom est le nom de la ressource référencée |
Metrics
Propriétés des métriques de diagnostic
| Nom | Type | Valeur par défaut | Description |
|---|---|---|---|
| prometheusPort |
integer (int32) minimum: 0maximum: 65535 |
9600 |
Port prometheus pour exposer les métriques. |
OperationalMode
Propriétés du mode
| Valeur | Description |
|---|---|
| Enabled |
Enabled est équivalent à True |
| Disabled |
Désactivé équivaut à False. |
OperatorValues
Les opérateurs valides sont In, NotIn, Exists et DoesNotExist.
| Valeur | Description |
|---|---|
| In |
Dans l’opérateur. |
| NotIn |
NotIn. |
| Exists |
Existe. |
| DoesNotExist |
DoesNotExist. |
PrivateKeyAlgorithm
Types d’algorithmes de clé privée.
| Valeur | Description |
|---|---|
| Ec256 |
Algorithme - ec256. |
| Ec384 |
Algorithme - ec384. |
| Ec521 |
Algorithme - ec521. |
| Ed25519 |
Algorithme - ed25519. |
| Rsa2048 |
Algorithme - rsa2048. |
| Rsa4096 |
Algorithme - rsa4096. |
| Rsa8192 |
Algorithme - rsa8192. |
PrivateKeyRotationPolicy
Politique de rotation des clés privées.
| Valeur | Description |
|---|---|
| Always |
Politique de rotation - Toujours. |
| Never |
Politique de rotation - Jamais. |
ProvisioningState
L’énumération définissant le statut de la ressource.
| Valeur | Description |
|---|---|
| Succeeded |
La ressource a été créée. |
| Failed |
Echec de la création de la ressource. |
| Canceled |
La création de ressources a été annulée. |
| Provisioning |
La ressource est provisionnée. |
| Updating |
La ressource est en cours de mise à jour. |
| Deleting |
La ressource est en train de supprimer. |
| Accepted |
La ressource a été acceptée. |
ResourceHealthState
L’état de santé de la ressource.
| Valeur | Description |
|---|---|
| Available |
La ressource est disponible et fonctionne comme prévu. |
| Degraded |
L’état de la ressource est dégradé. |
| Unavailable |
La ressource ne fonctionne pas comme prévu. |
| Unknown |
L’état de la ressource est inconnu. |
SelfCheck
Propriétés de l’auto-vérification de Broker Diagnostic
| Nom | Type | Valeur par défaut | Description |
|---|---|---|---|
| intervalSeconds |
integer (int32) minimum: 30maximum: 300 |
30 |
Intervalle de vérification automatique. |
| mode | Enabled |
Bascule pour activer/désactiver la vérification automatique. |
|
| timeoutSeconds |
integer (int32) minimum: 5maximum: 120 |
15 |
Délai d’expiration de l’auto-vérification. |
SelfTracing
Propriétés de diagnostic de l’auto-traçage
| Nom | Type | Valeur par défaut | Description |
|---|---|---|---|
| intervalSeconds |
integer (int32) minimum: 1maximum: 300 |
30 |
Intervalle de suivi automatique. |
| mode | Enabled |
Bascule pour activer/désactiver le suivi automatique. |
SubscriberMessageDropStrategy
L’énumération définissant les stratégies de suppression des messages de la file d’attente des abonnés.
| Valeur | Description |
|---|---|
| None |
Les messages ne sont jamais abandonnés. |
| DropOldest |
Le message le plus ancien est supprimé. |
SubscriberQueueLimit
Les paramètres de la limite de file d’attente d’abonnés.
| Nom | Type | Valeur par défaut | Description |
|---|---|---|---|
| length |
integer (int64) minimum: 1 |
Longueur maximale de la file d’attente avant que les messages ne commencent à être supprimés. |
|
| strategy | None |
Stratégie à utiliser pour supprimer des messages de la file d’attente. |
systemData
Métadonnées relatives à la création et à la dernière modification de la ressource.
| Nom | Type | Description |
|---|---|---|
| createdAt |
string (date-time) |
Horodatage de la création de ressources (UTC). |
| createdBy |
string |
Identité qui a créé la ressource. |
| createdByType |
Type d’identité qui a créé la ressource. |
|
| lastModifiedAt |
string (date-time) |
Horodatage de la dernière modification de ressource (UTC) |
| lastModifiedBy |
string |
Identité qui a modifié la ressource pour la dernière fois. |
| lastModifiedByType |
Type d’identité qui a modifié la ressource pour la dernière fois. |
Traces
Propriétés de Broker Diagnostic Trace
| Nom | Type | Valeur par défaut | Description |
|---|---|---|---|
| cacheSizeMegabytes |
integer (int32) minimum: 1maximum: 128 |
16 |
Taille du cache en mégaoctets. |
| mode | Enabled |
Bascule pour activer/désactiver les traces. |
|
| selfTracing |
Propriétés de suivi automatique. |
||
| spanChannelCapacity |
integer (int32) minimum: 1000maximum: 100000 |
1000 |
Capacité du canal d’étendue. |
VolumeClaimResourceRequirements
Propriétés VolumeClaimResourceRequirements
| Nom | Type | Description |
|---|---|---|
| claims |
Claims répertorie les noms des ressources, définis dans spec.resourceClaims, qui sont utilisées par ce conteneur. Il s’agit d’un champ alpha qui nécessite l’activation de la porte de fonctionnalité DynamicResourceAllocation. Ce champ est immuable. Il ne peut être défini que pour les conteneurs. |
|
| limits |
object |
Les limites décrivent la quantité maximale de ressources de calcul autorisées. Plus d’informations : https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
| requests |
object |
Les demandes décrivent la quantité minimale de ressources de calcul requises. Si les requêtes sont omises pour un conteneur, elle est définie par défaut sur Limites si elle est spécifiée explicitement, sinon à une valeur définie par l’implémentation. Plus d’informations : https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
VolumeClaimResourceRequirementsClaims
Propriétés VolumeClaimResourceRequirementsClaims.
| Nom | Type | Description |
|---|---|---|
| name |
string |
Nom de la ressource. Cela doit correspondre au nom d’une ressource dans spec.resourceClaims. |
VolumeClaimSpec
Propriétés de VolumeClaimSpec
| Nom | Type | Description |
|---|---|---|
| accessModes |
string[] |
AccessModes contient les modes d’accès souhaités dont le volume doit avoir. Plus d’informations : https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
| dataSource |
Ce champ peut être utilisé pour spécifier soit : * Un objet VolumeSnapshot existant (snapshot.storage.k8s.io/VolumeSnapshot) * Un PVC existant (PersistentVolumeClaim) Si le provisionneur ou un contrôleur externe peut prendre en charge la source de données spécifiée, il crée un volume basé sur le contenu de la source de données spécifiée. Si la porte de fonctionnalité AnyVolumeDataSource est activée, ce champ aura toujours le même contenu que le champ DataSourceRef. |
|
| dataSourceRef |
Spécifie l’objet à partir duquel remplir le volume avec des données, si un volume non vide est souhaité. Il peut s’agir d’un objet local à partir d’un groupe d’API non vide (objet non principal) ou d’un objet PersistentVolumeClaim. Lorsque ce champ est spécifié, la liaison de volume réussit uniquement si le type de l’objet spécifié correspond à un populateur de volume ou un provisionneur dynamique installé. Ce champ remplace les fonctionnalités du champ DataSource et, par conséquent, si les deux champs ne sont pas vides, ils doivent avoir la même valeur. Pour la compatibilité descendante, les deux champs (DataSource et DataSourceRef) sont définis automatiquement sur la même valeur si l’un d’eux est vide et que l’autre n’est pas vide. Il existe deux différences importantes entre DataSource et DataSourceRef : * Alors que DataSource autorise uniquement deux types d’objets spécifiques, DataSourceRef autorise n’importe quel objet non principal, ainsi que les objets PersistentVolumeClaim. * Alors que DataSource ignore les valeurs non autorisées (les supprimant), DataSourceRef conserve toutes les valeurs et génère une erreur si une valeur non autorisée est spécifiée. (bêta) L’utilisation de ce champ nécessite que la porte de fonctionnalité AnyVolumeDataSource soit activée. |
|
| resources |
Les ressources représentent les ressources minimales dont le volume doit avoir. Si la fonctionnalité RecoverVolumeExpansionFailure est activée, les utilisateurs sont autorisés à spécifier les exigences de ressources inférieures à la valeur précédente, mais doivent toujours être supérieures à la capacité enregistrée dans le champ d’état de la revendication. Plus d’informations : https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
|
| selector |
Requête d’étiquette sur les volumes à prendre en compte pour la liaison. |
|
| storageClassName |
string |
Nom de storageClass requis par la revendication. Plus d’informations : https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
| volumeMode |
string |
volumeMode définit le type de volume requis par la revendication. La valeur du système de fichiers est implicite lorsqu’elle n’est pas incluse dans les spécifications de revendication. Il s’agit d’une fonctionnalité bêta. |
| volumeName |
string |
VolumeName est la référence de liaison à persistentVolume qui sauvegarde cette revendication. |
VolumeClaimSpecSelector
Propriétés de VolumeClaimSpecSelector
| Nom | Type | Description |
|---|---|---|
| matchExpressions |
MatchExpressions est une liste des exigences de sélecteur d’étiquettes. Les exigences sont AND. |
|
| matchLabels |
object |
MatchLabels est une carte de paires {key,value}. Une seule {clé,value} dans le mappage matchLabels équivaut à un élément de matchExpressions, dont le champ de clé est « key », l’opérateur est « In », et le tableau de valeurs contient uniquement « value ». Les exigences sont AND. |
VolumeClaimSpecSelectorMatchExpressions
Propriétés VolumeClaimSpecSelectorMatchExpressions
| Nom | Type | Description |
|---|---|---|
| key |
string |
clé est la clé d’étiquette à laquelle le sélecteur s’applique. |
| operator |
l’opérateur représente la relation d’une clé à un ensemble de valeurs. Les opérateurs valides sont In, NotIn, Exists et DoesNotExist. |
|
| values |
string[] |
les valeurs sont un tableau de valeurs de chaîne. Si l’opérateur est In ou NotIn, le tableau de valeurs doit être non vide. Si l’opérateur existe ou DoesNotExist, le tableau de valeurs doit être vide. Ce tableau est remplacé lors d’un correctif de fusion stratégique. |