Sdílet prostřednictvím


Broker - Create Or Update

Vytvoření BrokerResource

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}?api-version=2025-04-01

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
brokerName
path True

string

minLength: 3
maxLength: 63
pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$

Název zprostředkovatele.

instanceName
path True

string

minLength: 3
maxLength: 63
pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$

Název instance.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

subscriptionId
path True

string (uuid)

ID cílového předplatného. Hodnota musí být UUID.

api-version
query True

string

minLength: 1

Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name Vyžadováno Typ Description
extendedLocation True

ExtendedLocation

Hraniční umístění prostředku.

properties

BrokerProperties

Vlastnosti specifické pro prostředek pro tento prostředek.

Odpovědi

Name Typ Description
200 OK

BrokerResource

Operace aktualizace BrokerResource prostředku proběhla úspěšně.

201 Created

BrokerResource

Operace vytvoření zprostředkovatele BrokerResource proběhla úspěšně.

Hlavičky

  • Azure-AsyncOperation: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

Broker_CreateOrUpdate
Broker_CreateOrUpdate_Complex
Broker_CreateOrUpdate_Minimal
Broker_CreateOrUpdate_Simple

Broker_CreateOrUpdate

Ukázkový požadavek

PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2025-04-01

{
  "properties": {
    "advanced": {
      "clients": {
        "maxSessionExpirySeconds": 3859,
        "maxMessageExpirySeconds": 3263,
        "maxPacketSizeBytes": 3029,
        "subscriberQueueLimit": {
          "length": 6,
          "strategy": "None"
        },
        "maxReceiveMaximum": 2365,
        "maxKeepAliveSeconds": 3744
      },
      "encryptInternalTraffic": "Enabled",
      "internalCerts": {
        "duration": "bchrc",
        "renewBefore": "xkafmpgjfifkwwrhkswtopdnne",
        "privateKey": {
          "algorithm": "Ec256",
          "rotationPolicy": "Always"
        }
      }
    },
    "cardinality": {
      "backendChain": {
        "partitions": 11,
        "redundancyFactor": 5,
        "workers": 15
      },
      "frontend": {
        "replicas": 2,
        "workers": 6
      }
    },
    "diagnostics": {
      "logs": {
        "level": "rnmwokumdmebpmfxxxzvvjfdywotav"
      },
      "metrics": {
        "prometheusPort": 7581
      },
      "selfCheck": {
        "mode": "Enabled",
        "intervalSeconds": 158,
        "timeoutSeconds": 14
      },
      "traces": {
        "mode": "Enabled",
        "cacheSizeMegabytes": 28,
        "selfTracing": {
          "mode": "Enabled",
          "intervalSeconds": 22
        },
        "spanChannelCapacity": 1000
      }
    },
    "diskBackedMessageBuffer": {
      "maxSize": "500M",
      "ephemeralVolumeClaimSpec": {
        "volumeName": "c",
        "volumeMode": "rxvpksjuuugqnqzeiprocknbn",
        "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
        "accessModes": [
          "nuluhigrbb"
        ],
        "dataSource": {
          "apiGroup": "npqapyksvvpkohujx",
          "kind": "wazgyb",
          "name": "cwhsgxxcxsyppoefm"
        },
        "dataSourceRef": {
          "apiGroup": "mnfnykznjjsoqpfsgdqioupt",
          "kind": "odynqzekfzsnawrctaxg",
          "name": "envszivbbmixbyddzg",
          "namespace": "etcfzvxqd"
        },
        "resources": {
          "limits": {
            "key2719": "hmphcrgctu"
          },
          "requests": {
            "key2909": "txocprnyrsgvhfrg"
          }
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "e",
              "operator": "In",
              "values": [
                "slmpajlywqvuyknipgztsonqyybt"
              ]
            }
          ],
          "matchLabels": {
            "key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
          }
        }
      },
      "persistentVolumeClaimSpec": {
        "volumeName": "c",
        "volumeMode": "rxvpksjuuugqnqzeiprocknbn",
        "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
        "accessModes": [
          "nuluhigrbb"
        ],
        "dataSource": {
          "apiGroup": "npqapyksvvpkohujx",
          "kind": "wazgyb",
          "name": "cwhsgxxcxsyppoefm"
        },
        "dataSourceRef": {
          "apiGroup": "mnfnykznjjsoqpfsgdqioupt",
          "kind": "odynqzekfzsnawrctaxg",
          "name": "envszivbbmixbyddzg",
          "namespace": "etcfzvxqd"
        },
        "resources": {
          "limits": {
            "key2719": "hmphcrgctu"
          },
          "requests": {
            "key2909": "txocprnyrsgvhfrg"
          }
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "e",
              "operator": "In",
              "values": [
                "slmpajlywqvuyknipgztsonqyybt"
              ]
            }
          ],
          "matchLabels": {
            "key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
          }
        }
      }
    },
    "generateResourceLimits": {
      "cpu": "Enabled"
    },
    "memoryProfile": "Tiny"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  }
}

