Broker Listener - Create Or Update

服務:

IoT Operations

API 版本:

2026-07-01

建立 BrokerListenerResource

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

URI 參數

名稱	位於	必要	類型	Description
brokerName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	訊息代理程式的名稱。
instanceName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	實例的名稱。
listenerName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	實例代理程式接聽程序資源的名稱
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求本文

名稱	類型	Description
extendedLocation	ExtendedLocation	資源的邊緣位置。
properties	BrokerListenerProperties	此資源的資源特定屬性。

回應

名稱	類型	Description
200 OK	BrokerListenerResource	資源 'BrokerListenerResource' 更新作業成功
201 Created	BrokerListenerResource	資源 'BrokerListenerResource' 建立作業成功 標題 Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	ErrorResponse	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	冒用您的使用者帳戶

範例

BrokerListener_CreateOrUpdate

BrokerListener_CreateOrUpdate_Complex

BrokerListener_CreateOrUpdate_Simple

BrokerListener_CreateOrUpdate

範例要求

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=2026-07-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"
  }
}

Java

import com.azure.resourcemanager.iotoperations.models.BrokerListenerProperties;
import com.azure.resourcemanager.iotoperations.models.BrokerProtocolType;
import com.azure.resourcemanager.iotoperations.models.CertManagerCertificateSpec;
import com.azure.resourcemanager.iotoperations.models.CertManagerIssuerKind;
import com.azure.resourcemanager.iotoperations.models.CertManagerIssuerRef;
import com.azure.resourcemanager.iotoperations.models.CertManagerPrivateKey;
import com.azure.resourcemanager.iotoperations.models.ExtendedLocation;
import com.azure.resourcemanager.iotoperations.models.ExtendedLocationType;
import com.azure.resourcemanager.iotoperations.models.ListenerPort;
import com.azure.resourcemanager.iotoperations.models.PrivateKeyAlgorithm;
import com.azure.resourcemanager.iotoperations.models.PrivateKeyRotationPolicy;
import com.azure.resourcemanager.iotoperations.models.SanForCert;
import com.azure.resourcemanager.iotoperations.models.ServiceType;
import com.azure.resourcemanager.iotoperations.models.TlsCertMethod;
import com.azure.resourcemanager.iotoperations.models.TlsCertMethodMode;
import com.azure.resourcemanager.iotoperations.models.X509ManualCertificate;
import java.util.Arrays;

/**
 * Samples for BrokerListener CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-07-01/BrokerListener_CreateOrUpdate_MaximumSet_Gen.json
     */
    /**
     * Sample code: BrokerListener_CreateOrUpdate.
     * 
     * @param manager Entry point to IoTOperationsManager.
     */
    public static void
        brokerListenerCreateOrUpdate(com.azure.resourcemanager.iotoperations.IoTOperationsManager manager) {
        manager.brokerListeners().define("resource-name123")
            .withExistingBroker("rgiotoperations", "resource-name123", "resource-name123")
            .withProperties(new BrokerListenerProperties().withServiceName("tpfiszlapdpxktx")
                .withPorts(Arrays.asList(new ListenerPort().withAuthenticationRef("tjvdroaqqy")
                    .withAuthorizationRef("fakeTokenPlaceholder").withNodePort(7281).withPort(1268)
                    .withProtocol(BrokerProtocolType.MQTT)
                    .withTls(new TlsCertMethod().withMode(TlsCertMethodMode.AUTOMATIC)
                        .withCertManagerCertificateSpec(new CertManagerCertificateSpec().withDuration("qmpeffoksron")
                            .withSecretName("fakeTokenPlaceholder").withRenewBefore("hutno")
                            .withIssuerRef(new CertManagerIssuerRef().withGroup("jtmuladdkpasfpoyvewekmiy")
                                .withKind(CertManagerIssuerKind.ISSUER).withName("ocwoqpgucvjrsuudtjhb"))
                            .withPrivateKey(new CertManagerPrivateKey().withAlgorithm(PrivateKeyAlgorithm.EC256)
                                .withRotationPolicy(PrivateKeyRotationPolicy.ALWAYS))
                            .withSan(new SanForCert().withDns(Arrays.asList("xhvmhrrhgfsapocjeebqtnzarlj"))
                                .withIp(Arrays.asList("zbgugfzcgsmegevzktsnibyuyp"))))
                        .withManual(new X509ManualCertificate().withSecretRef("fakeTokenPlaceholder")))))
                .withServiceType(ServiceType.CLUSTER_IP))
            .withExtendedLocation(new ExtendedLocation().withName(
                "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123")
                .withType(ExtendedLocationType.CUSTOM_LOCATION))
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.iotoperations import IoTOperationsMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-iotoperations
# USAGE
    python broker_listener_create_or_update_maximum_set_gen.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = IoTOperationsMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.broker_listener.begin_create_or_update(
        resource_group_name="rgiotoperations",
        instance_name="resource-name123",
        broker_name="resource-name123",
        listener_name="resource-name123",
        resource={
            "extendedLocation": {
                "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
                "type": "CustomLocation",
            },
            "properties": {
                "ports": [
                    {
                        "authenticationRef": "tjvdroaqqy",
                        "authorizationRef": "inxhvxnwswyrvt",
                        "nodePort": 7281,
                        "port": 1268,
                        "protocol": "Mqtt",
                        "tls": {
                            "certManagerCertificateSpec": {
                                "duration": "qmpeffoksron",
                                "issuerRef": {
                                    "group": "jtmuladdkpasfpoyvewekmiy",
                                    "kind": "Issuer",
                                    "name": "ocwoqpgucvjrsuudtjhb",
                                },
                                "privateKey": {"algorithm": "Ec256", "rotationPolicy": "Always"},
                                "renewBefore": "hutno",
                                "san": {"dns": ["xhvmhrrhgfsapocjeebqtnzarlj"], "ip": ["zbgugfzcgsmegevzktsnibyuyp"]},
                                "secretName": "oagi",
                            },
                            "manual": {"secretRef": "secret-name"},
                            "mode": "Automatic",
                        },
                    }
                ],
                "serviceName": "tpfiszlapdpxktx",
                "serviceType": "ClusterIp",
            },
        },
    ).result()
    print(response)


# x-ms-original-file: 2026-07-01/BrokerListener_CreateOrUpdate_MaximumSet_Gen.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armiotoperations_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotoperations/armiotoperations"
)

