Broker - Create Or Update
Criar um BrokerResource
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}?api-version=2026-07-01
Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
broker
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$ |
Nome do agente. |
|
instance
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$ |
Nome da instância. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas. |
|
subscription
|
path | True |
string (uuid) |
O ID da assinatura de destino. O valor deve ser uma UUID. |
|
api-version
|
query | True |
string minLength: 1 |
A versão da API a ser usada para esta operação. |
Corpo da solicitação
| Nome | Tipo | Description |
|---|---|---|
| extendedLocation |
Local de borda do recurso. |
|
| properties |
As propriedades específicas do recurso para esse recurso. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
Operação de atualização do recurso 'BrokerResource' bem-sucedida |
|
| 201 Created |
Operação de criação do recurso 'BrokerResource' bem-sucedida Cabeçalhos
|
|
| Other Status Codes |
Uma resposta de erro inesperada. |
Segurança
azure_auth
Fluxo do OAuth2 do Azure Active Directory.
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
| Nome | Description |
|---|---|
| user_impersonation | se passar pela sua conta de usuário |
Exemplos
|
Broker_Create |
|
Broker_Create |
|
Broker_Create |
|
Broker_Create |
Broker_CreateOrUpdate
Solicitação de exemplo
PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2026-07-01
{
"properties": {
"advanced": {
"clients": {
"maxSessionExpirySeconds": 3859,
"maxMessageExpirySeconds": 3263,
"maxPacketSizeBytes": 3029,
"subscriberQueueLimit": {
"length": 6,
"strategy": "None"
},
"maxReceiveMaximum": 2365,
"maxKeepAliveSeconds": 3744
},
"encryptInternalTraffic": "Enabled",
"internalCerts": {
"duration": "bchrc",
"renewBefore": "xkafmpgjfifkwwrhkswtopdnne",
"privateKey": {
"algorithm": "Ec256",
"rotationPolicy": "Always"
}
}
},
"cardinality": {
"backendChain": {
"partitions": 11,
"redundancyFactor": 5,
"workers": 15
},
"frontend": {
"replicas": 2,
"workers": 6
}
},
"diagnostics": {
"logs": {
"level": "rnmwokumdmebpmfxxxzvvjfdywotav"
},
"metrics": {
"prometheusPort": 7581
},
"selfCheck": {
"mode": "Enabled",
"intervalSeconds": 158,
"timeoutSeconds": 14
},
"traces": {
"mode": "Enabled",
"cacheSizeMegabytes": 28,
"selfTracing": {
"mode": "Enabled",
"intervalSeconds": 22
},
"spanChannelCapacity": 1000
}
},
"diskBackedMessageBuffer": {
"maxSize": "500M",
"ephemeralVolumeClaimSpec": {
"volumeName": "c",
"volumeMode": "rxvpksjuuugqnqzeiprocknbn",
"storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
"accessModes": [
"nuluhigrbb"
],
"dataSource": {
"apiGroup": "npqapyksvvpkohujx",
"kind": "wazgyb",
"name": "cwhsgxxcxsyppoefm"
},
"dataSourceRef": {
"apiGroup": "mnfnykznjjsoqpfsgdqioupt",
"kind": "odynqzekfzsnawrctaxg",
"name": "envszivbbmixbyddzg",
"namespace": "etcfzvxqd"
},
"resources": {
"limits": {
"key2719": "hmphcrgctu"
},
"requests": {
"key2909": "txocprnyrsgvhfrg"
}
},
"selector": {
"matchExpressions": [
{
"key": "e",
"operator": "In",
"values": [
"slmpajlywqvuyknipgztsonqyybt"
]
}
],
"matchLabels": {
"key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
}
}
},
"persistentVolumeClaimSpec": {
"volumeName": "c",
"volumeMode": "rxvpksjuuugqnqzeiprocknbn",
"storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
"accessModes": [
"nuluhigrbb"
],
"dataSource": {
"apiGroup": "npqapyksvvpkohujx",
"kind": "wazgyb",
"name": "cwhsgxxcxsyppoefm"
},
"dataSourceRef": {
"apiGroup": "mnfnykznjjsoqpfsgdqioupt",
"kind": "odynqzekfzsnawrctaxg",
"name": "envszivbbmixbyddzg",
"namespace": "etcfzvxqd"
},
"resources": {
"limits": {
"key2719": "hmphcrgctu"
},
"requests": {
"key2909": "txocprnyrsgvhfrg"
}
},
"selector": {
"matchExpressions": [
{
"key": "e",
"operator": "In",
"values": [
"slmpajlywqvuyknipgztsonqyybt"
]
}
],
"matchLabels": {
"key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
}
}
}
},
"generateResourceLimits": {
"cpu": "Enabled"
},
"memoryProfile": "Tiny",
"highPriorityMessagesBackpressureHandling": "Accept"
},
"extendedLocation": {
"name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
"type": "CustomLocation"
}
}
Resposta de exemplo
{
"properties": {
"advanced": {
"clients": {
"maxSessionExpirySeconds": 3859,
"maxMessageExpirySeconds": 3263,
"maxPacketSizeBytes": 3029,
"subscriberQueueLimit": {
"length": 6,
"strategy": "None"
},
"maxReceiveMaximum": 2365,
"maxKeepAliveSeconds": 3744
},
"encryptInternalTraffic": "Enabled",
"internalCerts": {
"duration": "bchrc",
"renewBefore": "xkafmpgjfifkwwrhkswtopdnne",
"privateKey": {
"algorithm": "Ec256",
"rotationPolicy": "Always"
}
}
},
"cardinality": {
"backendChain": {
"partitions": 11,
"redundancyFactor": 5,
"workers": 15
},
"frontend": {
"replicas": 2,
"workers": 6
}
},
"diagnostics": {
"logs": {
"level": "rnmwokumdmebpmfxxxzvvjfdywotav"
},
"metrics": {
"prometheusPort": 7581
},
"selfCheck": {
"mode": "Enabled",
"intervalSeconds": 158,
"timeoutSeconds": 14
},
"traces": {
"mode": "Enabled",
"cacheSizeMegabytes": 28,
"selfTracing": {
"mode": "Enabled",
"intervalSeconds": 22
},
"spanChannelCapacity": 1000
}
},
"diskBackedMessageBuffer": {
"maxSize": "500M",
"ephemeralVolumeClaimSpec": {
"volumeName": "c",
"volumeMode": "rxvpksjuuugqnqzeiprocknbn",
"storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
"accessModes": [
"nuluhigrbb"
],
"dataSource": {
"apiGroup": "npqapyksvvpkohujx",
"kind": "wazgyb",
"name": "cwhsgxxcxsyppoefm"
},
"dataSourceRef": {
"apiGroup": "mnfnykznjjsoqpfsgdqioupt",
"kind": "odynqzekfzsnawrctaxg",
"name": "envszivbbmixbyddzg",
"namespace": "etcfzvxqd"
},
"resources": {
"limits": {
"key2719": "hmphcrgctu"
},
"requests": {
"key2909": "txocprnyrsgvhfrg"
}
},
"selector": {
"matchExpressions": [
{
"key": "e",
"operator": "In",
"values": [
"slmpajlywqvuyknipgztsonqyybt"
]
}
],
"matchLabels": {
"key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
}
}
},
"persistentVolumeClaimSpec": {
"volumeName": "c",
"volumeMode": "rxvpksjuuugqnqzeiprocknbn",
"storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
"accessModes": [
"nuluhigrbb"
],
"dataSource": {
"apiGroup": "npqapyksvvpkohujx",
"kind": "wazgyb",
"name": "cwhsgxxcxsyppoefm"
},
"dataSourceRef": {
"apiGroup": "mnfnykznjjsoqpfsgdqioupt",
"kind": "odynqzekfzsnawrctaxg",
"name": "envszivbbmixbyddzg",
"namespace": "etcfzvxqd"
},
"resources": {
"limits": {
"key2719": "hmphcrgctu"
},
"requests": {
"key2909": "txocprnyrsgvhfrg"
}
},
"selector": {
"matchExpressions": [
{
"key": "e",
"operator": "In",
"values": [
"slmpajlywqvuyknipgztsonqyybt"
]
}
],
"matchLabels": {
"key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
}
}
}
},
"generateResourceLimits": {
"cpu": "Enabled"
},
"memoryProfile": "Tiny",
"highPriorityMessagesBackpressureHandling": "Accept",
"provisioningState": "Succeeded"
},
"extendedLocation": {
"name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
"type": "CustomLocation"
},
"id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
"name": "dowrkel",
"type": "Microsoft.IoTOperations/instances/brokers",
"systemData": {
"createdBy": "contosouser",
"createdByType": "User",
"createdAt": "2024-08-09T18:13:29.389Z",
"lastModifiedBy": "contosouser",
"lastModifiedByType": "User",
"lastModifiedAt": "2024-08-09T18:13:29.389Z"
}
}
Azure-AsyncOperation: https://contoso.com/operationstatus
{
"properties": {
"advanced": {
"clients": {
"maxSessionExpirySeconds": 3859,
"maxMessageExpirySeconds": 3263,
"maxPacketSizeBytes": 3029,
"subscriberQueueLimit": {
"length": 6,
"strategy": "None"
},
"maxReceiveMaximum": 2365,
"maxKeepAliveSeconds": 3744
},
"encryptInternalTraffic": "Enabled",
"internalCerts": {
"duration": "bchrc",
"renewBefore": "xkafmpgjfifkwwrhkswtopdnne",
"privateKey": {
"algorithm": "Ec256",
"rotationPolicy": "Always"
}
}
},
"cardinality": {
"backendChain": {
"partitions": 11,
"redundancyFactor": 5,
"workers": 15
},
"frontend": {
"replicas": 2,
"workers": 6
}
},
"diagnostics": {
"logs": {
"level": "rnmwokumdmebpmfxxxzvvjfdywotav"
},
"metrics": {
"prometheusPort": 7581
},
"selfCheck": {
"mode": "Enabled",
"intervalSeconds": 158,
"timeoutSeconds": 14
},
"traces": {
"mode": "Enabled",
"cacheSizeMegabytes": 28,
"selfTracing": {
"mode": "Enabled",
"intervalSeconds": 22
},
"spanChannelCapacity": 1000
}
},
"diskBackedMessageBuffer": {
"maxSize": "500M",
"ephemeralVolumeClaimSpec": {
"volumeName": "c",
"volumeMode": "rxvpksjuuugqnqzeiprocknbn",
"storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
"accessModes": [
"nuluhigrbb"
],
"dataSource": {
"apiGroup": "npqapyksvvpkohujx",
"kind": "wazgyb",
"name": "cwhsgxxcxsyppoefm"
},
"dataSourceRef": {
"apiGroup": "mnfnykznjjsoqpfsgdqioupt",
"kind": "odynqzekfzsnawrctaxg",
"name": "envszivbbmixbyddzg",
"namespace": "etcfzvxqd"
},
"resources": {
"limits": {
"key2719": "hmphcrgctu"
},
"requests": {
"key2909": "txocprnyrsgvhfrg"
}
},
"selector": {
"matchExpressions": [
{
"key": "e",
"operator": "In",
"values": [
"slmpajlywqvuyknipgztsonqyybt"
]
}
],
"matchLabels": {
"key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
}
}
},
"persistentVolumeClaimSpec": {
"volumeName": "c",
"volumeMode": "rxvpksjuuugqnqzeiprocknbn",
"storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
"accessModes": [
"nuluhigrbb"
],
"dataSource": {
"apiGroup": "npqapyksvvpkohujx",
"kind": "wazgyb",
"name": "cwhsgxxcxsyppoefm"
},
"dataSourceRef": {
"apiGroup": "mnfnykznjjsoqpfsgdqioupt",
"kind": "odynqzekfzsnawrctaxg",
"name": "envszivbbmixbyddzg",
"namespace": "etcfzvxqd"
},
"resources": {
"limits": {
"key2719": "hmphcrgctu"
},
"requests": {
"key2909": "txocprnyrsgvhfrg"
}
},
"selector": {
"matchExpressions": [
{
"key": "e",
"operator": "In",
"values": [
"slmpajlywqvuyknipgztsonqyybt"
]
}
],
"matchLabels": {
"key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
}
}
}
},
"generateResourceLimits": {
"cpu": "Enabled"
},
"memoryProfile": "Tiny",
"highPriorityMessagesBackpressureHandling": "Accept",
"provisioningState": "Succeeded"
},
"extendedLocation": {
"name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
"type": "CustomLocation"
},
"id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
"name": "dowrkel",
"type": "Microsoft.IoTOperations/instances/brokers",
"systemData": {
"createdBy": "contosouser",
"createdByType": "User",
"createdAt": "2024-08-09T18:13:29.389Z",
"lastModifiedBy": "contosouser",
"lastModifiedByType": "User",
"lastModifiedAt": "2024-08-09T18:13:29.389Z"
}
}
Broker_CreateOrUpdate_Complex
Solicitação de exemplo
PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2026-07-01
{
"properties": {
"cardinality": {
"backendChain": {
"partitions": 2,
"redundancyFactor": 2,
"workers": 2
},
"frontend": {
"replicas": 2,
"workers": 2
}
},
"diskBackedMessageBuffer": {
"maxSize": "50M"
},
"generateResourceLimits": {
"cpu": "Enabled"
},
"memoryProfile": "Medium"
},
"extendedLocation": {
"name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
"type": "CustomLocation"
}
}
Resposta de exemplo
{
"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
Solicitação de exemplo
PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2026-07-01
{
"properties": {
"memoryProfile": "Tiny"
},
"extendedLocation": {
"name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
"type": "CustomLocation"
}
}
Resposta de exemplo
{
"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
Solicitação de exemplo
PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2026-07-01
{
"properties": {
"cardinality": {
"backendChain": {
"partitions": 2,
"redundancyFactor": 2,
"workers": 2
},
"frontend": {
"replicas": 2,
"workers": 2
}
},
"generateResourceLimits": {
"cpu": "Enabled"
},
"memoryProfile": "Low"
},
"extendedLocation": {
"name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
"type": "CustomLocation"
}
}
Resposta de exemplo
{
"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"
}
}
Definições
| Nome | Description |
|---|---|
|
Advanced |
Configurações Avançadas do Agente |
|
Backend |
Propriedades desejadas das instâncias de back-end do agente |
|
Broker |
Propriedades de Configuração de Diagnóstico do Agente |
|
Broker |
As configurações de perfil de memória do Agente |
|
Broker |
Configuração de persistência de disco. Quando a persistência estiver habilitada, determinados itens (dados não críticos para desempenho) selecionados para persistência residirão apenas no disco. Abaixo estão os itens afetados:
Optional. Tudo está na memória se não estiver definido. Observação: se configurado, todos os estados de sessão MQTT são gravados no disco. |
|
Broker |
Propriedades de criptografia de persistência do agente. |
|
Broker |
Valores do Modo de Política de Persistência do Broker. |
|
Broker |
Propriedades do Recurso do Agente |
|
Broker |
Recurso do agente de instância |
|
Broker |
Política de Retenção de Mensagem do Agente Personalizado. |
|
Broker |
Configurações dinâmicas de BrokerRetainMessagesCustomPolicy. |
|
Broker |
Propriedades de Mensagens de Retenção do Broker. |
|
Broker |
Política personalizada do repositório de estado do corretor. |
|
Broker |
Configurações dinâmicas de BrokerStateStoreCustomPolicy. |
|
Broker |
Propriedades do tipo de chave do repositório de estado do agente. |
|
Broker |
Propriedades de recursos de política de repositório de estado do agente. |
|
Broker |
Configurações de política personalizadas do repositório de estado do agente. |
|
Broker |
Status de corretora. |
|
Broker |
Propriedades personalizadas da política de fila de assinantes. |
|
Broker |
Propriedades da Política Personalizada da Fila de Assinantes do Agente. |
|
Broker |
Configurações dinâmicas de BrokerSubscriberQueueCustomPolicy. |
| Cardinality |
Propriedades de cardinalidade |
|
Cert |
Propriedades do Cert Manager Cert |
|
Cert |
Propriedades de chave privada do Gerenciador de Certificados |
|
Client |
As configurações da Configuração do Cliente. |
|
created |
O tipo de identidade que criou o recurso. |
|
Diagnostics |
Propriedades do Log de Diagnóstico |
|
Disk |
Propriedades diskBackedMessageBuffer |
|
Error |
Informações adicionais sobre o erro de gerenciamento de recursos. |
|
Error |
O detalhe do erro. |
|
Error |
Resposta de erro |
|
Extended |
O local estendido é uma extensão dos locais do Azure. Eles fornecem uma maneira de usar seus clusters kubernetes habilitados para Azure ARC como locais de destino para implantar instâncias de serviços do Azure. |
|
Extended |
O tipo de definição de enumeração de ExtendedLocation aceito. |
| Frontend |
As propriedades desejadas das instâncias de front-end do Broker |
|
Generate |
Propriedades GenerateResourceLimits |
|
High |
Tratamento de mensagens de alta prioridade durante o estado de contrapressão. |
|
Kubernetes |
Referência do Kubernetes |
|
Local |
Referência do Kubernetes |
| Metrics |
Propriedades de Métricas de Diagnóstico |
|
Operational |
Propriedades do modo |
|
Operator |
Os operadores válidos são In, NotIn, Exists e DoesNotExist. |
|
Private |
Tipos de algoritmo de chave privada. |
|
Private |
Política de rotação de chave privada. |
|
Provisioning |
A enumeração definindo o status do recurso. |
|
Resource |
O estado de integridade do recurso. |
|
Resource |
Representa o estado de saúde de um recurso. |
|
Self |
Propriedades de autoconfiamento de diagnóstico do agente |
|
Self |
Propriedades de autoatendimento de diagnóstico |
|
Subscriber |
A enumeração definindo estratégias para remover mensagens da fila de assinantes. |
|
Subscriber |
As configurações do Limite de Fila do Assinante. |
|
system |
Metadados relativos à criação e última modificação do recurso. |
| Traces |
Propriedades de rastreamento de diagnóstico do agente |
|
Volume |
Propriedades VolumeClaimResourceRequirements |
|
Volume |
VolumeClaimResourceRequirementsClaims. |
|
Volume |
Propriedades de VolumeClaimSpec |
|
Volume |
Propriedades de VolumeClaimSpecSelector |
|
Volume |
Propriedades VolumeClaimSpecSelectorMatchExpressions |
AdvancedSettings
Configurações Avançadas do Agente
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| clients |
Configurações relacionadas a Todos os Clientes. |
||
| encryptInternalTraffic | Enabled |
A configuração para habilitar ou desabilitar a criptografia do tráfego interno. |
|
| internalCerts |
Rotação de certificado e configuração de chave privada. |
BackendChain
Propriedades desejadas das instâncias de back-end do agente
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| partitions |
integer (int32) minimum: 1maximum: 16 |
O número desejado de partições de back-end físicas. |
|
| redundancyFactor |
integer (int32) minimum: 1maximum: 5 |
O número desejado de réplicas de back-end (pods) em uma partição física. |
|
| workers |
integer (int32) minimum: 1maximum: 16 |
1 |
Número de trabalhos de back-end lógicos por réplica (pod). |
BrokerDiagnostics
Propriedades de Configuração de Diagnóstico do Agente
| Nome | Tipo | Description |
|---|---|---|
| logs |
Configurações de log de diagnóstico para o recurso. |
|
| metrics |
As configurações de métricas para o recurso. |
|
| selfCheck |
As propriedades de auto-verificação. |
|
| traces |
As propriedades de rastreamento. |
BrokerMemoryProfile
As configurações de perfil de memória do Agente
| Valor | Description |
|---|---|
| Tiny |
Perfil de memória minúsculo. |
| Low |
Perfil de memória baixo. |
| Medium |
Perfil de memória médio. |
| High |
Perfil de memória alta. |
BrokerPersistence
Configuração de persistência de disco.
Quando a persistência estiver habilitada, determinados itens (dados não críticos para desempenho) selecionados para persistência residirão apenas no disco. Abaixo estão os itens afetados:
- As mensagens retidas serão armazenadas apenas no disco.
- As mensagens WILL serão armazenadas apenas no disco.
- Os pares de chave/valor DSS serão armazenados somente no disco, exceto para itens críticos de desempenho, como bloqueios cronometrados, que permanecem no disco e na memória para melhorar o desempenho.
Optional. Tudo está na memória se não estiver definido. Observação: se configurado, todos os estados de sessão MQTT são gravados no disco.
| Nome | Tipo | Description |
|---|---|---|
| encryption |
Controla as configurações relacionadas à criptografia do banco de dados de persistência. Opcional, o padrão é habilitar a criptografia. |
|
| maxSize |
string |
O tamanho máximo do buffer de mensagem no disco. Se um modelo de PVC for especificado usando persistentVolumeClaimSpec Em seguida, esse tamanho será usado como os tamanhos de solicitação e limite desse modelo. Se um modelo de PVC não for especificado, o provisionador de caminho local será solicitado com esse limite de tamanho. Required. |
| persistentVolumeClaimSpec |
Use o modelo de declaração de volume persistente especificado para montar um volume persistente. Mesmo objeto do diskBackedMessageBuffer, mas com a limitação de que o campo de modos access deve ser definido para Se não estiver definido, um PVC padrão com propriedades padrão será usado. Entre outras coisas, esse PVC usará a classe padrão de storage do cluster, que pode ou não estar usando um provisionador de caminho local. O usuário está optando por um comportamento subótimo se deixar isso sem definir ou sem o campo de classe storage, e o padrão do cluster não for uma classe de caminho local. |
|
| retain | BrokerRetainMessagesPolicy: |
Controla quais mensagens retidas do tópico devem ser mantidas no disco. |
| stateStore | BrokerStateStorePolicy: |
Controla quais chaves devem ser mantidas no disco para o repositório de estado. |
| subscriberQueue | BrokerSubscriberQueuePolicy: |
Controla quais filas de mensagens do assinante devem ser mantidas no disco. Importante: para facilitar a reconexão, os metadados do estado da sessão são SEMPRE gravados no disco se alguma configuração de persistência for especificada, mesmo que esta seção não esteja definida. |
BrokerPersistenceEncryption
Propriedades de criptografia de persistência do agente.
| Nome | Tipo | Description |
|---|---|---|
| mode |
Determina se a criptografia está habilitada. |
BrokerPersistencePolicyMode
Valores do Modo de Política de Persistência do Broker.
| Valor | Description |
|---|---|
| All |
Modo de política para todos. |
| None |
Modo de política para Nenhum. |
| Custom |
Indica que a política é uma política personalizada. |
BrokerProperties
Propriedades do Recurso do Agente
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| advanced |
Configurações avançadas do Broker. |
||
| cardinality |
Os detalhes de cardinalidade do agente. |
||
| diagnostics |
A especificação define as identidades desejadas das configurações de diagnóstico do Broker. |
||
| diskBackedMessageBuffer |
Configurações do buffer de mensagens com backup de disco. |
||
| generateResourceLimits |
Essa configuração controla se os limites de recursos da CPU do Kubernetes são solicitados. Aumentar proporcionalmente o número de réplicas ou trabalhadores aumenta proporcionalmente a quantidade de recursos de CPU solicitados. Se essa configuração estiver habilitada e houver recursos de CPU insuficientes, um erro será emitido. |
||
| healthState | Unknown |
O estado de integridade do recurso. |
|
| highPriorityMessagesBackpressureHandling |
Tratamento de mensagens de alta prioridade caso as mensagens de prioridade regular estejam sendo pressionadas contra a inversão. Quando configurado para "Aceitar", o corretor continua aceitando mensagens de alta prioridade mesmo enquanto as de prioridade regular são rejeitadas devido à contrapressão. Quando configurado para "Rejeitar", a contrapressão também afeta mensagens de alta prioridade. O padrão é "Aceitar". |
||
| memoryProfile | Medium |
Perfil de memória do Agente. |
|
| persistence |
As configurações de persistência do Broker. |
||
| provisioningState |
O status da última operação. |
||
| status |
O status do corretor. |
BrokerResource
Recurso do agente de instância
| Nome | Tipo | Description |
|---|---|---|
| extendedLocation |
Local de borda do recurso. |
|
| id |
string (arm-id) |
ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
| name |
string |
O nome do recurso |
| properties |
As propriedades específicas do recurso para esse recurso. |
|
| systemData |
Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy. |
|
| type |
string |
O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
BrokerRetainMessagesCustomPolicy
Política de Retenção de Mensagem do Agente Personalizado.
| Nome | Tipo | Description |
|---|---|---|
| mode |
string:
Custom |
'Todos' para persistir todas as mensagens de retenção, 'Nenhum' para não persistir nenhuma, 'Personalizado' para persistir apenas os tópicos especificados. |
| retainSettings |
Configurações para a política. |
BrokerRetainMessagesDynamic
Configurações dinâmicas de BrokerRetainMessagesCustomPolicy.
| Nome | Tipo | Description |
|---|---|---|
| mode |
Modo do BrokerRetainMessagesCustomPolicy. |
BrokerRetainMessagesSettings
Propriedades de Mensagens de Retenção do Broker.
| Nome | Tipo | Description |
|---|---|---|
| dynamic |
Controla se os clientes MQTT podem solicitar persistência de disco por meio da |
|
| topics |
string[] |
Lista de tópicos sob os quais as mensagens retidas seriam mantidas no disco. Curingas # e + suportados. |
BrokerStateStoreCustomPolicy
Política personalizada do repositório de estado do corretor.
| Nome | Tipo | Description |
|---|---|---|
| mode |
string:
Custom |
'Todos' para persistir todas as chaves, 'Nenhum' para não persistir nenhuma, 'Personalizado' para persistir apenas as chaves especificadas. |
| stateStoreSettings |
Configurações para a política. |
BrokerStateStoreDynamic
Configurações dinâmicas de BrokerStateStoreCustomPolicy.
| Nome | Tipo | Description |
|---|---|---|
| mode |
Modo do BrokerStateStoreCustomPolicy. |
BrokerStateStoreKeyType
Propriedades do tipo de chave do repositório de estado do agente.
| Valor | Description |
|---|---|
| Pattern |
Usado para correspondência de padrões no estilo glob. |
| String |
Usado para fazer correspondência exata, por exemplo, quando uma chave contém caracteres que podem ser correspondidos como um padrão (*, ?, [0-9]). |
| Binary |
Usado para corresponder a uma chave binária. |
BrokerStateStorePolicyResources
Propriedades de recursos de política de repositório de estado do agente.
| Nome | Tipo | Description |
|---|---|---|
| keyType |
A chave para persistir no disco. |
|
| keys |
string[] |
Lista de chaves a serem mantidas no disco, necessária. |
BrokerStateStorePolicySettings
Configurações de política personalizadas do repositório de estado do agente.
| Nome | Tipo | Description |
|---|---|---|
| dynamic |
Controla se os clientes MQTT podem solicitar persistência de disco por meio da |
|
| stateStoreResources |
Lista de chave e tipo de chave a serem persistidos no disco. |
BrokerStatus
Status de corretora.
| Nome | Tipo | Description |
|---|---|---|
| healthState |
O estado de saúde do Corretor. |
BrokerSubscriberQueueCustomPolicy
Propriedades personalizadas da política de fila de assinantes.
| Nome | Tipo | Description |
|---|---|---|
| mode |
string:
Custom |
'Todos' para persistir todas as filas de assinantes, 'Nenhum' para não persistir nenhuma, 'Personalizado' para persistir apenas as filas especificadas. |
| subscriberQueueSettings |
Política personalizada, necessária se o modo for Personalizado. As filas de assinantes de todos os grupos são mantidas no disco (OR lógico). |
BrokerSubscriberQueueCustomPolicySettings
Propriedades da Política Personalizada da Fila de Assinantes do Agente.
| Nome | Tipo | Description |
|---|---|---|
| dynamic |
Controla se os clientes MQTT podem solicitar persistência de disco por meio da |
|
| subscriberClientIds |
string[] |
Lista de IDs de cliente dos assinantes, curinga * suportado. |
BrokerSubscriberQueueDynamic
Configurações dinâmicas de BrokerSubscriberQueueCustomPolicy.
| Nome | Tipo | Description |
|---|---|---|
| mode |
Modo do BrokerSubscriberQueueCustomPolicy. |
Cardinality
Propriedades de cardinalidade
| Nome | Tipo | Description |
|---|---|---|
| backendChain |
As propriedades desejadas do agente de back-end |
|
| frontend |
As propriedades desejadas do front-end |
CertManagerCertOptions
Propriedades do Cert Manager Cert
| Nome | Tipo | Description |
|---|---|---|
| duration |
string |
Tempo de vida do certificado. Deve ser especificado usando um tempo go. Formato de duração (h|m|s). Por exemplo, 240h por 240 horas e 45m por 45 minutos. |
| privateKey |
Configuração da chave privada do certificado. |
|
| renewBefore |
string |
Quando começar a renovar o certificado. Deve ser especificado usando um tempo go. Formato de duração (h|m|s). Por exemplo, 240h por 240 horas e 45m por 45 minutos. |
CertManagerPrivateKey
Propriedades de chave privada do Gerenciador de Certificados
| Nome | Tipo | Description |
|---|---|---|
| algorithm |
algoritmo de chave privada. |
|
| rotationPolicy |
Rotação de chaves privadas do gerenciador de certificadoresPolítica. |
ClientConfig
As configurações da Configuração do Cliente.
| Nome | Tipo | Description |
|---|---|---|
| maxKeepAliveSeconds |
integer (int32) minimum: 0maximum: 65535 |
Limite superior de Keep Alive de um cliente, em segundos. |
| maxMessageExpirySeconds |
integer (int32) minimum: 1 |
Limite superior do intervalo de expiração da mensagem, em segundos. |
| maxPacketSizeBytes |
integer (int32) minimum: 1maximum: 268435456 |
Tamanho máximo da mensagem para um pacote em Bytes. |
| maxReceiveMaximum |
integer (int32) minimum: 1maximum: 65535 |
Limite superior do Máximo de Recebimento que um cliente pode solicitar no pacote CONNECT. |
| maxSessionExpirySeconds |
integer (int32) minimum: 1 |
Limite superior do intervalo de expiração da sessão, em segundos. |
| subscriberQueueLimit |
O limite no número de mensagens enfileiradas para um assinante. |
createdByType
O tipo de identidade que criou o recurso.
| Valor | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DiagnosticsLogs
Propriedades do Log de Diagnóstico
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| level |
string |
info |
O nível de log. Exemplos - 'depuração', 'info', 'warn', 'error', 'trace'. |
DiskBackedMessageBuffer
Propriedades diskBackedMessageBuffer
| Nome | Tipo | Description |
|---|---|---|
| ephemeralVolumeClaimSpec |
Use o modelo de declaração de volume persistente especificado para montar um "volume efêmero genérico" para o buffer de mensagem. Consulte https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes para obter detalhes. |
|
| maxSize |
string pattern: ^[0-9]+[KMGTPE]$ |
O tamanho máximo do buffer de mensagem no disco. Se um modelo de PVC for especificado usando um dos tamanhos efêmerosVolumeClaimSpec ou persistentVolumeClaimSpec, esse tamanho será usado como os tamanhos de solicitação e limite desse modelo. Se nem ephemeralVolumeClaimSpec nem persistentVolumeClaimSpec forem especificados, um volume emptyDir será montado com esse tamanho como seu limite. Consulte https://kubernetes.io/docs/concepts/storage/volumes/#emptydir para obter detalhes. |
| persistentVolumeClaimSpec |
Use o modelo de declaração de volume persistente especificado para montar um volume persistente para o buffer de mensagem. |
ErrorAdditionalInfo
Informações adicionais sobre o erro de gerenciamento de recursos.
| Nome | Tipo | Description |
|---|---|---|
| info |
object |
As informações adicionais. |
| type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
| Nome | Tipo | Description |
|---|---|---|
| additionalInfo |
Informações adicionais do erro. |
|
| code |
string |
O código de erro. |
| details |
Os detalhes do erro. |
|
| message |
string |
A mensagem de erro. |
| target |
string |
O alvo do erro. |
ErrorResponse
Resposta de erro
| Nome | Tipo | Description |
|---|---|---|
| error |
O objeto de erro. |
ExtendedLocation
O local estendido é uma extensão dos locais do Azure. Eles fornecem uma maneira de usar seus clusters kubernetes habilitados para Azure ARC como locais de destino para implantar instâncias de serviços do Azure.
| Nome | Tipo | Description |
|---|---|---|
| name |
string |
O nome do local estendido. |
| type |
Tipo de ExtendedLocation. |
ExtendedLocationType
O tipo de definição de enumeração de ExtendedLocation aceito.
| Valor | Description |
|---|---|
| CustomLocation |
Tipo CustomLocation |
Frontend
As propriedades desejadas das instâncias de front-end do Broker
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| replicas |
integer (int32) minimum: 1maximum: 16 |
O número desejado de instâncias de front-end (pods). |
|
| workers |
integer (int32) minimum: 1maximum: 16 |
2 |
Número de trabalhos de front-end lógicos por instância (pod). |
GenerateResourceLimits
Propriedades GenerateResourceLimits
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| cpu | Enabled |
A alternância para habilitar/desabilitar os limites de recursos da cpu. |
HighPriorityMessagesBackpressureHandling
Tratamento de mensagens de alta prioridade durante o estado de contrapressão.
| Valor | Description |
|---|---|
| Accept |
Quando o corretor rejeita mensagens de prioridade regular devido à pressão contrária, ele continua aceitando mensagens de alta prioridade. |
| Reject |
Quando o corretor rejeita mensagens de prioridade regular devido à pressão contrária, ele também rejeita mensagens de alta prioridade. |
KubernetesReference
Referência do Kubernetes
| Nome | Tipo | Description |
|---|---|---|
| apiGroup |
string |
APIGroup é o grupo para o recurso que está sendo referenciado. Se APIGroup não for especificado, o Tipo especificado deverá estar no grupo de API principal. Para qualquer outro tipo de terceiro, a APIGroup é necessária. |
| kind |
string |
Kind é o tipo de recurso que está sendo referenciado |
| name |
string |
Nome é o nome do recurso que está sendo referenciado |
| namespace |
string |
Namespace é o namespace do recurso que está sendo referenciado. Esse campo é necessário quando o recurso tem um namespace. |
LocalKubernetesReference
Referência do Kubernetes
| Nome | Tipo | Description |
|---|---|---|
| apiGroup |
string |
APIGroup é o grupo para o recurso que está sendo referenciado. Se APIGroup não for especificado, o Tipo especificado deverá estar no grupo de API principal. Para qualquer outro tipo de terceiro, a APIGroup é necessária. |
| kind |
string |
Kind é o tipo de recurso que está sendo referenciado |
| name |
string |
Nome é o nome do recurso que está sendo referenciado |
Metrics
Propriedades de Métricas de Diagnóstico
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| prometheusPort |
integer (int32) minimum: 0maximum: 65535 |
9600 |
A porta prometheus para expor as métricas. |
OperationalMode
Propriedades do modo
| Valor | Description |
|---|---|
| Enabled |
Habilitado é equivalente a Verdadeiro |
| Disabled |
Disabled é equivalente a False. |
OperatorValues
Os operadores válidos são In, NotIn, Exists e DoesNotExist.
| Valor | Description |
|---|---|
| In |
No operador. |
| NotIn |
Operador NotIn. |
| Exists |
Exists operador. |
| DoesNotExist |
Operador DoesNotExist. |
PrivateKeyAlgorithm
Tipos de algoritmo de chave privada.
| Valor | Description |
|---|---|
| Ec256 |
Algoritmo - ec256. |
| Ec384 |
Algoritmo - ec384. |
| Ec521 |
Algoritmo - ec521. |
| Ed25519 |
Algoritmo - ed25519. |
| Rsa2048 |
Algoritmo - rsa2048. |
| Rsa4096 |
Algoritmo - rsa4096. |
| Rsa8192 |
Algoritmo - rsa8192. |
PrivateKeyRotationPolicy
Política de rotação de chave privada.
| Valor | Description |
|---|---|
| Always |
Política de rotação - sempre. |
| Never |
Política de rotação - Nunca. |
ProvisioningState
A enumeração definindo o status do recurso.
| Valor | Description |
|---|---|
| Succeeded |
O recurso foi criado. |
| Failed |
Falha na criação de recursos. |
| Canceled |
A criação de recursos foi cancelada. |
| Provisioning |
O recurso está sendo provisionado. |
| Updating |
O recurso está atualizando. |
| Deleting |
O recurso está sendo excluído. |
| Accepted |
O recurso foi aceito. |
ResourceHealthState
O estado de integridade do recurso.
| Valor | Description |
|---|---|
| Available |
O recurso está disponível e funcionando conforme o esperado. |
| Degraded |
A integridade do recurso é degradada. |
| Unavailable |
O recurso não está funcionando conforme o esperado. |
| Unknown |
O estado do recurso é desconhecido. |
ResourceHealthStatus
Representa o estado de saúde de um recurso.
| Nome | Tipo | Description |
|---|---|---|
| lastTransitionTime |
string |
O carimbo de data (RFC3339) em que o estado de saúde mudou pela última vez. |
| lastUpdateTime |
string |
O carimbo de data (RFC3339) quando o status de saúde foi atualizado pela última vez, mesmo que o status não tenha mudado. |
| message |
string |
Uma mensagem legível para humanos descrevendo a última transição. |
| reasonCode |
string |
Código de razão único, CamelCase descrevendo a causa da última transição do estado de saúde. |
| status |
O nível alto de saúde do recurso. |
SelfCheck
Propriedades de autoconfiamento de diagnóstico do agente
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| intervalSeconds |
integer (int32) minimum: 30maximum: 300 |
30 |
O intervalo de auto-verificação. |
| mode | Enabled |
A alternância para habilitar/desabilitar a auto check. |
|
| timeoutSeconds |
integer (int32) minimum: 5maximum: 120 |
15 |
O tempo limite para auto-verificação. |
SelfTracing
Propriedades de autoatendimento de diagnóstico
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| intervalSeconds |
integer (int32) minimum: 1maximum: 300 |
30 |
O intervalo de auto rastreamento. |
| mode | Enabled |
A alternância para habilitar/desabilitar o auto rastreamento. |
SubscriberMessageDropStrategy
A enumeração definindo estratégias para remover mensagens da fila de assinantes.
| Valor | Description |
|---|---|
| None |
As mensagens nunca são descartadas. |
| DropOldest |
A mensagem mais antiga é descartada. |
SubscriberQueueLimit
As configurações do Limite de Fila do Assinante.
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| length |
integer (int64) minimum: 1 |
O comprimento máximo da fila antes que as mensagens comecem a ser descartadas. |
|
| strategy | None |
A estratégia a ser usada para remover mensagens da fila. |
systemData
Metadados relativos à criação e última modificação do recurso.
| Nome | Tipo | Description |
|---|---|---|
| createdAt |
string (date-time) |
O registro de data e hora da criação do recurso (UTC). |
| createdBy |
string |
A identidade que criou o recurso. |
| createdByType |
O tipo de identidade que criou o recurso. |
|
| lastModifiedAt |
string (date-time) |
O carimbo de data/hora da última modificação do recurso (UTC) |
| lastModifiedBy |
string |
A identidade que modificou o recurso pela última vez. |
| lastModifiedByType |
O tipo de identidade que modificou o recurso pela última vez. |
Traces
Propriedades de rastreamento de diagnóstico do agente
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| cacheSizeMegabytes |
integer (int32) minimum: 1maximum: 128 |
16 |
O tamanho do cache em megabytes. |
| mode | Enabled |
A alternância para habilitar/desabilitar rastreamentos. |
|
| selfTracing |
As propriedades de auto rastreamento. |
||
| spanChannelCapacity |
integer (int32) minimum: 1000maximum: 100000 |
1000 |
A capacidade do canal de extensão. |
VolumeClaimResourceRequirements
Propriedades VolumeClaimResourceRequirements
| Nome | Tipo | Description |
|---|---|---|
| claims |
Declarações lista os nomes dos recursos, definidos em spec.resourceClaims, que são usados por esse contêiner. Este é um campo alfa e requer a habilitação do portão de recursos DynamicResourceAllocation. Esse campo é imutável. Ele só pode ser definido para contêineres. |
|
| limits |
object |
Os limites descrevem a quantidade máxima de recursos de computação permitidos. Mais informações: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
| requests |
object |
As solicitações descrevem a quantidade mínima de recursos de computação necessários. Se As Solicitações forem omitidas para um contêiner, ele usará como padrão limites se isso for especificado explicitamente, caso contrário, para um valor definido pela implementação. Mais informações: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
VolumeClaimResourceRequirementsClaims
VolumeClaimResourceRequirementsClaims.
| Nome | Tipo | Description |
|---|---|---|
| name |
string |
Nome do recurso. Isso deve corresponder ao nome de um recurso em spec.resourceClaims. |
VolumeClaimSpec
Propriedades de VolumeClaimSpec
| Nome | Tipo | Description |
|---|---|---|
| accessModes |
string[] |
AccessModes contém os modos de access desejados que o volume deve ter. Mais informações: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
| dataSource |
Este campo pode ser usado para especificar com: * Um objeto VolumeSnapshot existente (snapshot.storage. k8s.io/VolumeSnapshot) * Um PVC existente (PersistentVolumeClaim) Se o provisioner ou um controlador externo puder suportar a fonte de dados especificada, ele criará um novo volume com base no conteúdo da fonte de dados especificada. Se a porta de recursos AnyVolumeDataSource estiver habilitada, esse campo sempre terá o mesmo conteúdo que o campo DataSourceRef. |
|
| dataSourceRef |
Especifica o objeto do qual preencher o volume com dados, se um volume não vazio for desejado. Pode ser qualquer objeto local de um grupo de API não vazio (objeto não core) ou de um objeto PersistentVolumeClaim. Quando esse campo for especificado, a associação de volume só terá êxito se o tipo do objeto especificado corresponder a algum populador de volume instalado ou provisionador dinâmico. Esse campo substituirá a funcionalidade do campo DataSource e, como tal, se ambos os campos não estiverem vazios, eles deverão ter o mesmo valor. Para compatibilidade com versões anteriores, ambos os campos (DataSource e DataSourceRef) serão definidos como o mesmo valor automaticamente se um deles estiver vazio e o outro não estiver vazio. Há duas diferenças importantes entre DataSource e DataSourceRef: * Embora o DataSource permita apenas dois tipos específicos de objetos, DataSourceRef permite qualquer objeto não principal, bem como objetos PersistentVolumeClaim. * Embora o DataSource ignore valores não permitidos (descartando-os), o DataSourceRef preservará todos os valores e gerará um erro se um valor não permitido for especificado. (Beta) Usar esse campo requer que a porta de recursos AnyVolumeDataSource seja habilitada. |
|
| resources |
Os recursos representam os recursos mínimos que o volume deve ter. Se o recurso RecoverVolumeExpansionFailure estiver habilitado, os usuários poderão especificar requisitos de recurso que sejam menores do que o valor anterior, mas ainda deverão ser maiores do que a capacidade registrada no campo de status da declaração. Mais informações: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
|
| selector |
Uma consulta de rótulo em volumes a serem considerados para associação. |
|
| storageClassName |
string |
Nome do StorageClass exigido pela declaração. Mais informações: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
| volumeMode |
string |
volumeMode define que tipo de volume é exigido pela declaração. O valor do sistema de arquivos é implícito quando não está incluído na especificação de declaração. Esse é um recurso beta. |
| volumeName |
string |
VolumeName é a referência de associação ao PersistentVolume que está apoiando essa declaração. |
VolumeClaimSpecSelector
Propriedades de VolumeClaimSpecSelector
| Nome | Tipo | Description |
|---|---|---|
| matchExpressions |
MatchExpressions é uma lista de requisitos de seletor de rótulo. Os requisitos são ANDed. |
|
| matchLabels |
object |
MatchLabels é um mapa de pares {key,value}. Uma única {key,value} no mapa matchLabels é equivalente a um elemento de matchExpressions, cujo campo de chave é "key", o operador é "In" e a matriz de valores contém apenas "valor". Os requisitos são ANDed. |
VolumeClaimSpecSelectorMatchExpressions
Propriedades VolumeClaimSpecSelectorMatchExpressions
| Nome | Tipo | Description |
|---|---|---|
| key |
string |
é a chave de rótulo à qual o seletor se aplica. |
| operator |
O operador representa a relação de uma chave com um conjunto de valores. Os operadores válidos são In, NotIn, Exists e DoesNotExist. |
|
| values |
string[] |
valores é uma matriz de valores de cadeia de caracteres. Se o operador estiver In ou NotIn, a matriz de valores deverá não estar vazia. Se o operador for Exists ou DoesNotExist, a matriz de valores deverá estar vazia. Essa matriz é substituída durante um patch de mesclagem estratégica. |