Ukázková odpověď

{
  "properties": {
    "advanced": {
      "clients": {
        "maxSessionExpirySeconds": 3859,
        "maxMessageExpirySeconds": 3263,
        "maxPacketSizeBytes": 3029,
        "subscriberQueueLimit": {
          "length": 6,
          "strategy": "None"
        },
        "maxReceiveMaximum": 2365,
        "maxKeepAliveSeconds": 3744
      },
      "encryptInternalTraffic": "Enabled",
      "internalCerts": {
        "duration": "bchrc",
        "renewBefore": "xkafmpgjfifkwwrhkswtopdnne",
        "privateKey": {
          "algorithm": "Ec256",
          "rotationPolicy": "Always"
        }
      }
    },
    "cardinality": {
      "backendChain": {
        "partitions": 11,
        "redundancyFactor": 5,
        "workers": 15
      },
      "frontend": {
        "replicas": 2,
        "workers": 6
      }
    },
    "diagnostics": {
      "logs": {
        "level": "rnmwokumdmebpmfxxxzvvjfdywotav"
      },
      "metrics": {
        "prometheusPort": 7581
      },
      "selfCheck": {
        "mode": "Enabled",
        "intervalSeconds": 158,
        "timeoutSeconds": 14
      },
      "traces": {
        "mode": "Enabled",
        "cacheSizeMegabytes": 28,
        "selfTracing": {
          "mode": "Enabled",
          "intervalSeconds": 22
        },
        "spanChannelCapacity": 1000
      }
    },
    "diskBackedMessageBuffer": {
      "maxSize": "500M",
      "ephemeralVolumeClaimSpec": {
        "volumeName": "c",
        "volumeMode": "rxvpksjuuugqnqzeiprocknbn",
        "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
        "accessModes": [
          "nuluhigrbb"
        ],
        "dataSource": {
          "apiGroup": "npqapyksvvpkohujx",
          "kind": "wazgyb",
          "name": "cwhsgxxcxsyppoefm"
        },
        "dataSourceRef": {
          "apiGroup": "mnfnykznjjsoqpfsgdqioupt",
          "kind": "odynqzekfzsnawrctaxg",
          "name": "envszivbbmixbyddzg",
          "namespace": "etcfzvxqd"
        },
        "resources": {
          "limits": {
            "key2719": "hmphcrgctu"
          },
          "requests": {
            "key2909": "txocprnyrsgvhfrg"
          }
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "e",
              "operator": "In",
              "values": [
                "slmpajlywqvuyknipgztsonqyybt"
              ]
            }
          ],
          "matchLabels": {
            "key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
          }
        }
      },
      "persistentVolumeClaimSpec": {
        "volumeName": "c",
        "volumeMode": "rxvpksjuuugqnqzeiprocknbn",
        "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
        "accessModes": [
          "nuluhigrbb"
        ],
        "dataSource": {
          "apiGroup": "npqapyksvvpkohujx",
          "kind": "wazgyb",
          "name": "cwhsgxxcxsyppoefm"
        },
        "dataSourceRef": {
          "apiGroup": "mnfnykznjjsoqpfsgdqioupt",
          "kind": "odynqzekfzsnawrctaxg",
          "name": "envszivbbmixbyddzg",
          "namespace": "etcfzvxqd"
        },
        "resources": {
          "limits": {
            "key2719": "hmphcrgctu"
          },
          "requests": {
            "key2909": "txocprnyrsgvhfrg"
          }
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "e",
              "operator": "In",
              "values": [
                "slmpajlywqvuyknipgztsonqyybt"
              ]
            }
          ],
          "matchLabels": {
            "key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
          }
        }
      }
    },
    "generateResourceLimits": {
      "cpu": "Enabled"
    },
    "memoryProfile": "Tiny",
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "dowrkel",
  "type": "xshjnsdgadygb",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "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": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "dowrkel",
  "type": "xshjnsdgadygb",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

Broker_CreateOrUpdate_Complex

Ukázkový požadavek

PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2025-04-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": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  }
}

Ukázková odpověď

