Broker Listener - Create Or Update

Tjänst:: IoT Operations

API-version:: 2025-10-01

Skapa en BrokerListenerResource

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
brokerName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	Namnet på asynkron meddelandekö.
instanceName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	Namnet på instansen.
listenerName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	Namn på lyssningsresurs för instanskoordinator
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	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	Typ	Description
extendedLocation	ExtendedLocation	Resursens gränsplats.
properties	BrokerListenerProperties	Resursspecifika egenskaper för den här resursen.

Svar

Name	Typ	Description
200 OK	BrokerListenerResource	Uppdateringsåtgärden "BrokerListenerResource" för resursen lyckades
201 Created	BrokerListenerResource	Resursen "BrokerListenerResource" för att skapa åtgärden lyckades Sidhuvuden Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Name

Typ

Description

200 OK

BrokerListenerResource

Uppdateringsåtgärden "BrokerListenerResource" för resursen lyckades

201 Created

BrokerListenerResource

Resursen "BrokerListenerResource" för att skapa åtgärden lyckades

Sidhuvuden

Azure-AsyncOperation: string
Retry-After: integer

Other Status Codes

ErrorResponse

Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

BrokerListener_CreateOrUpdate

BrokerListener_CreateOrUpdate_Complex

BrokerListener_CreateOrUpdate_Simple

BrokerListener_CreateOrUpdate

Exempelbegäran

HTTP

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-10-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": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  }
}

Exempelsvar

Statuskod:: 200

