Broker Authentication - List By Resource Group

Referentie

Service:: IoT Operations

API-versie:: 2024-11-01

List BrokerAuthenticationResource-resources door BrokerResource

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authentications?api-version=2024-11-01

URI-parameters

Name	In	Vereist	Type	Description
brokerName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	Naam van broker.
instanceName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	Naam van exemplaar.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	BrokerAuthenticationResourceListResult	De Azure-bewerking is voltooid.
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

BrokerAuthentication_ListByResourceGroup

Voorbeeldaanvraag

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


/**
 * Samples for BrokerAuthentication ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: 2024-11-01/BrokerAuthentication_ListByResourceGroup_MaximumSet_Gen.json
     */
    /**
     * Sample code: BrokerAuthentication_ListByResourceGroup.
     * 
     * @param manager Entry point to IoTOperationsManager.
     */
    public static void
        brokerAuthenticationListByResourceGroup(com.azure.resourcemanager.iotoperations.IoTOperationsManager manager) {
        manager.brokerAuthentications().listByResourceGroup("rgiotoperations", "resource-name123", "resource-name123",
            com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.iotoperations import IoTOperationsMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-iotoperations
# USAGE
    python broker_authentication_list_by_resource_group_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_authentication.list_by_resource_group(
        resource_group_name="rgiotoperations",
        instance_name="resource-name123",
        broker_name="resource-name123",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2024-11-01/BrokerAuthentication_ListByResourceGroup_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

package armiotoperations_test

import (
	"context"
	"log"

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

// Generated from example definition: 2024-11-01/BrokerAuthentication_ListByResourceGroup_MaximumSet_Gen.json
func ExampleBrokerAuthenticationClient_NewListByResourceGroupPager() {
	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)
	}
	pager := clientFactory.NewBrokerAuthenticationClient().NewListByResourceGroupPager("rgiotoperations", "resource-name123", "resource-name123", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armiotoperations.BrokerAuthenticationClientListByResourceGroupResponse{
		// 	BrokerAuthenticationResourceListResult: armiotoperations.BrokerAuthenticationResourceListResult{
		// 		Value: []*armiotoperations.BrokerAuthenticationResource{
		// 			{
		// 				Properties: &armiotoperations.BrokerAuthenticationProperties{
		// 					AuthenticationMethods: []*armiotoperations.BrokerAuthenticatorMethods{
		// 						{
		// 							Method: to.Ptr(armiotoperations.BrokerAuthenticationMethodCustom),
		// 							CustomSettings: &armiotoperations.BrokerAuthenticatorMethodCustom{
		// 								Auth: &armiotoperations.BrokerAuthenticatorCustomAuth{
		// 									X509: &armiotoperations.X509ManualCertificate{
		// 										SecretRef: to.Ptr("secret-name"),
		// 									},
		// 								},
		// 								CaCertConfigMap: to.Ptr("pdecudefqyolvncbus"),
		// 								Endpoint: to.Ptr("https://www.example.com"),
		// 								Headers: map[string]*string{
		// 									"key8518": to.Ptr("bwityjy"),
		// 								},
		// 							},
		// 							ServiceAccountTokenSettings: &armiotoperations.BrokerAuthenticatorMethodSat{
		// 								Audiences: []*string{
		// 									to.Ptr("jqyhyqatuydg"),
		// 								},
		// 							},
		// 							X509Settings: &armiotoperations.BrokerAuthenticatorMethodX509{
		// 								AuthorizationAttributes: map[string]*armiotoperations.BrokerAuthenticatorMethodX509Attributes{
		// 									"key3384": &armiotoperations.BrokerAuthenticatorMethodX509Attributes{
		// 										Attributes: map[string]*string{
		// 											"key186": to.Ptr("ucpajramsz"),
		// 										},
		// 										Subject: to.Ptr("jpgwctfeixitptfgfnqhua"),
		// 									},
		// 								},
		// 								TrustedClientCaCert: to.Ptr("vlctsqddl"),
		// 							},
		// 						},
		// 					},
		// 					ProvisioningState: to.Ptr(armiotoperations.ProvisioningStateSucceeded),
		// 				},
		// 				ExtendedLocation: &armiotoperations.ExtendedLocation{
		// 					Name: to.Ptr("qmbrfwcpwwhggszhrdjv"),
		// 					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/authentications/resource-name123"),
		// 				Name: to.Ptr("lwucizfvtsdpx"),
		// 				Type: to.Ptr("kvtilkgcxanlfozrd"),
		// 				SystemData: &armiotoperations.SystemData{
		// 					CreatedBy: to.Ptr("ssvaslsmudloholronopqyxjcu"),
		// 					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("gnicpuszwd"),
		// 					LastModifiedByType: to.Ptr(armiotoperations.CreatedByTypeUser),
		// 					LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-08-09T18:13:29.389Z"); return t}()),
		// 				},
		// 			},
		// 		},
		// 		NextLink: to.Ptr("https://microsoft.com/a"),
		// 	},
		// }
	}
}

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.IotOperations.Models;
using Azure.ResourceManager.IotOperations;

// Generated from example definition: 2024-11-01/BrokerAuthentication_ListByResourceGroup_MaximumSet_Gen.json
// this example is just showing the usage of "BrokerAuthenticationResource_ListByResourceGroup" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this IotOperationsBrokerResource created on azure
// for more information of creating IotOperationsBrokerResource, please refer to the document of IotOperationsBrokerResource
string subscriptionId = "F8C729F9-DF9C-4743-848F-96EE433D8E53";
string resourceGroupName = "rgiotoperations";
string instanceName = "resource-name123";
string brokerName = "resource-name123";
ResourceIdentifier iotOperationsBrokerResourceId = IotOperationsBrokerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, instanceName, brokerName);
IotOperationsBrokerResource iotOperationsBroker = client.GetIotOperationsBrokerResource(iotOperationsBrokerResourceId);

// get the collection of this IotOperationsBrokerAuthenticationResource
IotOperationsBrokerAuthenticationCollection collection = iotOperationsBroker.GetIotOperationsBrokerAuthentications();

// invoke the operation and iterate over the result
await foreach (IotOperationsBrokerAuthenticationResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    IotOperationsBrokerAuthenticationData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "properties": {
        "authenticationMethods": [
          {
            "method": "Custom",
            "customSettings": {
              "auth": {
                "x509": {
                  "secretRef": "secret-name"
                }
              },
              "caCertConfigMap": "pdecudefqyolvncbus",
              "endpoint": "https://www.example.com",
              "headers": {
                "key8518": "bwityjy"
              }
            },
            "serviceAccountTokenSettings": {
              "audiences": [
                "jqyhyqatuydg"
              ]
            },
            "x509Settings": {
              "authorizationAttributes": {
                "key3384": {
                  "attributes": {
                    "key186": "ucpajramsz"
                  },
                  "subject": "jpgwctfeixitptfgfnqhua"
                }
              },
              "trustedClientCaCert": "vlctsqddl"
            }
          }
        ],
        "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/authentications/resource-name123",
      "name": "lwucizfvtsdpx",
      "type": "kvtilkgcxanlfozrd",
      "systemData": {
        "createdBy": "ssvaslsmudloholronopqyxjcu",
        "createdByType": "User",
        "createdAt": "2024-08-09T18:13:29.389Z",
        "lastModifiedBy": "gnicpuszwd",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2024-08-09T18:13:29.389Z"
      }
    }
  ],
  "nextLink": "https://microsoft.com/a"
}

Definities

Name	Description
BrokerAuthenticationMethod	Brokerverificatiemodus
BrokerAuthenticationProperties	BrokerAuthentication Resource-eigenschappen
BrokerAuthenticationResource	Instantiebrokerverificatieresource
BrokerAuthenticationResourceListResult	Het antwoord van een BrokerAuthenticationResource-lijstbewerking.
BrokerAuthenticatorCustomAuth	Eigenschappen van aangepaste verificatie
BrokerAuthenticatorMethodCustom	Aangepaste methode voor BrokerAuthentication
BrokerAuthenticatorMethods	Set brokerverificatiebeleidsregels. Er wordt slechts één methode ondersteund voor elke vermelding.
BrokerAuthenticatorMethodSat	Serviceaccounttoken voor BrokerAuthentication
BrokerAuthenticatorMethodX509	X509 voor BrokerAuthentication.
BrokerAuthenticatorMethodX509Attributes	BrokerAuthenticatorMethodX509Attributes-eigenschappen.
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
ExtendedLocation	Uitgebreide locatie is een uitbreiding van Azure-locaties. Ze bieden een manier om hun Kubernetes-clusters met Azure ARC te gebruiken als doellocaties voor het implementeren van Azure-servicesexemplaren.
ExtendedLocationType	Het enum definieert het type ExtendedLocation dat is geaccepteerd.
ProvisioningState	De opsomming waarin de status van de resource wordt gedefinieerd.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
X509ManualCertificate	Eigenschappen van X509-certificaatverificatie.

BrokerAuthenticationMethod

Inventarisatie

Brokerverificatiemodus

Waarde	Description
Custom	Aangepaste verificatieconfiguratie.
ServiceAccountToken	ServiceAccountToken-verificatieconfiguratie.
X509	X.509-verificatieconfiguratie.

BrokerAuthenticationProperties

Object

BrokerAuthentication Resource-eigenschappen

Name	Type	Description
authenticationMethods	BrokerAuthenticatorMethods[]	Hiermee definieert u een set Broker-verificatiemethoden die moeten worden gebruikt voor `BrokerListeners`. Voor elk matrixelement wordt één type verificator ondersteund.
provisioningState	ProvisioningState	De status van de laatste bewerking.

BrokerAuthenticationResource

Object

Instantiebrokerverificatieresource

Name	Type	Description
extendedLocation	ExtendedLocation	Edge-locatie van de resource.
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name	string	De naam van de resource
properties	BrokerAuthenticationProperties	De resourcespecifieke eigenschappen voor deze resource.
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

BrokerAuthenticationResourceListResult

Object

Het antwoord van een BrokerAuthenticationResource-lijstbewerking.

Name	Type	Description
nextLink	string (uri)	De koppeling naar de volgende pagina met items
value	BrokerAuthenticationResource[]	De BrokerAuthenticationResource-items op deze pagina

BrokerAuthenticatorCustomAuth

Object

Eigenschappen van aangepaste verificatie

Name	Type	Description
x509	X509ManualCertificate	Details van aangepast verificatietype X509.

BrokerAuthenticatorMethodCustom

Object

Aangepaste methode voor BrokerAuthentication

Name	Type	Description
auth	BrokerAuthenticatorCustomAuth	Optionele verificatie die nodig is voor verificatie met de aangepaste verificatieserver.
caCertConfigMap	string	Optioneel CA-certificaat voor het valideren van het certificaat van de aangepaste verificatieserver.
endpoint	string (uri) pattern: ^https://.*$	Eindpunt van de aangepaste verificatieserver. Moet een HTTPS-eindpunt zijn.
headers	object	Aanvullende HTTP-headers die moeten worden doorgegeven aan de aangepaste verificatieserver.

BrokerAuthenticatorMethods

Object

Set brokerverificatiebeleidsregels. Er wordt slechts één methode ondersteund voor elke vermelding.

Name	Type	Description
customSettings	BrokerAuthenticatorMethodCustom	Aangepaste verificatieconfiguratie.
method	BrokerAuthenticationMethod	Aangepaste verificatieconfiguratie.
serviceAccountTokenSettings	BrokerAuthenticatorMethodSat	ServiceAccountToken-verificatieconfiguratie.
x509Settings	BrokerAuthenticatorMethodX509	X.509-verificatieconfiguratie.

BrokerAuthenticatorMethodSat

Object

Serviceaccounttoken voor BrokerAuthentication

Name	Type	Description
audiences	string[]	Lijst met toegestane doelgroepen.

BrokerAuthenticatorMethodX509

Object

X509 voor BrokerAuthentication.

Name	Type	Default value	Description
authorizationAttributes	<string, BrokerAuthenticatorMethodX509Attributes>		Eigenschappen van X509-autorisatiekenmerken.
trustedClientCaCert	string	client-ca	Naam van de vertrouwde client-CA-certificaatresource.

BrokerAuthenticatorMethodX509Attributes

Object

BrokerAuthenticatorMethodX509Attributes-eigenschappen.

Name	Type	Description
attributes	object	Kenmerkobject.
subject	string	Onderwerp van het kenmerk X509.

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

ExtendedLocation

Object

Uitgebreide locatie is een uitbreiding van Azure-locaties. Ze bieden een manier om hun Kubernetes-clusters met Azure ARC te gebruiken als doellocaties voor het implementeren van Azure-servicesexemplaren.

Name	Type	Description
name	string	De naam van de uitgebreide locatie.
type	ExtendedLocationType	Type of ExtendedLocation.

ExtendedLocationType

Inventarisatie

Het enum definieert het type ExtendedLocation dat is geaccepteerd.

Waarde	Description
CustomLocation	CustomLocation-type

ProvisioningState

Inventarisatie

De opsomming waarin de status van de resource wordt gedefinieerd.

Waarde	Description
Accepted	De resource is geaccepteerd.
Canceled	Het maken van resources is geannuleerd.
Deleting	Resource wordt verwijderd.
Failed	Het maken van resources is mislukt.
Provisioning	De resource wordt ingericht.
Succeeded	De resource is gemaakt.
Updating	Resource wordt bijgewerkt.

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

X509ManualCertificate

Object

Eigenschappen van X509-certificaatverificatie.

Name	Type	Description
secretRef	string	Kubernetes-geheim met een X.509-clientcertificaat. Dit is een verwijzing naar het geheim via een identificatienaam, niet het geheim zelf.

Delen via

Broker Authentication - List By Resource Group

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

BrokerAuthentication_ListByResourceGroup

Voorbeeldaanvraag

Voorbeeldrespons

Definities

BrokerAuthenticationMethod

BrokerAuthenticationProperties

BrokerAuthenticationResource

BrokerAuthenticationResourceListResult

BrokerAuthenticatorCustomAuth

BrokerAuthenticatorMethodCustom

BrokerAuthenticatorMethods

BrokerAuthenticatorMethodSat

BrokerAuthenticatorMethodX509

BrokerAuthenticatorMethodX509Attributes

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedLocation

ExtendedLocationType

ProvisioningState

systemData

X509ManualCertificate

Aanvullende resources