{
  "properties": {
    "cardinality": {
      "backendChain": {
        "partitions": 2,
        "redundancyFactor": 2,
        "workers": 2
      },
      "frontend": {
        "replicas": 2,
        "workers": 2
      }
    },
    "diskBackedMessageBuffer": {
      "maxSize": "50M"
    },
    "generateResourceLimits": {
      "cpu": "Enabled"
    },
    "memoryProfile": "Medium",
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "llptmlifnqqwairx",
  "type": "qwrfzxjfxvismlqvigot",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "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": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "llptmlifnqqwairx",
  "type": "qwrfzxjfxvismlqvigot",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

Broker_CreateOrUpdate_Minimal

Ukázkový požadavek

PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2025-04-01

{
  "properties": {
    "memoryProfile": "Tiny"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  }
}

Ukázková odpověď

{
  "properties": {
    "advanced": {
      "clients": {
        "maxSessionExpirySeconds": 3859,
        "maxMessageExpirySeconds": 3263,
        "maxPacketSizeBytes": 3029,
        "subscriberQueueLimit": {
          "length": 6,
          "strategy": "None"
        },
        "maxReceiveMaximum": 2365,
        "maxKeepAliveSeconds": 3744
      },
      "encryptInternalTraffic": "Enabled",
      "internalCerts": {
        "duration": "bchrc",
        "renewBefore": "xkafmpgjfifkwwrhkswtopdnne",
        "privateKey": {
          "algorithm": "Ec256",
          "rotationPolicy": "Always"
        }
      }
    },
    "cardinality": {
      "backendChain": {
        "partitions": 11,
        "redundancyFactor": 5,
        "workers": 15
      },
      "frontend": {
        "replicas": 2,
        "workers": 6
      }
    },
    "diagnostics": {
      "logs": {
        "level": "rnmwokumdmebpmfxxxzvvjfdywotav"
      },
      "metrics": {
        "prometheusPort": 7581
      },
      "selfCheck": {
        "mode": "Enabled",
        "intervalSeconds": 158,
        "timeoutSeconds": 14
      },
      "traces": {
        "mode": "Enabled",
        "cacheSizeMegabytes": 28,
        "selfTracing": {
          "mode": "Enabled",
          "intervalSeconds": 22
        },
        "spanChannelCapacity": 1000
      }
    },
    "diskBackedMessageBuffer": {
      "maxSize": "500M",
      "ephemeralVolumeClaimSpec": {
        "volumeName": "c",
        "volumeMode": "rxvpksjuuugqnqzeiprocknbn",
        "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
        "accessModes": [
          "nuluhigrbb"
        ],
        "dataSource": {
          "apiGroup": "npqapyksvvpkohujx",
          "kind": "wazgyb",
          "name": "cwhsgxxcxsyppoefm"
        },
        "dataSourceRef": {
          "apiGroup": "mnfnykznjjsoqpfsgdqioupt",
          "kind": "odynqzekfzsnawrctaxg",
          "name": "envszivbbmixbyddzg",
          "namespace": "etcfzvxqd"
        },
        "resources": {
          "limits": {
            "key2719": "hmphcrgctu"
          },
          "requests": {
            "key2909": "txocprnyrsgvhfrg"
          }
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "e",
              "operator": "In",
              "values": [
                "slmpajlywqvuyknipgztsonqyybt"
              ]
            }
          ],
          "matchLabels": {
            "key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
          }
        }
      },
      "persistentVolumeClaimSpec": {
        "volumeName": "c",
        "volumeMode": "rxvpksjuuugqnqzeiprocknbn",
        "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
        "accessModes": [
          "nuluhigrbb"
        ],
        "dataSource": {
          "apiGroup": "npqapyksvvpkohujx",
          "kind": "wazgyb",
          "name": "cwhsgxxcxsyppoefm"
        },
        "dataSourceRef": {
          "apiGroup": "mnfnykznjjsoqpfsgdqioupt",
          "kind": "odynqzekfzsnawrctaxg",
          "name": "envszivbbmixbyddzg",
          "namespace": "etcfzvxqd"
        },
        "resources": {
          "limits": {
            "key2719": "hmphcrgctu"
          },
          "requests": {
            "key2909": "txocprnyrsgvhfrg"
          }
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "e",
              "operator": "In",
              "values": [
                "slmpajlywqvuyknipgztsonqyybt"
              ]
            }
          ],
          "matchLabels": {
            "key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
          }
        }
      }
    },
    "generateResourceLimits": {
      "cpu": "Enabled"
    },
    "memoryProfile": "Tiny",
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "dowrkel",
  "type": "xshjnsdgadygb",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "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": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "dowrkel",
  "type": "xshjnsdgadygb",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

Broker_CreateOrUpdate_Simple

Ukázkový požadavek

PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123?api-version=2025-04-01

{
  "properties": {
    "cardinality": {
      "backendChain": {
        "partitions": 2,
        "redundancyFactor": 2,
        "workers": 2
      },
      "frontend": {
        "replicas": 2,
        "workers": 2
      }
    },
    "generateResourceLimits": {
      "cpu": "Enabled"
    },
    "memoryProfile": "Low"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  }
}

Ukázková odpověď