{
  "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": "/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/listeners/resource-name123",
  "name": "hoqjaachratt",
  "type": "Microsoft.IoTOperations/instances/brokers/listeners",
  "systemData": {
    "createdBy": "contosouser",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "contosouser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

Statuskod:: 201

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": "/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/listeners/resource-name123",
  "name": "hoqjaachratt",
  "type": "Microsoft.IoTOperations/instances/brokers/listeners",
  "systemData": {
    "createdBy": "contosouser",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "contosouser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

BrokerListener_CreateOrUpdate_Complex

Exempelbegäran

HTTP

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-10-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": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  }
}

Exempelsvar

Statuskod:: 200

{
  "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": "/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/listeners/resource-name123",
  "name": "hoqjaachratt",
  "type": "Microsoft.IoTOperations/instances/brokers/listeners",
  "systemData": {
    "createdBy": "contosouser",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "contosouser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

Statuskod:: 201

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": "/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/listeners/resource-name123",
  "name": "hoqjaachratt",
  "type": "Microsoft.IoTOperations/instances/brokers/listeners",
  "systemData": {
    "createdBy": "contosouser",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "contosouser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

BrokerListener_CreateOrUpdate_Simple

Exempelbegäran

HTTP

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-10-01

{
  "properties": {
    "ports": [
      {
        "port": 1883
      }
    ]
  },
  "extendedLocation": {
    "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  }
}

Exempelsvar

Statuskod:: 200

{
  "properties": {
    "serviceName": "tpfiszlapdpxktx",
    "serviceType": "LoadBalancer",
    "ports": [
      {
        "port": 1883
      }
    ],
    "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/listeners/resource-name123",
  "name": "hoqjaachratt",
  "type": "Microsoft.IoTOperations/instances/brokers/listeners",
  "systemData": {
    "createdBy": "contosouser",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "contosouser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

Statuskod:: 201

Azure-AsyncOperation: https://contoso.com/operationstatus

{
  "properties": {
    "serviceName": "tpfiszlapdpxktx",
    "serviceType": "LoadBalancer",
    "ports": [
      {
        "port": 1883
      }
    ],
    "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/listeners/resource-name123",
  "name": "hoqjaachratt",
  "type": "Microsoft.IoTOperations/instances/brokers/listeners",
  "systemData": {
    "createdBy": "contosouser",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "contosouser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

Definitioner

Name	Description
BrokerListenerProperties	Definierar en Broker-lyssnare. En lyssnare är en samling portar där koordinatorn accepterar anslutningar från klienter.
BrokerListenerResource	Resurs för asynkron instanskoordinator
BrokerProtocolType	Typer av mäklarprotokoll
CertManagerCertificateSpec	Automatisk hantering av TLS-servercertifikat med cert-manager
CertManagerIssuerKind	Egenskaper för CertManagerIssuerKind
CertManagerIssuerRef	Cert-Manager issuerRef-egenskaper
CertManagerPrivateKey	Egenskaper för privat nyckel för certifikathanteraren
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
ExtendedLocation	Utökad plats är en utökning av Azure-platser. De är ett sätt att använda sina Azure ARC-aktiverade Kubernetes-kluster som målplatser för att distribuera instanser av Azure-tjänster.
ExtendedLocationType	Uppräkningen som definierar typen av ExtendedLocation accepterad.
ListenerPort	Definierar en TCP-port som en `BrokerListener` lyssnar på.
PrivateKeyAlgorithm	Typer av algoritmer för privata nycklar.
PrivateKeyRotationPolicy	Rotationsprincip för privat nyckel.
ProvisioningState	Uppräkningen som definierar status för resursen.
ResourceHealthState	Resursens hälsotillstånd.
SanForCert	Alternativa namn på certifikatmottagare (SAN) för certifikat.
ServiceType	Kubernetes-tjänsttyper som stöds av lyssnaren
systemData	Metadata som rör skapande och senaste ändring av resursen.
TlsCertMethod	Insamling av olika TLS-typer, OBS! Enum i taget behöver bara en av dem stödjas
TlsCertMethodMode	Autentiseringsläge för mäklare
X509ManualCertificate	Egenskaper för X509-certifikatautentisering.

BrokerListenerProperties

Objekt

Definierar en Broker-lyssnare. En lyssnare är en samling portar där koordinatorn accepterar anslutningar från klienter.

Name	Typ	Standardvärde	Description
healthState	ResourceHealthState	Unknown	Resursens hälsotillstånd.
ports	ListenerPort[]		Portar där lyssnaren accepterar klientanslutningar.
provisioningState	ProvisioningState		Status för den senaste åtgärden.
serviceName	string		Kubernetes-tjänstens namn på den här lyssnaren.
serviceType	ServiceType	ClusterIp	Kubernetes Service-typen för den här lyssnaren.

BrokerListenerResource

Objekt

Resurs för asynkron instanskoordinator

Name	Typ	Description
extendedLocation	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	BrokerListenerProperties	Resursspecifika egenskaper för den här resursen.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. T.ex. "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

BrokerProtocolType

Uppräkning

Typer av mäklarprotokoll

Värde	Description
Mqtt	Protokoll mäklare
WebSockets	protokoll websocket

CertManagerCertificateSpec

Objekt

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	CertManagerIssuerRef	cert-manager issuerRef.
privateKey	CertManagerPrivateKey	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	SanForCert	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

Uppräkning

Egenskaper för CertManagerIssuerKind

Värde	Description
Issuer	Typ av utfärdare.
ClusterIssuer	Typ av ClusterIssuer.

CertManagerIssuerRef

Objekt

Cert-Manager issuerRef-egenskaper

Name	Typ	Standardvärde	Description
group	string	cert-manager.io	utfärdare.
kind	CertManagerIssuerKind		typ av utfärdare (utfärdare eller ClusterIssuer).
name	string		utfärdarens namn.

CertManagerPrivateKey

Objekt

Egenskaper för privat nyckel för certifikathanteraren

Name	Typ	Description
algorithm	PrivateKeyAlgorithm	algoritm för privat nyckel.
rotationPolicy	PrivateKeyRotationPolicy	cert-manager rotationPolicy för privat nyckel.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

ExtendedLocation

Objekt

Utökad plats är en utökning av Azure-platser. De är ett sätt att använda sina Azure ARC-aktiverade Kubernetes-kluster som målplatser för att distribuera instanser av Azure-tjänster.

Name	Typ	Description
name	string	Namnet på den utökade platsen.
type	ExtendedLocationType	Typ av ExtendedLocation.

ExtendedLocationType

Uppräkning

Uppräkningen som definierar typen av ExtendedLocation accepterad.

Värde	Description
CustomLocation	CustomLocation-typ

ListenerPort

Objekt

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: 0 maximum: 65535		Kubernetes-nodport. Endast relevant när den här porten är associerad med en `NodePort` lyssnare.
port	integer (int32) minimum: 0 maximum: 65535		TCP-port för att acceptera klientanslutningar.
protocol	BrokerProtocolType	Mqtt	Protokoll som ska användas för klientanslutningar.
tls	TlsCertMethod		TLS-servercertifikatinställningar för den här porten. Utelämna för att inaktivera TLS.

PrivateKeyAlgorithm

Uppräkning

Typer av algoritmer 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

Uppräkning

Rotationsprincip för privat nyckel.

Värde	Description
Always	Rotationspolicy – alltid.
Never	Rotationspolicy - aldrig.

ProvisioningState

Uppräkning

Uppräkningen som definierar status för resursen.

Värde	Description
Succeeded	Resursen har skapats.
Failed	Det gick inte att skapa resurser.
Canceled	Resursskapandet avbröts.
Provisioning	Resursen etableras.
Updating	Resursen uppdateras.
Deleting	Resursen tas bort.
Accepted	Resursen har godkänts.

ResourceHealthState

Uppräkning

Resursens hälsotillstånd.

Värde	Description
Available	Resursen är tillgänglig och fungerar som förväntat.
Degraded	Resurshälsan försämras.
Unavailable	Resursen fungerar inte som förväntat.
Unknown	Resurstillståndet är okänt.

SanForCert

Objekt

Alternativa namn på certifikatmottagare (SAN) för certifikat.

Name	Typ	Description
dns	string[]	DNS-SAN.
ip	string[]	IP-adress-SAN.

ServiceType

Uppräkning

Kubernetes-tjänsttyper som stöds av lyssnaren

Värde	Description
ClusterIp	IP-tjänst för kluster.
LoadBalancer	Load Balancer tjänst.
NodePort	Tjänst för nodport.

systemData

Objekt

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	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	createdByType	Den typ av identitet som senast ändrade resursen.

TlsCertMethod

Objekt

Insamling av olika TLS-typer, OBS! Enum i taget behöver bara en av dem stödjas

Name	Typ	Description
certManagerCertificateSpec	CertManagerCertificateSpec	Alternativ 1 – Automatisk hantering av TLS-servercertifikat med cert-manager.
manual	X509ManualCertificate	Alternativ 2 – Manuell hantering av TLS-servercertifikat via en definierad hemlighet.
mode	TlsCertMethodMode	Läge för hantering av TLS-servercertifikat.

TlsCertMethodMode

Uppräkning

Autentiseringsläge för mäklare

Värde	Description
Automatic	Automatisk konfiguration av TLS-servercertifikat.
Manual	Manuell konfiguration av TLS-servercertifikat.

X509ManualCertificate

Objekt

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.

Dela via

Broker Listener - Create Or Update

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

BrokerListener_CreateOrUpdate

Exempelbegäran

Exempelsvar

BrokerListener_CreateOrUpdate_Complex

Exempelbegäran

Exempelsvar

BrokerListener_CreateOrUpdate_Simple

Exempelbegäran

Exempelsvar

Definitioner

BrokerListenerProperties

BrokerListenerResource

BrokerProtocolType

CertManagerCertificateSpec

CertManagerIssuerKind

CertManagerIssuerRef

CertManagerPrivateKey

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedLocation

ExtendedLocationType

ListenerPort

PrivateKeyAlgorithm

PrivateKeyRotationPolicy

ProvisioningState

ResourceHealthState

SanForCert

ServiceType

systemData

TlsCertMethod

TlsCertMethodMode

X509ManualCertificate