// Generated from example definition: 2026-07-01/BrokerListener_CreateOrUpdate_MaximumSet_Gen.json
func ExampleBrokerListenerClient_BeginCreateOrUpdate_brokerListenerCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armiotoperations.NewClientFactory("F8C729F9-DF9C-4743-848F-96EE433D8E53", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewBrokerListenerClient().BeginCreateOrUpdate(ctx, "rgiotoperations", "resource-name123", "resource-name123", "resource-name123", armiotoperations.BrokerListenerResource{
		Properties: &armiotoperations.BrokerListenerProperties{
			ServiceName: to.Ptr("tpfiszlapdpxktx"),
			Ports: []*armiotoperations.ListenerPort{
				{
					AuthenticationRef: to.Ptr("tjvdroaqqy"),
					AuthorizationRef:  to.Ptr("inxhvxnwswyrvt"),
					NodePort:          to.Ptr[int32](7281),
					Port:              to.Ptr[int32](1268),
					Protocol:          to.Ptr(armiotoperations.BrokerProtocolTypeMqtt),
					TLS: &armiotoperations.TLSCertMethod{
						Mode: to.Ptr(armiotoperations.TLSCertMethodModeAutomatic),
						CertManagerCertificateSpec: &armiotoperations.CertManagerCertificateSpec{
							Duration:    to.Ptr("qmpeffoksron"),
							SecretName:  to.Ptr("oagi"),
							RenewBefore: to.Ptr("hutno"),
							IssuerRef: &armiotoperations.CertManagerIssuerRef{
								Group: to.Ptr("jtmuladdkpasfpoyvewekmiy"),
								Kind:  to.Ptr(armiotoperations.CertManagerIssuerKindIssuer),
								Name:  to.Ptr("ocwoqpgucvjrsuudtjhb"),
							},
							PrivateKey: &armiotoperations.CertManagerPrivateKey{
								Algorithm:      to.Ptr(armiotoperations.PrivateKeyAlgorithmEc256),
								RotationPolicy: to.Ptr(armiotoperations.PrivateKeyRotationPolicyAlways),
							},
							San: &armiotoperations.SanForCert{
								DNS: []*string{
									to.Ptr("xhvmhrrhgfsapocjeebqtnzarlj"),
								},
								IP: []*string{
									to.Ptr("zbgugfzcgsmegevzktsnibyuyp"),
								},
							},
						},
						Manual: &armiotoperations.X509ManualCertificate{
							SecretRef: to.Ptr("secret-name"),
						},
					},
				},
			},
			ServiceType: to.Ptr(armiotoperations.ServiceTypeClusterIP),
		},
		ExtendedLocation: &armiotoperations.ExtendedLocation{
			Name: to.Ptr("/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123"),
			Type: to.Ptr(armiotoperations.ExtendedLocationTypeCustomLocation),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to poll the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armiotoperations.BrokerListenerClientCreateOrUpdateResponse{
	// 	BrokerListenerResource: armiotoperations.BrokerListenerResource{
	// 		Properties: &armiotoperations.BrokerListenerProperties{
	// 			ServiceName: to.Ptr("tpfiszlapdpxktx"),
	// 			Ports: []*armiotoperations.ListenerPort{
	// 				{
	// 					AuthenticationRef: to.Ptr("tjvdroaqqy"),
	// 					AuthorizationRef: to.Ptr("inxhvxnwswyrvt"),
	// 					NodePort: to.Ptr[int32](7281),
	// 					Port: to.Ptr[int32](1268),
	// 					Protocol: to.Ptr(armiotoperations.BrokerProtocolTypeMqtt),
	// 					TLS: &armiotoperations.TLSCertMethod{
	// 						Mode: to.Ptr(armiotoperations.TLSCertMethodModeAutomatic),
	// 						CertManagerCertificateSpec: &armiotoperations.CertManagerCertificateSpec{
	// 							Duration: to.Ptr("qmpeffoksron"),
	// 							SecretName: to.Ptr("oagi"),
	// 							RenewBefore: to.Ptr("hutno"),
	// 							IssuerRef: &armiotoperations.CertManagerIssuerRef{
	// 								Group: to.Ptr("jtmuladdkpasfpoyvewekmiy"),
	// 								Kind: to.Ptr(armiotoperations.CertManagerIssuerKindIssuer),
	// 								Name: to.Ptr("ocwoqpgucvjrsuudtjhb"),
	// 							},
	// 							PrivateKey: &armiotoperations.CertManagerPrivateKey{
	// 								Algorithm: to.Ptr(armiotoperations.PrivateKeyAlgorithmEc256),
	// 								RotationPolicy: to.Ptr(armiotoperations.PrivateKeyRotationPolicyAlways),
	// 							},
	// 							San: &armiotoperations.SanForCert{
	// 								DNS: []*string{
	// 									to.Ptr("xhvmhrrhgfsapocjeebqtnzarlj"),
	// 								},
	// 								IP: []*string{
	// 									to.Ptr("zbgugfzcgsmegevzktsnibyuyp"),
	// 								},
	// 							},
	// 						},
	// 						Manual: &armiotoperations.X509ManualCertificate{
	// 							SecretRef: to.Ptr("secret-name"),
	// 						},
	// 					},
	// 				},
	// 			},
	// 			ServiceType: to.Ptr(armiotoperations.ServiceTypeClusterIP),
	// 			ProvisioningState: to.Ptr(armiotoperations.ProvisioningStateSucceeded),
	// 		},
	// 		ExtendedLocation: &armiotoperations.ExtendedLocation{
	// 			Name: to.Ptr("/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123"),
	// 			Type: to.Ptr(armiotoperations.ExtendedLocationTypeCustomLocation),
	// 		},
	// 		ID: to.Ptr("/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123"),
	// 		Name: to.Ptr("hoqjaachratt"),
	// 		Type: to.Ptr("Microsoft.IoTOperations/instances/brokers/listeners"),
	// 		SystemData: &armiotoperations.SystemData{
	// 			CreatedBy: to.Ptr("contosouser"),
	// 			CreatedByType: to.Ptr(armiotoperations.CreatedByTypeUser),
	// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-08-09T18:13:29.389Z"); return t}()),
	// 			LastModifiedBy: to.Ptr("contosouser"),
	// 			LastModifiedByType: to.Ptr(armiotoperations.CreatedByTypeUser),
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-08-09T18:13:29.389Z"); return t}()),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { IoTOperationsClient } = require("@azure/arm-iotoperations");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to create a BrokerListenerResource
 *
 * @summary create a BrokerListenerResource
 * x-ms-original-file: 2026-07-01/BrokerListener_CreateOrUpdate_MaximumSet_Gen.json
 */
async function brokerListenerCreateOrUpdate() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "F8C729F9-DF9C-4743-848F-96EE433D8E53";
  const client = new IoTOperationsClient(credential, subscriptionId);
  const result = await client.brokerListener.createOrUpdate(
    "rgiotoperations",
    "resource-name123",
    "resource-name123",
    "resource-name123",
    {
      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",
      },
    },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:

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"
  }
}

狀態碼:

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

範例要求

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=2026-07-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"
  }
}

Java

import com.azure.resourcemanager.iotoperations.models.BrokerListenerProperties;
import com.azure.resourcemanager.iotoperations.models.BrokerProtocolType;
import com.azure.resourcemanager.iotoperations.models.CertManagerCertificateSpec;
import com.azure.resourcemanager.iotoperations.models.CertManagerIssuerKind;
import com.azure.resourcemanager.iotoperations.models.CertManagerIssuerRef;
import com.azure.resourcemanager.iotoperations.models.ExtendedLocation;
import com.azure.resourcemanager.iotoperations.models.ExtendedLocationType;
import com.azure.resourcemanager.iotoperations.models.ListenerPort;
import com.azure.resourcemanager.iotoperations.models.ServiceType;
import com.azure.resourcemanager.iotoperations.models.TlsCertMethod;
import com.azure.resourcemanager.iotoperations.models.TlsCertMethodMode;
import com.azure.resourcemanager.iotoperations.models.X509ManualCertificate;
import java.util.Arrays;

/**
 * Samples for BrokerListener CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-07-01/BrokerListener_CreateOrUpdate_Complex.json
     */
    /**
     * Sample code: BrokerListener_CreateOrUpdate_Complex.
     * 
     * @param manager Entry point to IoTOperationsManager.
     */
    public static void
        brokerListenerCreateOrUpdateComplex(com.azure.resourcemanager.iotoperations.IoTOperationsManager manager) {
        manager.brokerListeners().define("resource-name123")
            .withExistingBroker("rgiotoperations", "resource-name123", "resource-name123")
            .withProperties(new BrokerListenerProperties()
                .withPorts(Arrays.asList(
                    new ListenerPort().withAuthenticationRef("example-authentication").withPort(8080)
                        .withProtocol(BrokerProtocolType.WEB_SOCKETS),
                    new ListenerPort().withAuthenticationRef("example-authentication").withPort(8443)
                        .withProtocol(BrokerProtocolType.WEB_SOCKETS)
                        .withTls(new TlsCertMethod().withMode(TlsCertMethodMode.AUTOMATIC)
                            .withCertManagerCertificateSpec(new CertManagerCertificateSpec()
                                .withIssuerRef(new CertManagerIssuerRef().withGroup("jtmuladdkpasfpoyvewekmiy")
                                    .withKind(CertManagerIssuerKind.ISSUER).withName("example-issuer")))),
                    new ListenerPort().withAuthenticationRef("example-authentication").withPort(1883),
                    new ListenerPort().withAuthenticationRef("example-authentication").withPort(8883)
                        .withTls(new TlsCertMethod().withMode(TlsCertMethodMode.MANUAL)
                            .withManual(new X509ManualCertificate().withSecretRef("fakeTokenPlaceholder")))))
                .withServiceType(ServiceType.LOAD_BALANCER))
            .withExtendedLocation(new ExtendedLocation().withName(
                "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123")
                .withType(ExtendedLocationType.CUSTOM_LOCATION))
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.iotoperations import IoTOperationsMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-iotoperations
# USAGE
    python broker_listener_create_or_update_complex.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = IoTOperationsMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.broker_listener.begin_create_or_update(
        resource_group_name="rgiotoperations",
        instance_name="resource-name123",
        broker_name="resource-name123",
        listener_name="resource-name123",
        resource={
            "extendedLocation": {
                "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
                "type": "CustomLocation",
            },
            "properties": {
                "ports": [
                    {"authenticationRef": "example-authentication", "port": 8080, "protocol": "WebSockets"},
                    {
                        "authenticationRef": "example-authentication",
                        "port": 8443,
                        "protocol": "WebSockets",
                        "tls": {
                            "certManagerCertificateSpec": {
                                "issuerRef": {
                                    "group": "jtmuladdkpasfpoyvewekmiy",
                                    "kind": "Issuer",
                                    "name": "example-issuer",
                                }
                            },
                            "mode": "Automatic",
                        },
                    },
                    {"authenticationRef": "example-authentication", "port": 1883},
                    {
                        "authenticationRef": "example-authentication",
                        "port": 8883,
                        "tls": {"manual": {"secretRef": "example-secret"}, "mode": "Manual"},
                    },
                ],
                "serviceType": "LoadBalancer",
            },
        },
    ).result()
    print(response)


# x-ms-original-file: 2026-07-01/BrokerListener_CreateOrUpdate_Complex.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armiotoperations_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotoperations/armiotoperations"
)

// Generated from example definition: 2026-07-01/BrokerListener_CreateOrUpdate_Complex.json
func ExampleBrokerListenerClient_BeginCreateOrUpdate_brokerListenerCreateOrUpdateComplex() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armiotoperations.NewClientFactory("F8C729F9-DF9C-4743-848F-96EE433D8E53", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewBrokerListenerClient().BeginCreateOrUpdate(ctx, "rgiotoperations", "resource-name123", "resource-name123", "resource-name123", armiotoperations.BrokerListenerResource{
		Properties: &armiotoperations.BrokerListenerProperties{
			ServiceType: to.Ptr(armiotoperations.ServiceTypeLoadBalancer),
			Ports: []*armiotoperations.ListenerPort{
				{
					Port:              to.Ptr[int32](8080),
					AuthenticationRef: to.Ptr("example-authentication"),
					Protocol:          to.Ptr(armiotoperations.BrokerProtocolTypeWebSockets),
				},
				{
					Port:              to.Ptr[int32](8443),
					AuthenticationRef: to.Ptr("example-authentication"),
					Protocol:          to.Ptr(armiotoperations.BrokerProtocolTypeWebSockets),
					TLS: &armiotoperations.TLSCertMethod{
						Mode: to.Ptr(armiotoperations.TLSCertMethodModeAutomatic),
						CertManagerCertificateSpec: &armiotoperations.CertManagerCertificateSpec{
							IssuerRef: &armiotoperations.CertManagerIssuerRef{
								Group: to.Ptr("jtmuladdkpasfpoyvewekmiy"),
								Name:  to.Ptr("example-issuer"),
								Kind:  to.Ptr(armiotoperations.CertManagerIssuerKindIssuer),
							},
						},
					},
				},
				{
					Port:              to.Ptr[int32](1883),
					AuthenticationRef: to.Ptr("example-authentication"),
				},
				{
					Port:              to.Ptr[int32](8883),
					AuthenticationRef: to.Ptr("example-authentication"),
					TLS: &armiotoperations.TLSCertMethod{
						Mode: to.Ptr(armiotoperations.TLSCertMethodModeManual),
						Manual: &armiotoperations.X509ManualCertificate{
							SecretRef: to.Ptr("example-secret"),
						},
					},
				},
			},
		},
		ExtendedLocation: &armiotoperations.ExtendedLocation{
			Name: to.Ptr("/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123"),
			Type: to.Ptr(armiotoperations.ExtendedLocationTypeCustomLocation),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to poll the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armiotoperations.BrokerListenerClientCreateOrUpdateResponse{
	// 	BrokerListenerResource: armiotoperations.BrokerListenerResource{
	// 		Properties: &armiotoperations.BrokerListenerProperties{
	// 			ServiceName: to.Ptr("tpfiszlapdpxktx"),
	// 			ServiceType: to.Ptr(armiotoperations.ServiceTypeLoadBalancer),
	// 			Ports: []*armiotoperations.ListenerPort{
	// 				{
	// 					Port: to.Ptr[int32](8080),
	// 					AuthenticationRef: to.Ptr("example-authentication"),
	// 					Protocol: to.Ptr(armiotoperations.BrokerProtocolTypeWebSockets),
	// 				},
	// 				{
	// 					Port: to.Ptr[int32](8443),
	// 					AuthenticationRef: to.Ptr("example-authentication"),
	// 					Protocol: to.Ptr(armiotoperations.BrokerProtocolTypeWebSockets),
	// 					TLS: &armiotoperations.TLSCertMethod{
	// 						Mode: to.Ptr(armiotoperations.TLSCertMethodModeAutomatic),
	// 						CertManagerCertificateSpec: &armiotoperations.CertManagerCertificateSpec{
	// 							IssuerRef: &armiotoperations.CertManagerIssuerRef{
	// 								Group: to.Ptr("jtmuladdkpasfpoyvewekmiy"),
	// 								Name: to.Ptr("example-issuer"),
	// 								Kind: to.Ptr(armiotoperations.CertManagerIssuerKindIssuer),
	// 							},
	// 						},
	// 					},
	// 				},
	// 				{
	// 					Port: to.Ptr[int32](1883),
	// 					AuthenticationRef: to.Ptr("example-authentication"),
	// 				},
	// 				{
	// 					Port: to.Ptr[int32](8883),
	// 					AuthenticationRef: to.Ptr("example-authentication"),
	// 					TLS: &armiotoperations.TLSCertMethod{
	// 						Mode: to.Ptr(armiotoperations.TLSCertMethodModeManual),
	// 						Manual: &armiotoperations.X509ManualCertificate{
	// 							SecretRef: to.Ptr("example-secret"),
	// 						},
	// 					},
	// 				},
	// 			},
	// 			ProvisioningState: to.Ptr(armiotoperations.ProvisioningStateSucceeded),
	// 		},
	// 		ExtendedLocation: &armiotoperations.ExtendedLocation{
	// 			Name: to.Ptr("/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123"),
	// 			Type: to.Ptr(armiotoperations.ExtendedLocationTypeCustomLocation),
	// 		},
	// 		ID: to.Ptr("/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123"),
	// 		Name: to.Ptr("hoqjaachratt"),
	// 		Type: to.Ptr("Microsoft.IoTOperations/instances/brokers/listeners"),
	// 		SystemData: &armiotoperations.SystemData{
	// 			CreatedBy: to.Ptr("contosouser"),
	// 			CreatedByType: to.Ptr(armiotoperations.CreatedByTypeUser),
	// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-08-09T18:13:29.389Z"); return t}()),
	// 			LastModifiedBy: to.Ptr("contosouser"),
	// 			LastModifiedByType: to.Ptr(armiotoperations.CreatedByTypeUser),
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-08-09T18:13:29.389Z"); return t}()),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { IoTOperationsClient } = require("@azure/arm-iotoperations");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to create a BrokerListenerResource
 *
 * @summary create a BrokerListenerResource
 * x-ms-original-file: 2026-07-01/BrokerListener_CreateOrUpdate_Complex.json
 */
async function brokerListenerCreateOrUpdateComplex() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "F8C729F9-DF9C-4743-848F-96EE433D8E53";
  const client = new IoTOperationsClient(credential, subscriptionId);
  const result = await client.brokerListener.createOrUpdate(
    "rgiotoperations",
    "resource-name123",
    "resource-name123",
    "resource-name123",
    {
      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",
      },
    },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:

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"
  }
}

狀態碼:

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

範例要求

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=2026-07-01

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

Java

import com.azure.resourcemanager.iotoperations.models.BrokerListenerProperties;
import com.azure.resourcemanager.iotoperations.models.ExtendedLocation;
import com.azure.resourcemanager.iotoperations.models.ExtendedLocationType;
import com.azure.resourcemanager.iotoperations.models.ListenerPort;
import java.util.Arrays;

/**
 * Samples for BrokerListener CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-07-01/BrokerListener_CreateOrUpdate_Simple.json
     */
    /**
     * Sample code: BrokerListener_CreateOrUpdate_Simple.
     * 
     * @param manager Entry point to IoTOperationsManager.
     */
    public static void
        brokerListenerCreateOrUpdateSimple(com.azure.resourcemanager.iotoperations.IoTOperationsManager manager) {
        manager.brokerListeners().define("resource-name123")
            .withExistingBroker("rgiotoperations", "resource-name123", "resource-name123")
            .withProperties(new BrokerListenerProperties().withPorts(Arrays.asList(new ListenerPort().withPort(1883))))
            .withExtendedLocation(new ExtendedLocation().withName(
                "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123")
                .withType(ExtendedLocationType.CUSTOM_LOCATION))
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.iotoperations import IoTOperationsMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-iotoperations
# USAGE
    python broker_listener_create_or_update_simple.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = IoTOperationsMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.broker_listener.begin_create_or_update(
        resource_group_name="rgiotoperations",
        instance_name="resource-name123",
        broker_name="resource-name123",
        listener_name="resource-name123",
        resource={
            "extendedLocation": {
                "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
                "type": "CustomLocation",
            },
            "properties": {"ports": [{"port": 1883}]},
        },
    ).result()
    print(response)


# x-ms-original-file: 2026-07-01/BrokerListener_CreateOrUpdate_Simple.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armiotoperations_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotoperations/armiotoperations"
)

// Generated from example definition: 2026-07-01/BrokerListener_CreateOrUpdate_Simple.json
func ExampleBrokerListenerClient_BeginCreateOrUpdate_brokerListenerCreateOrUpdateSimple() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armiotoperations.NewClientFactory("F8C729F9-DF9C-4743-848F-96EE433D8E53", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewBrokerListenerClient().BeginCreateOrUpdate(ctx, "rgiotoperations", "resource-name123", "resource-name123", "resource-name123", armiotoperations.BrokerListenerResource{
		Properties: &armiotoperations.BrokerListenerProperties{
			Ports: []*armiotoperations.ListenerPort{
				{
					Port: to.Ptr[int32](1883),
				},
			},
		},
		ExtendedLocation: &armiotoperations.ExtendedLocation{
			Name: to.Ptr("/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123"),
			Type: to.Ptr(armiotoperations.ExtendedLocationTypeCustomLocation),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to poll the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armiotoperations.BrokerListenerClientCreateOrUpdateResponse{
	// 	BrokerListenerResource: armiotoperations.BrokerListenerResource{
	// 		Properties: &armiotoperations.BrokerListenerProperties{
	// 			ServiceName: to.Ptr("tpfiszlapdpxktx"),
	// 			ServiceType: to.Ptr(armiotoperations.ServiceTypeLoadBalancer),
	// 			Ports: []*armiotoperations.ListenerPort{
	// 				{
	// 					Port: to.Ptr[int32](1883),
	// 				},
	// 			},
	// 			ProvisioningState: to.Ptr(armiotoperations.ProvisioningStateSucceeded),
	// 		},
	// 		ExtendedLocation: &armiotoperations.ExtendedLocation{
	// 			Name: to.Ptr("/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123"),
	// 			Type: to.Ptr(armiotoperations.ExtendedLocationTypeCustomLocation),
	// 		},
	// 		ID: to.Ptr("/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123"),
	// 		Name: to.Ptr("hoqjaachratt"),
	// 		Type: to.Ptr("Microsoft.IoTOperations/instances/brokers/listeners"),
	// 		SystemData: &armiotoperations.SystemData{
	// 			CreatedBy: to.Ptr("contosouser"),
	// 			CreatedByType: to.Ptr(armiotoperations.CreatedByTypeUser),
	// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-08-09T18:13:29.389Z"); return t}()),
	// 			LastModifiedBy: to.Ptr("contosouser"),
	// 			LastModifiedByType: to.Ptr(armiotoperations.CreatedByTypeUser),
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-08-09T18:13:29.389Z"); return t}()),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { IoTOperationsClient } = require("@azure/arm-iotoperations");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to create a BrokerListenerResource
 *
 * @summary create a BrokerListenerResource
 * x-ms-original-file: 2026-07-01/BrokerListener_CreateOrUpdate_Simple.json
 */
async function brokerListenerCreateOrUpdateSimple() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "F8C729F9-DF9C-4743-848F-96EE433D8E53";
  const client = new IoTOperationsClient(credential, subscriptionId);
  const result = await client.brokerListener.createOrUpdate(
    "rgiotoperations",
    "resource-name123",
    "resource-name123",
    "resource-name123",
    {
      properties: { ports: [{ port: 1883 }] },
      extendedLocation: {
        name: "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
        type: "CustomLocation",
      },
    },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:

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"
  }
}

狀態碼:

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"
  }
}

定義

名稱	Description
BrokerListenerProperties	定義 Broker 接聽程式。 接聽程式是訊息代理程式接受來自用戶端連線的埠集合。
BrokerListenerResource	實例代理程序資源
BrokerProtocolType	Broker 通訊協定類型
CertManagerCertificateSpec	使用 cert-manager 自動 TLS 伺服器證書管理
CertManagerIssuerKind	CertManagerIssuerKind 屬性
CertManagerIssuerRef	Cert-Manager issuerRef 屬性
CertManagerPrivateKey	Cert Manager 私鑰屬性
createdByType	建立此資源的身分識別類型。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細資料。
ErrorResponse	錯誤回應
ExtendedLocation	擴充位置是 Azure 位置的延伸模組。 他們提供一種方式，以使用其已啟用 Azure ARC 的 Kubernetes 叢集作為部署 Azure 服務實例的目標位置。
ExtendedLocationType	已接受 ExtendedLocation 的列舉類型。
ListenerPort	定義 BrokerListener 接聽的 TCP 連接埠。
PrivateKeyAlgorithm	私鑰演算法類型。
PrivateKeyRotationPolicy	私鑰輪替原則。
ProvisioningState	定義資源狀態的列舉。
ResourceHealthState	資源的健康情況狀態。
SanForCert	憑證的主體別名（SAN）。
ServiceType	接聽程序支援的 Kubernetes 服務類型
systemData	與建立和上次修改資源相關的元數據。
TlsCertMethod	不同 TLS 類型的集合，注意 - 列舉一次只需要支援其中一個
TlsCertMethodMode	Broker 驗證模式
X509ManualCertificate	X509 憑證驗證屬性。

BrokerListenerProperties

Object

定義 Broker 接聽程式。 接聽程式是訊息代理程式接受來自用戶端連線的埠集合。

名稱	類型	預設值	Description
healthState	ResourceHealthState	Unknown	資源的健康情況狀態。
ports	ListenerPort[]		此接聽程式接受用戶端連線的埠。
provisioningState	ProvisioningState		上次作業的狀態。
serviceName	string		此接聽程式的 Kubernetes Service 名稱。
serviceType	ServiceType	ClusterIp	這個接聽程式的 Kubernetes Service 類型。

BrokerListenerResource

Object

實例代理程序資源

名稱	類型	Description
extendedLocation	ExtendedLocation	資源的邊緣位置。
id	string (arm-id)	資源的完整資源標識碼。 例如 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	資源的名稱
properties	BrokerListenerProperties	此資源的資源特定屬性。
systemData	systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
type	string	資源的類型。 例如：「Microsoft.Compute/virtualMachines」或「Microsoft.Storage/storageAccounts」

BrokerProtocolType

列舉型別

Broker 通訊協定類型

值	Description
Mqtt	協議代理
WebSockets	通訊協定 WebSocket

CertManagerCertificateSpec

Object

使用 cert-manager 自動 TLS 伺服器證書管理

名稱	類型	Description
duration	string	憑證的存留期。 必須使用 Go 時間指定。持續時間格式（h|m|s）。 例如，240小時240小時45米45分鐘。
issuerRef	CertManagerIssuerRef	cert-manager issuerRef 的 issuerRef 中。
privateKey	CertManagerPrivateKey	憑證私鑰的類型。
renewBefore	string	何時開始更新憑證。 必須使用 Go 時間指定。持續時間格式（h|m|s）。 例如，240小時240小時45米45分鐘。
san	SanForCert	要包含在憑證中的其他主體別名 （SAN）。
secretName	string	儲存伺服器證書的秘密。 將會覆寫任何現有的數據。 這是透過識別名稱而非秘密本身來參考秘密。

CertManagerIssuerKind

列舉型別

CertManagerIssuerKind 屬性

值	Description
Issuer	發行人種類。
ClusterIssuer	ClusterIssuer 種類。

CertManagerIssuerRef

Object

Cert-Manager issuerRef 屬性

名稱	類型	預設值	Description
group	string	cert-manager.io	簽發者的群組。
kind	CertManagerIssuerKind		簽發者種類（簽發者或叢集Issuer）。
name	string		簽發者的名稱。

CertManagerPrivateKey

Object

Cert Manager 私鑰屬性

名稱	類型	Description
algorithm	PrivateKeyAlgorithm	私鑰的演算法。
rotationPolicy	PrivateKeyRotationPolicy	cert-manager 私鑰 rotationPolicy。

createdByType

列舉型別

建立此資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細資料。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤的其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳情
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

ExtendedLocation

Object

擴充位置是 Azure 位置的延伸模組。 他們提供一種方式，以使用其已啟用 Azure ARC 的 Kubernetes 叢集作為部署 Azure 服務實例的目標位置。

名稱	類型	Description
name	string	擴充位置的名稱。
type	ExtendedLocationType	ExtendedLocation 的類型。

ExtendedLocationType

列舉型別

已接受 ExtendedLocation 的列舉類型。

值	Description
CustomLocation	CustomLocation 類型

ListenerPort

Object

定義 BrokerListener 接聽的 TCP 連接埠。

名稱	類型	預設值	Description
authenticationRef	string		客戶端驗證設定的參考。 省略以停用驗證。
authorizationRef	string		用戶端授權設定的參考。 省略以停用授權。
nodePort	integer (int32) minimum: 0 maximum: 65535		Kubernetes 節點埠。 只有在此埠與 NodePort 接聽程式相關聯時才相關。
port	integer (int32) minimum: 0 maximum: 65535		用於接受客戶端連線的 TCP 連接埠。
protocol	BrokerProtocolType	Mqtt	要用於用戶端連線的通訊協定。
tls	TlsCertMethod		此埠的 TLS 伺服器證書設定。 省略以停用 TLS。

PrivateKeyAlgorithm

列舉型別

私鑰演算法類型。

值	Description
Ec256	算法 - ec256。
Ec384	演算法 - ec384。
Ec521	算法 - ec521。
Ed25519	演算法 - ed25519。
Rsa2048	演算法 - rsa2048。
Rsa4096	演算法 - rsa4096。
Rsa8192	演算法 - rsa8192。

PrivateKeyRotationPolicy

列舉型別

私鑰輪替原則。

值	Description
Always	輪換政策 - 始終。
Never	輪換政策 - 從不。

ProvisioningState

列舉型別

定義資源狀態的列舉。

值	Description
Succeeded	資源已建立。
Failed	資源建立失敗。
Canceled	資源建立已取消。
Provisioning	資源正在佈建中。
Updating	資源正在更新中。
Deleting	資源正在刪除。
Accepted	資源已被接受。

ResourceHealthState

列舉型別

資源的健康情況狀態。

值	Description
Available	資源可用且如預期般運作。
Degraded	資源健康情況已降低。
Unavailable	資源未如預期般運作。
Unknown	資源狀態未知。

SanForCert

Object

憑證的主體別名（SAN）。

名稱	類型	Description
dns	string[]	DNS SAN。
ip	string[]	IP 位址 SAN。

ServiceType

列舉型別

接聽程序支援的 Kubernetes 服務類型

值	Description
ClusterIp	叢集 IP 服務。
LoadBalancer	負載平衡器服務。
NodePort	節點連接埠服務。

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立此資源的身分。
createdByType	createdByType	建立此資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳 （UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

TlsCertMethod

Object

不同 TLS 類型的集合，注意 - 列舉一次只需要支援其中一個

名稱	類型	Description
certManagerCertificateSpec	CertManagerCertificateSpec	選項 1 - 使用 cert-manager 自動 TLS 伺服器證書管理。
manual	X509ManualCertificate	選項 2 - 透過定義的秘密手動管理 TLS 伺服器證書。
mode	TlsCertMethodMode	TLS 伺服器證書管理的模式。

TlsCertMethodMode

列舉型別

Broker 驗證模式

值	Description
Automatic	自動 TLS 伺服器憑證設定。
Manual	手動 TLS 伺服器憑證設定。

X509ManualCertificate

Object

X509 憑證驗證屬性。

名稱	類型	Description
secretRef	string	包含 X.509 用戶端憑證的 Kubernetes 祕密。 這是透過識別名稱而非秘密本身來參考秘密。