{
  "properties": {
    "advanced": {
      "clients": {
        "maxSessionExpirySeconds": 3859,
        "maxMessageExpirySeconds": 3263,
        "maxPacketSizeBytes": 3029,
        "subscriberQueueLimit": {
          "length": 6,
          "strategy": "None"
        },
        "maxReceiveMaximum": 2365,
        "maxKeepAliveSeconds": 3744
      },
      "encryptInternalTraffic": "Enabled",
      "internalCerts": {
        "duration": "bchrc",
        "renewBefore": "xkafmpgjfifkwwrhkswtopdnne",
        "privateKey": {
          "algorithm": "Ec256",
          "rotationPolicy": "Always"
        }
      }
    },
    "cardinality": {
      "backendChain": {
        "partitions": 11,
        "redundancyFactor": 5,
        "workers": 15
      },
      "frontend": {
        "replicas": 2,
        "workers": 6
      }
    },
    "diagnostics": {
      "logs": {
        "level": "rnmwokumdmebpmfxxxzvvjfdywotav"
      },
      "metrics": {
        "prometheusPort": 7581
      },
      "selfCheck": {
        "mode": "Enabled",
        "intervalSeconds": 158,
        "timeoutSeconds": 14
      },
      "traces": {
        "mode": "Enabled",
        "cacheSizeMegabytes": 28,
        "selfTracing": {
          "mode": "Enabled",
          "intervalSeconds": 22
        },
        "spanChannelCapacity": 1000
      }
    },
    "diskBackedMessageBuffer": {
      "maxSize": "500M",
      "ephemeralVolumeClaimSpec": {
        "volumeName": "c",
        "volumeMode": "rxvpksjuuugqnqzeiprocknbn",
        "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
        "accessModes": [
          "nuluhigrbb"
        ],
        "dataSource": {
          "apiGroup": "npqapyksvvpkohujx",
          "kind": "wazgyb",
          "name": "cwhsgxxcxsyppoefm"
        },
        "dataSourceRef": {
          "apiGroup": "mnfnykznjjsoqpfsgdqioupt",
          "kind": "odynqzekfzsnawrctaxg",
          "name": "envszivbbmixbyddzg",
          "namespace": "etcfzvxqd"
        },
        "resources": {
          "limits": {
            "key2719": "hmphcrgctu"
          },
          "requests": {
            "key2909": "txocprnyrsgvhfrg"
          }
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "e",
              "operator": "In",
              "values": [
                "slmpajlywqvuyknipgztsonqyybt"
              ]
            }
          ],
          "matchLabels": {
            "key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
          }
        }
      },
      "persistentVolumeClaimSpec": {
        "volumeName": "c",
        "volumeMode": "rxvpksjuuugqnqzeiprocknbn",
        "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon",
        "accessModes": [
          "nuluhigrbb"
        ],
        "dataSource": {
          "apiGroup": "npqapyksvvpkohujx",
          "kind": "wazgyb",
          "name": "cwhsgxxcxsyppoefm"
        },
        "dataSourceRef": {
          "apiGroup": "mnfnykznjjsoqpfsgdqioupt",
          "kind": "odynqzekfzsnawrctaxg",
          "name": "envszivbbmixbyddzg",
          "namespace": "etcfzvxqd"
        },
        "resources": {
          "limits": {
            "key2719": "hmphcrgctu"
          },
          "requests": {
            "key2909": "txocprnyrsgvhfrg"
          }
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "e",
              "operator": "In",
              "values": [
                "slmpajlywqvuyknipgztsonqyybt"
              ]
            }
          ],
          "matchLabels": {
            "key6673": "wlngfalznwxnurzpgxomcxhbqefpr"
          }
        }
      }
    },
    "generateResourceLimits": {
      "cpu": "Enabled"
    },
    "memoryProfile": "Tiny",
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "dowrkel",
  "type": "xshjnsdgadygb",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "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": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123",
  "name": "dowrkel",
  "type": "xshjnsdgadygb",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

Definice

Name Description
AdvancedSettings

Upřesnit nastavení zprostředkovatele

BackendChain

Požadované vlastnosti back-endových instancí zprostředkovatele

BrokerDiagnostics

Vlastnosti nastavení diagnostiky zprostředkovatele

BrokerMemoryProfile

Nastavení profilu paměti zprostředkovatele

BrokerProperties

Vlastnosti prostředku zprostředkovatele

BrokerResource

Prostředek zprostředkovatele instancí

Cardinality

Vlastnosti kardinality

CertManagerCertOptions

Vlastnosti certifikátu nástroje Cert Manager

CertManagerPrivateKey

Vlastnosti privátního klíče nástroje Cert Manager

ClientConfig

Nastavení konfigurace klienta.

createdByType

Typ identity, která prostředek vytvořila.

DiagnosticsLogs

Vlastnosti diagnostického protokolu

DiskBackedMessageBuffer

DiskBackedMessageBuffer – vlastnosti

ErrorAdditionalInfo

Další informace o chybě správy prostředků

ErrorDetail

Podrobnosti o chybě.

ErrorResponse

Chybová odpověď

ExtendedLocation

