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 do URI
| Name | Em | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
broker
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$ |
Nome do corretor. |
|
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 um UUID. |
|
api-version
|
query | True |
string minLength: 1 |
A versão da API a utilizar para esta operação. |
Corpo do Pedido
| Name | Tipo | Descrição |
|---|---|---|
| extendedLocation |
Localização de borda do recurso. |
|
| properties |
As propriedades específicas do recurso para este recurso. |
Respostas
| Name | Tipo | Descrição |
|---|---|---|
| 200 OK |
Operação de atualização do recurso 'BrokerResource' bem-sucedida |
|
| 201 Created |
Recurso 'BrokerResource' criar operação bem-sucedida Cabeçalhos
|
|
| Other Status Codes |
Uma resposta de erro inesperada. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory.
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
| Name | Descrição |
|---|---|
| user_impersonation | assumir a identidade da sua conta de utilizador |
Exemplos
|
Broker_Create |
|
Broker_Create |
|
Broker_Create |
|
Broker_Create |
Broker_CreateOrUpdate
Pedido de amostra
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 da amostra
{
"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
Pedido de amostra
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 da amostra
{
"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
Pedido de amostra
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 da amostra
{
"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
Pedido de amostra
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 da amostra
{
"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
| Name | Descrição |
|---|---|
|
Advanced |
Configurações avançadas do corretor |
|
Backend |
Propriedades desejadas das instâncias de back-end do broker |
|
Broker |
Propriedades da Configuração de Diagnóstico do Broker |
|
Broker |
As configurações de perfil de memória do Broker |
|
Broker |
Configuração de persistência de disco. Quando a persistência está habilitada, determinados itens (dados não críticos para o desempenho) selecionados para persistência residirão apenas no disco. Abaixo estão os itens afetados:
Opcional. Tudo está na memória se não estiver definido. Nota: se configurado, todos os estados de sessão MQTT são gravados no disco. |
|
Broker |
Propriedades de criptografia de persistência do broker. |
|
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 mensagens do Custom Broker. |
|
Broker |
Configurações dinâmicas de BrokerRetainMessagesCustomPolicy. |
|
Broker |
Propriedades Broker Retain Messages. |
|
Broker |
Política Personalizada do Broker State Store. |
|
Broker |
Configurações dinâmicas de BrokerStateStoreCustomPolicy. |
|
Broker |
Propriedades do Tipo de Chave do Broker State Store. |
|
Broker |
Propriedades dos Recursos de Política do Repositório do Estado do Broker. |
|
Broker |
Configurações de política personalizada do Broker State Store. |
|
Broker |
Estado de BrokerStatus. |
|
Broker |
Propriedades personalizadas da política de fila de assinantes. |
|
Broker |
Propriedades da Política Personalizada da Fila de Assinantes do Broker. |
|
Broker |
Configurações dinâmicas de BrokerSubscriberQueueCustomPolicy. |
| Cardinality |
Propriedades de cardinalidade |
|
Cert |
Propriedades do Cert Manager Cert |
|
Cert |
Propriedades de chave privada do Cert Manager |
|
Client |
As configurações de 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 gestão 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 enum que define o tipo de ExtendedLocation aceito. |
| Frontend |
As propriedades desejadas das instâncias de frontend do Broker |
|
Generate |
GenerateResourceLimits propriedades |
|
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 algoritmos de chave privada. |
|
Private |
Política de rotação de chave privada. |
|
Provisioning |
O enum que define o status do recurso. |
|
Resource |
O estado de saúde do recurso. |
|
Resource |
Representa o estado de saúde de um recurso. |
|
Self |
Propriedades de autoverificação de diagnóstico do corretor |
|
Self |
Propriedades de auto-rastreamento de diagnóstico |
|
Subscriber |
O enum que define estratégias para retirar mensagens da fila de assinantes. |
|
Subscriber |
As configurações de Limite de fila de assinantes. |
|
system |
Metadados referentes à criação e última modificação do recurso. |
| Traces |
Propriedades do Rastreamento de Diagnóstico do Broker |
|
Volume |
VolumeClaimResourceRequirements propriedades |
|
Volume |
VolumeClaimResourceRequirementsClaims propriedades. |
|
Volume |
Propriedades VolumeClaimSpec |
|
Volume |
Propriedades VolumeClaimSpecSelector |
|
Volume |
VolumeClaimSpecSelectorMatchExpressions propriedades |
AdvancedSettings
Configurações avançadas do corretor
| Name | Tipo | Valor predefinido | Descrição |
|---|---|---|---|
| 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 certificados e configuração de chave privada. |
BackendChain
Propriedades desejadas das instâncias de back-end do broker
| Name | Tipo | Valor predefinido | Descrição |
|---|---|---|---|
| partitions |
integer (int32) minimum: 1maximum: 16 |
O número desejado de partições físicas de back-end. |
|
| 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 trabalhadores de back-end lógico por réplica (pod). |
BrokerDiagnostics
Propriedades da Configuração de Diagnóstico do Broker
| Name | Tipo | Descrição |
|---|---|---|
| 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 Broker
| Valor | Descrição |
|---|---|
| Tiny |
Perfil de memória minúsculo. |
| Low |
Baixo perfil de memória. |
| Medium |
Perfil de memória média. |
| High |
Alto perfil de memória. |
BrokerPersistence
Configuração de persistência de disco.
Quando a persistência está habilitada, determinados itens (dados não críticos para o 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 chave/valor DSS serão armazenados apenas no disco, exceto para itens críticos de desempenho, como bloqueios temporizados, que permanecem no disco e na memória para melhorar o desempenho.
Opcional. Tudo está na memória se não estiver definido. Nota: se configurado, todos os estados de sessão MQTT são gravados no disco.
| Name | Tipo | Descrição |
|---|---|---|
| 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 mensagens no disco. Se um modelo de PVC for especificado usando persistentVolumeClaimSpec, 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. O 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, será usado um PVC padrão com propriedades padrão. Entre outras coisas, este PVC usará a classe de storage padrão do cluster, que pode ou não estar a usar um path provisioner local. O utilizador opta por um comportamento subótimo se deixar este comportamento sem definir ou se o definir sem o campo storage class, e o seu cluster por defeito 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 persistidas no disco para o armazenamento 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 broker.
| Name | Tipo | Descrição |
|---|---|---|
| mode |
Determina se a criptografia está habilitada. |
BrokerPersistencePolicyMode
Valores do Modo de Política de Persistência do Broker.
| Valor | Descrição |
|---|---|
| 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
| Name | Tipo | Valor predefinido | Descrição |
|---|---|---|---|
| advanced |
Configurações avançadas do Broker. |
||
| cardinality |
Os detalhes de cardinalidade do corretor. |
||
| diagnostics |
Spec 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 o número de réplicas ou trabalhadores aumenta proporcionalmente a quantidade de recursos de CPU solicitados. Se essa configuração estiver ativada e não houver recursos de CPU suficientes, um erro será emitido. |
||
| healthState | Unknown |
O estado de saúde do recurso. |
|
| highPriorityMessagesBackpressureHandling |
Gestão de mensagens de alta prioridade caso as mensagens de prioridade regular estejam a ser pressionadas por trás. Quando definido para "Aceitar", o intermediário continua a aceitar mensagens de alta prioridade mesmo quando as mensagens de prioridade regular são rejeitadas devido à contrapressão. Quando definido como "Rejeitar", a contrapressão também afeta mensagens de alta prioridade. Por defeito, é "Aceitar". |
||
| memoryProfile | Medium |
Perfil de memória do Broker. |
|
| persistence |
As configurações de persistência do Broker. |
||
| provisioningState |
O status da última operação. |
||
| status |
O estado do corretor. |
BrokerResource
Recurso do agente de instância
| Name | Tipo | Descrição |
|---|---|---|
| extendedLocation |
Localização de borda do recurso. |
|
| id |
string (arm-id) |
ID de recurso totalmente qualificado 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 este recurso. |
|
| systemData |
Metadados do Azure Resource Manager contendo 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 mensagens do Custom Broker.
| Name | Tipo | Descrição |
|---|---|---|
| mode |
string:
Custom |
'Todos' para persistir todas as mensagens retidas, '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.
| Name | Tipo | Descrição |
|---|---|---|
| mode |
Modo do BrokerRetainMessagesCustomPolicy. |
BrokerRetainMessagesSettings
Propriedades Broker Retain Messages.
| Name | Tipo | Descrição |
|---|---|---|
| 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 Broker State Store.
| Name | Tipo | Descrição |
|---|---|---|
| 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.
| Name | Tipo | Descrição |
|---|---|---|
| mode |
Modo do BrokerStateStoreCustomPolicy. |
BrokerStateStoreKeyType
Propriedades do Tipo de Chave do Broker State Store.
| Valor | Descrição |
|---|---|
| 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 poderiam ser correspondidos como um padrão (*, ?, [0-9]). |
| Binary |
Usado para corresponder a uma chave binária. |
BrokerStateStorePolicyResources
Propriedades dos Recursos de Política do Repositório do Estado do Broker.
| Name | Tipo | Descrição |
|---|---|---|
| keyType |
A chave para persistir no disco. |
|
| keys |
string[] |
Lista de chaves para persistir no disco, obrigatório. |
BrokerStateStorePolicySettings
Configurações de política personalizada do Broker State Store.
| Name | Tipo | Descrição |
|---|---|---|
| dynamic |
Controla se os clientes MQTT podem solicitar persistência de disco por meio da |
|
| stateStoreResources |
Lista de chave e tipo de chave a persistir no disco. |
BrokerStatus
Estado de BrokerStatus.
| Name | Tipo | Descrição |
|---|---|---|
| healthState |
O estado de saúde do Corretor. |
BrokerSubscriberQueueCustomPolicy
Propriedades personalizadas da política de fila de assinantes.
| Name | Tipo | Descrição |
|---|---|---|
| mode |
string:
Custom |
'Todos' para persistir todas as filas de assinantes, 'Nenhum' para não persistir nenhum, '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 Broker.
| Name | Tipo | Descrição |
|---|---|---|
| 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.
| Name | Tipo | Descrição |
|---|---|---|
| mode |
Modo do BrokerSubscriberQueueCustomPolicy. |
Cardinality
Propriedades de cardinalidade
| Name | Tipo | Descrição |
|---|---|---|
| backendChain |
As propriedades desejadas do agente de back-end |
|
| frontend |
As propriedades desejadas do frontend |
CertManagerCertOptions
Propriedades do Cert Manager Cert
| Name | Tipo | Descrição |
|---|---|---|
| duration |
string |
Tempo de vida do certificado. Deve ser especificado usando um tempo Go. Formato de duração (h|m|s). Por exemplo, 240h durante 240 horas e 45m durante 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 durante 240 horas e 45m durante 45 minutos. |
CertManagerPrivateKey
Propriedades de chave privada do Cert Manager
| Name | Tipo | Descrição |
|---|---|---|
| algorithm |
algoritmo para chave privada. |
|
| rotationPolicy |
Certific-manager rotação de chaves privadasPolítica. |
ClientConfig
As configurações de Configuração do cliente.
| Name | Tipo | Descrição |
|---|---|---|
| maxKeepAliveSeconds |
integer (int32) minimum: 0maximum: 65535 |
Limite superior do 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 de Receber máximo 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 do número de mensagens enfileiradas para um assinante. |
createdByType
O tipo de identidade que criou o recurso.
| Valor | Descrição |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DiagnosticsLogs
Propriedades do log de diagnóstico
| Name | Tipo | Valor predefinido | Descrição |
|---|---|---|---|
| level |
string |
info |
O nível de log. Exemplos - 'debug', 'info', 'warn', 'error', 'trace'. |
DiskBackedMessageBuffer
Propriedades DiskBackedMessageBuffer
| Name | Tipo | Descrição |
|---|---|---|
| ephemeralVolumeClaimSpec |
Use o modelo de declaração de volume persistente especificado para montar um "volume efêmero genérico" para o buffer de mensagens. 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 mensagens no disco. Se um modelo de PVC for especificado usando um dos ephemeralVolumeClaimSpec ou persistentVolumeClaimSpec, esse tamanho será usado como a solicitação e os tamanhos de limite desse modelo. Se nem ephemeralVolumeClaimSpec nem persistentVolumeClaimSpec forem especificados, então um volume emptyDir será montado com esse tamanho como 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 mensagens. |
ErrorAdditionalInfo
Informações adicionais sobre o erro de gestão de recursos.
| Name | Tipo | Descrição |
|---|---|---|
| info |
object |
As informações adicionais. |
| type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
| Name | Tipo | Descrição |
|---|---|---|
| additionalInfo |
As 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
| Name | Tipo | Descrição |
|---|---|---|
| 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.
| Name | Tipo | Descrição |
|---|---|---|
| name |
string |
O nome do local estendido. |
| type |
Tipo de ExtendedLocation. |
ExtendedLocationType
O enum que define o tipo de ExtendedLocation aceito.
| Valor | Descrição |
|---|---|
| CustomLocation |
Tipo CustomLocation |
Frontend
As propriedades desejadas das instâncias de frontend do Broker
| Name | Tipo | Valor predefinido | Descrição |
|---|---|---|---|
| replicas |
integer (int32) minimum: 1maximum: 16 |
O número desejado de instâncias de frontend (pods). |
|
| workers |
integer (int32) minimum: 1maximum: 16 |
2 |
Número de trabalhadores de frontend lógico por instância (pod). |
GenerateResourceLimits
GenerateResourceLimits propriedades
| Name | Tipo | Valor predefinido | Descrição |
|---|---|---|---|
| cpu | Enabled |
A alternância para ativar/desativar os limites de recursos da cpu. |
HighPriorityMessagesBackpressureHandling
Tratamento de mensagens de alta prioridade durante o estado de contrapressão.
| Valor | Descrição |
|---|---|
| Accept |
Quando o corretor rejeita mensagens de prioridade regular devido à pressão contrária, continua a aceitar mensagens de alta prioridade. |
| Reject |
Quando o corretor rejeita mensagens de prioridade regular devido à contrapressão, também rejeita mensagens de alta prioridade. |
KubernetesReference
Referência do Kubernetes
| Name | Tipo | Descrição |
|---|---|---|
| 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 principal da API. Para quaisquer outros tipos de terceiros, APIGroup é necessário. |
| 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. Este campo é obrigatório quando o recurso tem um namespace. |
LocalKubernetesReference
Referência do Kubernetes
| Name | Tipo | Descrição |
|---|---|---|
| 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 principal da API. Para quaisquer outros tipos de terceiros, APIGroup é necessário. |
| 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
| Name | Tipo | Valor predefinido | Descrição |
|---|---|---|---|
| prometheusPort |
integer (int32) minimum: 0maximum: 65535 |
9600 |
A porta prometheus para expor as métricas. |
OperationalMode
Propriedades do modo
| Valor | Descrição |
|---|---|
| Enabled |
Enabled é equivalente a True |
| Disabled |
Disabled é equivalente a False. |
OperatorValues
Os operadores válidos são In, NotIn, Exists e DoesNotExist.
| Valor | Descrição |
|---|---|
| In |
No operador. |
| NotIn |
Operador NotIn. |
| Exists |
Existe operador. |
| DoesNotExist |
Operador DoesNotExist. |
PrivateKeyAlgorithm
Tipos de algoritmos de chave privada.
| Valor | Descrição |
|---|---|
| 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 | Descrição |
|---|---|
| Always |
Política de Rotação - Sempre. |
| Never |
Política de Rotação - Nunca. |
ProvisioningState
O enum que define o status do recurso.
| Valor | Descrição |
|---|---|
| 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á se atualizando. |
| Deleting |
O recurso está sendo excluído. |
| Accepted |
O recurso foi aceito. |
ResourceHealthState
O estado de saúde do recurso.
| Valor | Descrição |
|---|---|
| Available |
O recurso está disponível e funcionando conforme o esperado. |
| Degraded |
A integridade dos recursos está degradada. |
| Unavailable |
O recurso não está funcionando como esperado. |
| Unknown |
O estado do recurso é desconhecido. |
ResourceHealthStatus
Representa o estado de saúde de um recurso.
| Name | Tipo | Descrição |
|---|---|---|
| lastTransitionTime |
string |
O carimbo temporal (RFC3339) em que o estado de saúde foi alterado pela última vez. |
| lastUpdateTime |
string |
O carimbo temporal (RFC3339) em que o estado de saúde foi atualizado pela última vez, mesmo que o estado não tenha mudado. |
| message |
string |
Uma mensagem legível para humanos a descrever a última transição. |
| reasonCode |
string |
Código de razão único, CamelCase que descreve a causa da última transição do estado de saúde. |
| status |
O estado de saúde elevado do recurso. |
SelfCheck
Propriedades de autoverificação de diagnóstico do corretor
| Name | Tipo | Valor predefinido | Descrição |
|---|---|---|---|
| intervalSeconds |
integer (int32) minimum: 30maximum: 300 |
30 |
O intervalo de auto-verificação. |
| mode | Enabled |
A alternância para ativar/desativar a autoverificação. |
|
| timeoutSeconds |
integer (int32) minimum: 5maximum: 120 |
15 |
O tempo limite para auto-verificação. |
SelfTracing
Propriedades de auto-rastreamento de diagnóstico
| Name | Tipo | Valor predefinido | Descrição |
|---|---|---|---|
| intervalSeconds |
integer (int32) minimum: 1maximum: 300 |
30 |
O intervalo de auto-rastreamento. |
| mode | Enabled |
A alternância para ativar/desativar o autorastreamento. |
SubscriberMessageDropStrategy
O enum que define estratégias para retirar mensagens da fila de assinantes.
| Valor | Descrição |
|---|---|
| None |
As mensagens nunca são descartadas. |
| DropOldest |
A mensagem mais antiga é descartada. |
SubscriberQueueLimit
As configurações de Limite de fila de assinantes.
| Name | Tipo | Valor predefinido | Descrição |
|---|---|---|---|
| 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 retirar mensagens da fila. |
systemData
Metadados referentes à criação e última modificação do recurso.
| Name | Tipo | Descrição |
|---|---|---|
| createdAt |
string (date-time) |
A marca temporal 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) |
A data e 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 do Rastreamento de Diagnóstico do Broker
| Name | Tipo | Valor predefinido | Descrição |
|---|---|---|---|
| cacheSizeMegabytes |
integer (int32) minimum: 1maximum: 128 |
16 |
O tamanho do cache em megabytes. |
| mode | Enabled |
A alternância para ativar/desativar rastreamentos. |
|
| selfTracing |
As propriedades de auto-rastreamento. |
||
| spanChannelCapacity |
integer (int32) minimum: 1000maximum: 100000 |
1000 |
A capacidade do canal de extensão. |
VolumeClaimResourceRequirements
VolumeClaimResourceRequirements propriedades
| Name | Tipo | Descrição |
|---|---|---|
| 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 ativação da porta de recurso DynamicResourceAllocation . Este campo é imutável. Só pode ser definido para contentores. |
|
| limits |
object |
Limites descreve a quantidade máxima de recursos de computação permitidos. Mais informações: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
| requests |
object |
Solicitações descreve a quantidade mínima de recursos de computação necessários. Se Solicitações for omitida para um contêiner, o padrão será Limits se isso for explicitamente especificado, caso contrário, para um valor definido pela implementação. Mais informações: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
VolumeClaimResourceRequirementsClaims
VolumeClaimResourceRequirementsClaims propriedades.
| Name | Tipo | Descrição |
|---|---|---|
| name |
string |
Nome do recurso. Isso deve corresponder ao nome de um recurso em spec.resourceClaims. |
VolumeClaimSpec
Propriedades VolumeClaimSpec
| Name | Tipo | Descrição |
|---|---|---|
| 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: * Um objeto VolumeSnapshot existente (snapshot.storage. k8s.io/VolumeSnapshot) * Um PVC existente (PersistentVolumeClaim) Se o provisioner ou um controlador externo conseguir suportar a fonte de dados especificada, criará um novo volume com base no conteúdo da fonte de dados especificada. Se a porta do recurso AnyVolumeDataSource estiver habilitada, esse campo sempre terá o mesmo conteúdo que o campo DataSourceRef. |
|
| dataSourceRef |
Especifica o objeto a partir 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 principal) ou um objeto PersistentVolumeClaim. Quando esse campo for especificado, a vinculação de volume só terá êxito se o tipo do objeto especificado corresponder a algum populador de volume instalado ou provisionador dinâmico. Este campo substituirá a funcionalidade do campo DataSource e, como tal, se ambos os campos não estiverem vazios, devem ter o mesmo valor. Para compatibilidade com versões anteriores, ambos os campos (DataSource e DataSourceRef) serão definidos automaticamente com o mesmo valor se um deles estiver vazio e o outro não estiver vazio. Há duas diferenças importantes entre DataSource e DataSourceRef: * Enquanto DataSource permite apenas dois tipos específicos de objetos, DataSourceRef permite qualquer objeto não core, bem como objetos PersistentVolumeClaim. * Enquanto DataSource ignora valores não permitidos (eliminando-os), DataSourceRef preserva todos os valores e gera um erro se um valor não permitido for especificado. (Beta) O uso deste campo requer que a porta do recurso AnyVolumeDataSource esteja habilitada. |
|
| resources |
Recursos representa os recursos mínimos que o volume deve ter. Se o recurso RecoverVolumeExpansionFailure estiver habilitado, os usuários terão permissão para especificar requisitos de recursos que são menores do que o valor anterior, mas ainda devem 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 sobre volumes a serem considerados para vinculação. |
|
| storageClassName |
string |
Nome da StorageClass exigida 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 está implícito quando não está incluído na especificação de declaração. Este é um recurso beta. |
| volumeName |
string |
VolumeName é a referência vinculativa ao PersistentVolume que apoia essa declaração. |
VolumeClaimSpecSelector
Propriedades VolumeClaimSpecSelector
| Name | Tipo | Descrição |
|---|---|---|
| matchExpressions |
MatchExpressions é uma lista de requisitos do seletor de rótulos. Os requisitos são ANDed. |
|
| matchLabels |
object |
MatchLabels é um mapa de pares {key,value}. Um único {key,value} no mapa matchLabels é equivalente a um elemento de matchExpressions, cujo campo de chave é "key", o operador é "In" e a matriz values contém apenas "value". Os requisitos são ANDed. |
VolumeClaimSpecSelectorMatchExpressions
VolumeClaimSpecSelectorMatchExpressions propriedades
| Name | Tipo | Descrição |
|---|---|---|
| key |
string |
key é a chave de rótulo à qual o seletor se aplica. |
| operator |
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[] |
values é uma matriz de valores de cadeia de caracteres. Se o operador for In ou NotIn, a matriz de valores deve estar não 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. |