Broker Listener - Create Or Update
Skapa en BrokerListenerResource
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/listeners/{listenerName}?api-version=2025-04-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
broker
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$ |
Namnet på asynkron meddelandekö. |
instance
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$ |
Namnet på instansen. |
listener
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$ |
Namn på lyssningsresurs för instanskoordinator |
resource
|
path | True |
string minLength: 1maxLength: 90 |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
subscription
|
path | True |
string (uuid) |
ID för målprenumerationen. Värdet måste vara ett UUID. |
api-version
|
query | True |
string minLength: 1 |
DEN API-version som ska användas för den här åtgärden. |
Begärandetext
Name | Obligatorisk | Typ | Description |
---|---|---|---|
extendedLocation | True |
Resursens gränsplats. |
|
properties |
Resursspecifika egenskaper för den här resursen. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Resursen "BrokerListenerResource"-uppdateringsåtgärden lyckades |
|
201 Created |
Resursen BrokerListenerResource-skapandeåtgärden lyckades Sidhuvuden
|
|
Other Status Codes |
Ett oväntat felsvar. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
Broker |
Broker |
Broker |
BrokerListener_CreateOrUpdate
Exempelbegäran
PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123?api-version=2025-04-01
{
"properties": {
"serviceName": "tpfiszlapdpxktx",
"ports": [
{
"authenticationRef": "tjvdroaqqy",
"authorizationRef": "inxhvxnwswyrvt",
"nodePort": 7281,
"port": 1268,
"protocol": "Mqtt",
"tls": {
"mode": "Automatic",
"certManagerCertificateSpec": {
"duration": "qmpeffoksron",
"secretName": "oagi",
"renewBefore": "hutno",
"issuerRef": {
"group": "jtmuladdkpasfpoyvewekmiy",
"kind": "Issuer",
"name": "ocwoqpgucvjrsuudtjhb"
},
"privateKey": {
"algorithm": "Ec256",
"rotationPolicy": "Always"
},
"san": {
"dns": [
"xhvmhrrhgfsapocjeebqtnzarlj"
],
"ip": [
"zbgugfzcgsmegevzktsnibyuyp"
]
}
},
"manual": {
"secretRef": "secret-name"
}
}
}
],
"serviceType": "ClusterIp"
},
"extendedLocation": {
"name": "qmbrfwcpwwhggszhrdjv",
"type": "CustomLocation"
}
}
Exempelsvar
{
"properties": {
"serviceName": "tpfiszlapdpxktx",
"ports": [
{
"authenticationRef": "tjvdroaqqy",
"authorizationRef": "inxhvxnwswyrvt",
"nodePort": 7281,
"port": 1268,
"protocol": "Mqtt",
"tls": {
"mode": "Automatic",
"certManagerCertificateSpec": {
"duration": "qmpeffoksron",
"secretName": "oagi",
"renewBefore": "hutno",
"issuerRef": {
"group": "jtmuladdkpasfpoyvewekmiy",
"kind": "Issuer",
"name": "ocwoqpgucvjrsuudtjhb"
},
"privateKey": {
"algorithm": "Ec256",
"rotationPolicy": "Always"
},
"san": {
"dns": [
"xhvmhrrhgfsapocjeebqtnzarlj"
],
"ip": [
"zbgugfzcgsmegevzktsnibyuyp"
]
}
},
"manual": {
"secretRef": "secret-name"
}
}
}
],
"serviceType": "ClusterIp",
"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/listeners/resource-name123",
"name": "hoqjaachratt",
"type": "hizbknwegcdaeh",
"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": {
"serviceName": "tpfiszlapdpxktx",
"ports": [
{
"authenticationRef": "tjvdroaqqy",
"authorizationRef": "inxhvxnwswyrvt",
"nodePort": 7281,
"port": 1268,
"protocol": "Mqtt",
"tls": {
"mode": "Automatic",
"certManagerCertificateSpec": {
"duration": "qmpeffoksron",
"secretName": "oagi",
"renewBefore": "hutno",
"issuerRef": {
"group": "jtmuladdkpasfpoyvewekmiy",
"kind": "Issuer",
"name": "ocwoqpgucvjrsuudtjhb"
},
"privateKey": {
"algorithm": "Ec256",
"rotationPolicy": "Always"
},
"san": {
"dns": [
"xhvmhrrhgfsapocjeebqtnzarlj"
],
"ip": [
"zbgugfzcgsmegevzktsnibyuyp"
]
}
},
"manual": {
"secretRef": "secret-name"
}
}
}
],
"serviceType": "ClusterIp",
"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/listeners/resource-name123",
"name": "hoqjaachratt",
"type": "hizbknwegcdaeh",
"systemData": {
"createdBy": "ssvaslsmudloholronopqyxjcu",
"createdByType": "User",
"createdAt": "2024-08-09T18:13:29.389Z",
"lastModifiedBy": "gnicpuszwd",
"lastModifiedByType": "User",
"lastModifiedAt": "2024-08-09T18:13:29.389Z"
}
}
BrokerListener_CreateOrUpdate_Complex
Exempelbegäran
PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123?api-version=2025-04-01
{
"properties": {
"serviceType": "LoadBalancer",
"ports": [
{
"port": 8080,
"authenticationRef": "example-authentication",
"protocol": "WebSockets"
},
{
"port": 8443,
"authenticationRef": "example-authentication",
"protocol": "WebSockets",
"tls": {
"mode": "Automatic",
"certManagerCertificateSpec": {
"issuerRef": {
"group": "jtmuladdkpasfpoyvewekmiy",
"name": "example-issuer",
"kind": "Issuer"
}
}
}
},
{
"port": 1883,
"authenticationRef": "example-authentication"
},
{
"port": 8883,
"authenticationRef": "example-authentication",
"tls": {
"mode": "Manual",
"manual": {
"secretRef": "example-secret"
}
}
}
]
},
"extendedLocation": {
"name": "qmbrfwcpwwhggszhrdjv",
"type": "CustomLocation"
}
}
Exempelsvar
{
"properties": {
"serviceName": "tpfiszlapdpxktx",
"serviceType": "LoadBalancer",
"ports": [
{
"port": 8080,
"authenticationRef": "example-authentication",
"protocol": "WebSockets"
},
{
"port": 8443,
"authenticationRef": "example-authentication",
"protocol": "WebSockets",
"tls": {
"mode": "Automatic",
"certManagerCertificateSpec": {
"issuerRef": {
"group": "jtmuladdkpasfpoyvewekmiy",
"name": "example-issuer",
"kind": "Issuer"
}
}
}
},
{
"port": 1883,
"authenticationRef": "example-authentication"
},
{
"port": 8883,
"authenticationRef": "example-authentication",
"tls": {
"mode": "Manual",
"manual": {
"secretRef": "example-secret"
}
}
}
],
"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/listeners/resource-name123",
"name": "hoqjaachratt",
"type": "hizbknwegcdaeh",
"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": {
"serviceName": "tpfiszlapdpxktx",
"serviceType": "LoadBalancer",
"ports": [
{
"port": 8080,
"authenticationRef": "example-authentication",
"protocol": "WebSockets"
},
{
"port": 8443,
"authenticationRef": "example-authentication",
"protocol": "WebSockets",
"tls": {
"mode": "Automatic",
"certManagerCertificateSpec": {
"issuerRef": {
"group": "jtmuladdkpasfpoyvewekmiy",
"name": "example-issuer",
"kind": "Issuer"
}
}
}
},
{
"port": 1883,
"authenticationRef": "example-authentication"
},
{
"port": 8883,
"authenticationRef": "example-authentication",
"tls": {
"mode": "Manual",
"manual": {
"secretRef": "example-secret"
}
}
}
],
"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/listeners/resource-name123",
"name": "hoqjaachratt",
"type": "hizbknwegcdaeh",
"systemData": {
"createdBy": "ssvaslsmudloholronopqyxjcu",
"createdByType": "User",
"createdAt": "2024-08-09T18:13:29.389Z",
"lastModifiedBy": "gnicpuszwd",
"lastModifiedByType": "User",
"lastModifiedAt": "2024-08-09T18:13:29.389Z"
}
}
BrokerListener_CreateOrUpdate_Simple
Exempelbegäran
PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123?api-version=2025-04-01
{
"properties": {
"ports": [
{
"port": 1883
}
]
},
"extendedLocation": {
"name": "qmbrfwcpwwhggszhrdjv",
"type": "CustomLocation"
}
}
Exempelsvar
{
"properties": {
"serviceName": "tpfiszlapdpxktx",
"serviceType": "LoadBalancer",
"ports": [
{
"port": 1883
}
],
"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/listeners/resource-name123",
"name": "hoqjaachratt",
"type": "hizbknwegcdaeh",
"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": {
"serviceName": "tpfiszlapdpxktx",
"serviceType": "LoadBalancer",
"ports": [
{
"port": 1883
}
],
"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/listeners/resource-name123",
"name": "hoqjaachratt",
"type": "hizbknwegcdaeh",
"systemData": {
"createdBy": "ssvaslsmudloholronopqyxjcu",
"createdByType": "User",
"createdAt": "2024-08-09T18:13:29.389Z",
"lastModifiedBy": "gnicpuszwd",
"lastModifiedByType": "User",
"lastModifiedAt": "2024-08-09T18:13:29.389Z"
}
}
Definitioner
Name | Description |
---|---|
Broker |
Definierar en koordinatorlyssnare. En lyssnare är en samling portar där koordinatorn accepterar anslutningar från klienter. |
Broker |
Instans broker-resurs |
Broker |
Typer av Broker Protocol |
Cert |
Automatisk hantering av TLS-servercertifikat med cert-manager |
Cert |
Egenskaper för CertManagerIssuerKind |
Cert |
Cert-Manager issuerRef-egenskaper |
Cert |
Egenskaper för privat nyckel i Cert Manager |
created |
Den typ av identitet som skapade resursen. |
Error |
Ytterligare information om resurshanteringsfelet. |
Error |
Felinformationen. |
Error |
Felsvar |
Extended |
Utökad plats är ett tillägg av Azure-platser. De tillhandahåller ett sätt att använda sina Azure ARC-aktiverade Kubernetes-kluster som målplatser för distribution av Azure-tjänstinstanser. |
Extended |
Den uppräkningsdefinieringstyp för ExtendedLocation som accepteras. |
Listener |
Definierar en TCP-port som en |
Private |
Algoritmtyper för privata nycklar. |
Private |
Roteringsprincip för privat nyckel. |
Provisioning |
Uppräkningen som definierar status för resursen. |
San |
Alternativt namn på certifikatmottagare (SAN) för certifikat. |
Service |
Kubernetes-tjänsttyper som stöds av lyssnaren |
system |
Metadata som rör skapande och senaste ändring av resursen. |
Tls |
Samling av olika TLS-typer, NOTE – Räkna upp i taget behöver bara en av dem stödjas |
Tls |
Autentiseringsläge för asynkron autentisering |
X509Manual |
Egenskaper för X509-certifikatautentisering. |
BrokerListenerProperties
Definierar en koordinatorlyssnare. En lyssnare är en samling portar där koordinatorn accepterar anslutningar från klienter.
Name | Typ | Standardvärde | Description |
---|---|---|---|
ports |
Portar där lyssnaren accepterar klientanslutningar. |
||
provisioningState |
Status för den senaste åtgärden. |
||
serviceName |
string |
Kubernetes-tjänstens namn på den här lyssnaren. |
|
serviceType | ClusterIp |
Kubernetes Service-typen för den här lyssnaren. |
BrokerListenerResource
Instans broker-resurs
Name | Typ | Description |
---|---|---|
extendedLocation |
Resursens gränsplats. |
|
id |
string (arm-id) |
Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name |
string |
Namnet på resursen |
properties |
Resursspecifika egenskaper för den här resursen. |
|
systemData |
Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information. |
|
type |
string |
Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" |
BrokerProtocolType
Typer av Broker Protocol
Värde | Description |
---|---|
Mqtt |
protocol broker |
WebSockets |
protokollwebbsocket |
CertManagerCertificateSpec
Automatisk hantering av TLS-servercertifikat med cert-manager
Name | Typ | Description |
---|---|---|
duration |
string |
Certifikatets livslängd. Måste anges med en Go-tid. Varaktighetsformat (h|m|s). T.ex. 240h i 240 timmar och 45m i 45 minuter. |
issuerRef |
cert-manager issuerRef. |
|
privateKey |
Typ av privat certifikatnyckel. |
|
renewBefore |
string |
När du ska börja förnya certifikatet. Måste anges med en Go-tid. Varaktighetsformat (h|m|s). T.ex. 240h i 240 timmar och 45m i 45 minuter. |
san |
Ytterligare alternativa ämnesnamn (SAN) som ska ingå i certifikatet. |
|
secretName |
string |
Hemlighet för lagring av servercertifikat. Alla befintliga data skrivs över. Det här är en referens till hemligheten via ett identifierande namn, inte själva hemligheten. |
CertManagerIssuerKind
Egenskaper för CertManagerIssuerKind
Värde | Description |
---|---|
ClusterIssuer |
ClusterIssuer-typ. |
Issuer |
Typ av utfärdare. |
CertManagerIssuerRef
Cert-Manager issuerRef-egenskaper
Name | Typ | Standardvärde | Description |
---|---|---|---|
group |
string |
cert-manager.io |
utfärdare. |
kind |
typ av utfärdare (utfärdare eller ClusterIssuer). |
||
name |
string |
utfärdarens namn. |
CertManagerPrivateKey
Egenskaper för privat nyckel i Cert Manager
Name | Typ | Description |
---|---|---|
algorithm |
algoritm för privat nyckel. |
|
rotationPolicy |
cert-manager private key rotationPolicy. |
createdByType
Den typ av identitet som skapade resursen.
Värde | Description |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
Name | Typ | Description |
---|---|---|
info |
object |
Ytterligare information. |
type |
string |
Ytterligare informationstyp. |
ErrorDetail
Felinformationen.
Name | Typ | Description |
---|---|---|
additionalInfo |
Ytterligare information om felet. |
|
code |
string |
Felkoden. |
details |
Felinformationen. |
|
message |
string |
Felmeddelandet. |
target |
string |
Felmålet. |
ErrorResponse
Felsvar
Name | Typ | Description |
---|---|---|
error |
Felobjektet. |
ExtendedLocation
Utökad plats är ett tillägg av Azure-platser. De tillhandahåller ett sätt att använda sina Azure ARC-aktiverade Kubernetes-kluster som målplatser för distribution av Azure-tjänstinstanser.
Name | Typ | Description |
---|---|---|
name |
string |
Namnet på den utökade platsen. |
type |
Typ av ExtendedLocation. |
ExtendedLocationType
Den uppräkningsdefinieringstyp för ExtendedLocation som accepteras.
Värde | Description |
---|---|
CustomLocation |
CustomLocation-typ |
ListenerPort
Definierar en TCP-port som en BrokerListener
lyssnar på.
Name | Typ | Standardvärde | Description |
---|---|---|---|
authenticationRef |
string |
Referens till klientautentiseringsinställningar. Utelämna för att inaktivera autentisering. |
|
authorizationRef |
string |
Referens till klientauktoriseringsinställningar. Utelämna för att inaktivera auktorisering. |
|
nodePort |
integer (int32) minimum: 0maximum: 65535 |
Kubernetes-nodport. Endast relevant när den här porten är associerad med en |
|
port |
integer (int32) minimum: 0maximum: 65535 |
TCP-port för att acceptera klientanslutningar. |
|
protocol | Mqtt |
Protokoll som ska användas för klientanslutningar. |
|
tls |
TLS-servercertifikatinställningar för den här porten. Utelämna för att inaktivera TLS. |
PrivateKeyAlgorithm
Algoritmtyper för privata nycklar.
Värde | Description |
---|---|
Ec256 |
Algoritm – ec256. |
Ec384 |
Algoritm – ec384. |
Ec521 |
Algoritm – ec521. |
Ed25519 |
Algoritm – ed25519. |
Rsa2048 |
Algoritm – rsa2048. |
Rsa4096 |
Algoritm – rsa4096. |
Rsa8192 |
Algoritm – rsa8192. |
PrivateKeyRotationPolicy
Roteringsprincip för privat nyckel.
Värde | Description |
---|---|
Always |
Rotationsprincip – Alltid. |
Never |
Rotationsprincip – Aldrig. |
ProvisioningState
Uppräkningen som definierar status för resursen.
Värde | Description |
---|---|
Accepted |
Resursen har accepterats. |
Canceled |
Resursskapandet avbröts. |
Deleting |
Resursen tas bort. |
Failed |
Det gick inte att skapa resurser. |
Provisioning |
Resursen etableras. |
Succeeded |
Resursen har skapats. |
Updating |
Resursen uppdateras. |
SanForCert
Alternativt namn på certifikatmottagare (SAN) för certifikat.
Name | Typ | Description |
---|---|---|
dns |
string[] |
DNS-SAN. |
ip |
string[] |
IP-adress-SAN. |
ServiceType
Kubernetes-tjänsttyper som stöds av lyssnaren
Värde | Description |
---|---|
ClusterIp |
Kluster-IP-tjänst. |
LoadBalancer |
Load Balancer Service. |
NodePort |
Nodporttjänst. |
systemData
Metadata som rör skapande och senaste ändring av resursen.
Name | Typ | Description |
---|---|---|
createdAt |
string (date-time) |
Tidsstämpeln för resursskapande (UTC). |
createdBy |
string |
Identiteten som skapade resursen. |
createdByType |
Den typ av identitet som skapade resursen. |
|
lastModifiedAt |
string (date-time) |
Tidsstämpeln för resursens senaste ändring (UTC) |
lastModifiedBy |
string |
Identiteten som senast ändrade resursen. |
lastModifiedByType |
Den typ av identitet som senast ändrade resursen. |
TlsCertMethod
Samling av olika TLS-typer, NOTE – Räkna upp i taget behöver bara en av dem stödjas
Name | Typ | Description |
---|---|---|
certManagerCertificateSpec |
Alternativ 1 – Automatisk hantering av TLS-servercertifikat med cert-manager. |
|
manual |
Alternativ 2 – Manuell hantering av TLS-servercertifikat via en definierad hemlighet. |
|
mode |
Läge för hantering av TLS-servercertifikat. |
TlsCertMethodMode
Autentiseringsläge för asynkron autentisering
Värde | Description |
---|---|
Automatic |
Automatisk konfiguration av TLS-servercertifikat. |
Manual |
Manuell konfiguration av TLS-servercertifikat. |
X509ManualCertificate
Egenskaper för X509-certifikatautentisering.
Name | Typ | Description |
---|---|---|
secretRef |
string |
Kubernetes-hemlighet som innehåller ett X.509-klientcertifikat. Det här är en referens till hemligheten via ett identifierande namn, inte själva hemligheten. |