Rozšířené umístění je rozšířením umístění Azure. Poskytují způsob, jak používat clustery Kubernetes s podporou Azure ARC jako cílová umístění pro nasazení instancí služeb Azure.

ExtendedLocationType

Výčet definující typ ExtendedLocation akceptoval.

Frontend

Požadované vlastnosti front-endových instancí zprostředkovatele

GenerateResourceLimits

GenerateResourceLimits – vlastnosti

KubernetesReference

Referenční informace k Kubernetes

LocalKubernetesReference

Referenční informace k Kubernetes

Metrics

Vlastnosti diagnostických metrik

OperationalMode

Vlastnosti režimu

OperatorValues

Platné operátory jsou In, NotIn, Exists a DoesNotExist.

PrivateKeyAlgorithm

Typy algoritmů privátních klíčů.

PrivateKeyRotationPolicy

Zásady obměně privátních klíčů.

ProvisioningState

Výčet definující stav prostředku.

SelfCheck

Vlastnosti samoobslužné kontroly diagnostiky zprostředkovatele

SelfTracing

Diagnostické vlastnosti vlastního trasování

SubscriberMessageDropStrategy

Výčet definující strategie pro vyřazení zpráv z fronty odběratele.

SubscriberQueueLimit

Nastavení limitu fronty odběratele.

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Traces

Vlastnosti trasování diagnostiky zprostředkovatele

VolumeClaimResourceRequirements

VolumeClaimResourceRequirements – vlastnosti

VolumeClaimSpec

VolumeClaimSpec – vlastnosti

VolumeClaimSpecSelector

VolumeClaimSpecSelector – vlastnosti

VolumeClaimSpecSelectorMatchExpressions

VolumeClaimSpecSelectorMatchExpressions – vlastnosti

AdvancedSettings

Upřesnit nastavení zprostředkovatele

Name Typ Default value Description
clients

ClientConfig

Konfigurace související se všemi klienty

encryptInternalTraffic

OperationalMode

Enabled

Nastavení pro povolení nebo zakázání šifrování interního provozu.

internalCerts

CertManagerCertOptions

Obměně certifikátů a konfigurace privátního klíče

BackendChain

Požadované vlastnosti back-endových instancí zprostředkovatele

Name Typ Default value Description
partitions

integer (int32)

minimum: 1
maximum: 16

Požadovaný počet fyzických back-endových oddílů.

redundancyFactor

integer (int32)

minimum: 1
maximum: 5

Požadovaný počet back-endových replik (podů) ve fyzickém oddílu.

workers

integer (int32)

minimum: 1
maximum: 16
1

Počet logických back-endových pracovních procesů na repliku (pod).

BrokerDiagnostics

Vlastnosti nastavení diagnostiky zprostředkovatele

Name Typ Description
logs

DiagnosticsLogs

Nastavení diagnostického protokolu pro prostředek

metrics

Metrics

Nastavení metrik pro prostředek.

selfCheck

SelfCheck

Vlastnosti kontroly sebe sama.

traces

Traces

Vlastnosti trasování.

BrokerMemoryProfile

Nastavení profilu paměti zprostředkovatele

Hodnota Description
High

Profil vysoké paměti.

Low

Profil nedostatku paměti.

Medium

Profil střední paměti.

Tiny

Malý profil paměti.

BrokerProperties

Vlastnosti prostředku zprostředkovatele

Name Typ Default value Description
advanced

AdvancedSettings

Upřesňující nastavení zprostředkovatele.

cardinality

Cardinality

Podrobnosti kardinality zprostředkovatele.

diagnostics

BrokerDiagnostics

Specifikace definuje požadované identity nastavení diagnostiky zprostředkovatele.

diskBackedMessageBuffer

DiskBackedMessageBuffer

Nastavení vyrovnávací paměti zpráv na disku.

generateResourceLimits

GenerateResourceLimits

Toto nastavení určuje, jestli jsou požadovány limity prostředků procesoru Kubernetes. Zvýšení počtu replik nebo pracovních procesů úměrně zvyšuje množství požadovaných prostředků procesoru. Pokud je toto nastavení povolené a není k dispozici dostatek prostředků procesoru, vygeneruje se chyba.

memoryProfile

BrokerMemoryProfile

Medium

Profil paměti zprostředkovatele.

provisioningState

ProvisioningState

Stav poslední operace.

BrokerResource

Prostředek zprostředkovatele instancí

Name Typ Description
extendedLocation

ExtendedLocation

Hraniční umístění prostředku.

id

string (arm-id)

Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

Název prostředku

properties

BrokerProperties

Vlastnosti specifické pro prostředek pro tento prostředek.

systemData

systemData

Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

Cardinality

Vlastnosti kardinality

Name Typ Description
backendChain

BackendChain

Požadované vlastnosti zprostředkovatele back-endu

frontend

Frontend

Požadované vlastnosti front-endu

CertManagerCertOptions

Vlastnosti certifikátu nástroje Cert Manager

Name Typ Description
duration

string

Životnost certifikátu. Je nutné zadat pomocí času Go. Formát doby trvání (h|m|s). Např. 240h po dobu 240 hodin a 45 min. po dobu 45 minut.

privateKey

CertManagerPrivateKey

Konfigurace privátního klíče certifikátu

renewBefore

string

Kdy začít obnovovat certifikát. Je nutné zadat pomocí času Go. Formát doby trvání (h|m|s). Např. 240h po dobu 240 hodin a 45 min. po dobu 45 minut.

CertManagerPrivateKey

Vlastnosti privátního klíče nástroje Cert Manager

Name Typ Description
algorithm

PrivateKeyAlgorithm

algoritmus pro privátní klíč.

rotationPolicy

PrivateKeyRotationPolicy

cert-manager private key rotationPolicy.

ClientConfig

Nastavení konfigurace klienta.

Name Typ Description
maxKeepAliveSeconds

integer (int32)

minimum: 0
maximum: 65535

Horní mez udržování klienta v sekundách.

maxMessageExpirySeconds

integer (int32)

minimum: 1
maximum: 4294967295

Horní mez intervalu vypršení platnosti zprávy v sekundách.

maxPacketSizeBytes

integer (int32)

minimum: 1
maximum: 268435456

Maximální velikost zprávy pro paket v bajtech

maxReceiveMaximum

integer (int32)

minimum: 1
maximum: 65535

Horní mez maximálního příjmu, kterou klient může požadovat v paketu CONNECT.

maxSessionExpirySeconds

integer (int32)

minimum: 1
maximum: 4294967295

Horní mez intervalu vypršení platnosti relace v sekundách.

subscriberQueueLimit

SubscriberQueueLimit

Omezení počtu zpráv zařazených do fronty pro odběratele.

createdByType

Typ identity, která prostředek vytvořila.

Hodnota Description
Application
Key
ManagedIdentity
User

DiagnosticsLogs

Vlastnosti diagnostického protokolu

Name Typ Default value Description
level

string

info

Úroveň protokolu. Příklady – debug, info, warn, error, trace.

DiskBackedMessageBuffer

DiskBackedMessageBuffer – vlastnosti

Name Typ Description
ephemeralVolumeClaimSpec

VolumeClaimSpec

K připojení obecného dočasného svazku pro vyrovnávací paměť zprávy použijte zadanou šablonu deklarace trvalého svazku. Podrobnosti najdete v https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes.

maxSize

string

pattern: ^[0-9]+[KMGTPE]$

Maximální velikost vyrovnávací paměti zprávy na disku. Pokud je šablona PVC zadaná pomocí některé z dočasnýchvolumeralVolumeClaimSpec nebo persistentVolumeClaimSpec, použije se tato velikost jako požadavek a omezení velikosti této šablony. Pokud není zadán žádný dočasnýVolumemeClaimSpec ani persistentVolumeClaimSpec, pak je prázdný svazekDir připojen s touto velikostí jako jeho limit. Podrobnosti najdete v https://kubernetes.io/docs/concepts/storage/volumes/#emptydir.

persistentVolumeClaimSpec

VolumeClaimSpec

K připojení trvalého svazku pro vyrovnávací paměť zprávy použijte zadanou šablonu deklarace identity trvalého svazku.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.

type

string

Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.

code

string

Kód chyby.

details

ErrorDetail[]

Podrobnosti o chybě.

message

string

Chybová zpráva.

target

string

Cíl chyby.

ErrorResponse

Chybová odpověď

Name Typ Description
error

ErrorDetail

Objekt chyby.

ExtendedLocation

Rozšířené umístění je rozšířením umístění Azure. Poskytují způsob, jak používat clustery Kubernetes s podporou Azure ARC jako cílová umístění pro nasazení instancí služeb Azure.

Name Typ Description
name

string

Název rozšířeného umístění.

type

ExtendedLocationType

Typ ExtendedLocation.

ExtendedLocationType

Výčet definující typ ExtendedLocation akceptoval.

Hodnota Description
CustomLocation

Typ CustomLocation

Frontend

Požadované vlastnosti front-endových instancí zprostředkovatele

Name Typ Default value Description
replicas

integer (int32)

minimum: 1
maximum: 16

Požadovaný počet instancí front-endu (podů).

workers

integer (int32)

minimum: 1
maximum: 16
2

Počet logických front-endových pracovních procesů na instanci (pod).

GenerateResourceLimits

GenerateResourceLimits – vlastnosti

Name Typ Default value Description
cpu

OperationalMode

Enabled

Přepínač pro povolení nebo zakázání limitů prostředků procesoru.

KubernetesReference

Referenční informace k Kubernetes

Name Typ Description
apiGroup

string

SKUPINA APIGroup je skupina pro odkazovaný prostředek. Pokud není zadána skupina APIGroup, musí být zadaný druh v základní skupině rozhraní API. Pro všechny ostatní typy třetích stran se vyžaduje skupina APIGroup.

kind

string

Druh je typ odkazovaného prostředku.

name

string

Název je název odkazovaného prostředku.

namespace

string

Obor názvů je obor názvů odkazovaného prostředku. Toto pole je povinné, pokud má prostředek obor názvů.

LocalKubernetesReference

Referenční informace k Kubernetes

Name Typ Description
apiGroup

string

SKUPINA APIGroup je skupina pro odkazovaný prostředek. Pokud není zadána skupina APIGroup, musí být zadaný druh v základní skupině rozhraní API. Pro všechny ostatní typy třetích stran se vyžaduje skupina APIGroup.

kind

string

Druh je typ odkazovaného prostředku.

name

string

Název je název odkazovaného prostředku.

Metrics

Vlastnosti diagnostických metrik

Name Typ Default value Description
prometheusPort

integer (int32)

minimum: 0
maximum: 65535
9600

Port prometheus pro zveřejnění metrik.

OperationalMode

Vlastnosti režimu

Hodnota Description
Disabled

Zakázáno je ekvivalentní false.

Enabled

Povoleno je ekvivalentní hodnotě True.

OperatorValues

Platné operátory jsou In, NotIn, Exists a DoesNotExist.

Hodnota Description
DoesNotExist

DoesNotExist – operátor.

Exists

Existuje operátor.

In

Operátor In.

NotIn

Operátor NotIn.

PrivateKeyAlgorithm

Typy algoritmů privátních klíčů.

Hodnota Description
Ec256

Algoritmus - ec256.

Ec384

Algoritmus - ec384.

Ec521

Algoritmus - ec521.

Ed25519

Algoritmus - ed25519.

Rsa2048

Algoritmus - rsa2048.

Rsa4096

Algoritmus - rsa4096.

Rsa8192

Algoritmus - rsa8192.

PrivateKeyRotationPolicy

Zásady obměně privátních klíčů.

Hodnota Description
Always

Zásady rotace – vždy.

Never

Zásady rotace – nikdy.

ProvisioningState

Výčet definující stav prostředku.

Hodnota Description
Accepted

Zdroj byl přijat.

Canceled

Vytvoření prostředku bylo zrušeno.

Deleting

Prostředek se odstraňuje.

Failed

Vytvoření prostředku se nezdařilo.

Provisioning

Prostředek se zřizuje.

Succeeded

Prostředek byl vytvořen.

Updating

Prostředek se aktualizuje.

SelfCheck

Vlastnosti samoobslužné kontroly diagnostiky zprostředkovatele

Name Typ Default value Description
intervalSeconds

integer (int32)

minimum: 30
maximum: 300
30

Interval kontroly sebe sama.

mode

OperationalMode

Enabled

Přepínač pro povolení nebo zakázání samoobslužné kontroly.

timeoutSeconds

integer (int32)

minimum: 5
maximum: 120
15

Časový limit pro vlastní kontrolu.

SelfTracing

Diagnostické vlastnosti vlastního trasování

Name Typ Default value Description
intervalSeconds

integer (int32)

minimum: 1
maximum: 300
30

Interval vlastního trasování.

mode

OperationalMode

Enabled

Přepínač pro povolení nebo zakázání vlastního trasování.

SubscriberMessageDropStrategy

Výčet definující strategie pro vyřazení zpráv z fronty odběratele.

Hodnota Description
DropOldest

Nejstarší zpráva se zahodí.

None

Zprávy se nikdy nezahodí.

SubscriberQueueLimit

Nastavení limitu fronty odběratele.

Name Typ Default value Description
length

integer (int64)

minimum: 1

Maximální délka fronty před zahájením vyřazení zpráv.

strategy

SubscriberMessageDropStrategy

None

Strategie, která se má použít pro vyřazení zpráv z fronty

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name Typ Description
createdAt

string (date-time)

Časové razítko vytvoření prostředku (UTC).

createdBy

string

Identita, která prostředek vytvořila.

createdByType

createdByType

Typ identity, která prostředek vytvořila.

lastModifiedAt

string (date-time)

Časové razítko poslední změny zdroje (UTC)

lastModifiedBy

string

Identita, která naposledy změnila prostředek.

lastModifiedByType

createdByType

Typ identity, která naposledy změnila prostředek.

Traces

Vlastnosti trasování diagnostiky zprostředkovatele

Name Typ Default value Description
cacheSizeMegabytes

integer (int32)

minimum: 1
maximum: 128
16

Velikost mezipaměti v megabajtech.

mode

OperationalMode

Enabled

Přepínač pro povolení nebo zakázání trasování.

selfTracing

SelfTracing

Vlastnosti vlastního trasování.

spanChannelCapacity

integer (int32)

minimum: 1000
maximum: 100000
1000

Kapacita kanálu span.

VolumeClaimResourceRequirements

VolumeClaimResourceRequirements – vlastnosti

Name Typ Description
limits

object

Omezení popisují maximální povolený počet výpočetních prostředků. Další informace: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

object

Požadavky popisují minimální požadovaný objem výpočetních prostředků. Pokud pro kontejner vynecháte požadavky, ve výchozím nastavení se nastaví omezení, pokud je explicitně zadáno, jinak na hodnotu definovanou implementací. Další informace: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

VolumeClaimSpec

VolumeClaimSpec – vlastnosti

Name Typ Description
accessModes

string[]

AccessModes obsahuje požadované režimy přístupu, které má mít svazek. Další informace: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

dataSource

LocalKubernetesReference

Toto pole lze použít k určení: * Existující objekt VolumeSnapshot (snapshot.storage.k8s.io/VolumeSnapshot) * Existující PVC (PersistentVolumeClaim) Pokud zřizovací nebo externí kontroler může podporovat zadaný zdroj dat, vytvoří nový svazek na základě obsahu zadaného zdroje dat. Pokud je povolená brána funkce AnyVolumeDataSource, bude mít toto pole vždy stejný obsah jako pole DataSourceRef.

dataSourceRef

KubernetesReference

Určuje objekt, ze kterého se má svazek naplnit daty, pokud je vyžadován neprázdný svazek. Může se jednat o jakýkoli místní objekt z neprázdné skupiny rozhraní API (nejádrový objekt) nebo objektu PersistentVolumeClaim. Pokud je toto pole zadáno, vazba svazku bude úspěšná pouze v případě, že typ zadaného objektu odpovídá některému nainstalovanému překupovači svazku nebo dynamickému zřizování. Toto pole nahradí funkčnost pole Zdroj dat a pokud jsou obě pole neprázdná, musí mít stejnou hodnotu. Pro zpětnou kompatibilitu se obě pole (DataSource a DataSourceRef) nastaví na stejnou hodnotu automaticky, pokud je jedna z nich prázdná a druhá je neprázdná. Existují dva důležité rozdíly mezi DataSource a DataSourceRef: * Zatímco DataSource umožňuje pouze dva konkrétní typy objektů, DataSourceRef umožňuje jakýkoli jiný než základní objekt, stejně jako PersistentVolumeClaim objekty. * Zatímco DataSource ignoruje nepovolené hodnoty (vyřazuje je), DataSourceRef zachová všechny hodnoty a vygeneruje chybu, pokud je zadána nepovolené hodnoty. (Beta verze) Použití tohoto pole vyžaduje povolení brány funkcí AnyVolumeDataSource.

resources

VolumeClaimResourceRequirements

Prostředky představují minimální prostředky, které má svazek mít. Pokud je povolená funkce RecoverVolumeExpansionFailure, můžou uživatelé zadat požadavky na prostředky, které jsou nižší než předchozí hodnota, ale musí být stále vyšší než kapacita zaznamenaná v poli stavu deklarace identity. Další informace: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

selector

VolumeClaimSpecSelector

Dotaz popisku nad svazky, který je potřeba zvážit pro vazbu.

storageClassName

string

Název třídy StorageClass vyžadované deklarací identity Další informace: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

volumeMode

string

volumeMode definuje, jaký typ svazku vyžaduje deklarace identity. Hodnota systému souborů je implicitní, pokud není zahrnuta ve specifikaci deklarace identity. Toto je beta funkce.

volumeName

string

VolumeName je odkaz na vazbu na PersistentVolume, který tuto deklaraci identity zálohuje.

VolumeClaimSpecSelector

VolumeClaimSpecSelector – vlastnosti

Name Typ Description
matchExpressions

VolumeClaimSpecSelectorMatchExpressions[]

MatchExpressions je seznam požadavků selektoru popisků. Požadavky jsou ANDed.

matchLabels

object

MatchLabels je mapa párů {key,value}. Jeden {klíč,value} v mapě matchLabels je ekvivalentní elementu matchExpressions, jehož pole klíče je "klíč", operátor je "In" a pole hodnot obsahuje pouze "value". Požadavky jsou ANDed.

VolumeClaimSpecSelectorMatchExpressions

VolumeClaimSpecSelectorMatchExpressions – vlastnosti

Name Typ Description
key

string

key je klávesa popisku, na kterou selektor vztahuje.

operator

OperatorValues

operátor představuje vztah klíče k sadě hodnot. Platné operátory jsou In, NotIn, Exists a DoesNotExist.

values

string[]

hodnoty jsou pole řetězcových hodnot. Pokud je operátor In nebo NotIn, musí být pole hodnot neprázdné. Pokud je operátor Exists nebo DoesNotExist, musí být pole hodnot prázdné. Toto pole se nahradí během strategické opravy sloučení.