Broker Authentication - Get

Service:

IoT Operations

API Version:

2024-11-01

Get a BrokerAuthenticationResource

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

URI Parameters

Name	In	Required	Type	Description
authenticationName	path	True	string	Name of Instance broker authentication resource Regex pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$
brokerName	path	True	string	Name of broker. Regex pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$
instanceName	path	True	string	Name of instance. Regex pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	BrokerAuthenticationResource	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

BrokerAuthentication_Get

Sample request

HTTP

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

Java

/**
 * Samples for BrokerAuthentication Get.
 */
public final class Main {
    /*
     * x-ms-original-file: 2024-11-01/BrokerAuthentication_Get_MaximumSet_Gen.json
     */
    /**
     * Sample code: BrokerAuthentication_Get.
     * 
     * @param manager Entry point to IoTOperationsManager.
     */
    public static void brokerAuthenticationGet(com.azure.resourcemanager.iotoperations.IoTOperationsManager manager) {
        manager.brokerAuthentications().getWithResponse("rgiotoperations", "resource-name123", "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

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_authentication_get_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.get(
        resource_group_name="rgiotoperations",
        instance_name="resource-name123",
        broker_name="resource-name123",
        authentication_name="resource-name123",
    )
    print(response)


# x-ms-original-file: 2024-11-01/BrokerAuthentication_Get_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/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotoperations/armiotoperations"
)

// Generated from example definition: 2024-11-01/BrokerAuthentication_Get_MaximumSet_Gen.json
func ExampleBrokerAuthenticationClient_Get() {
	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)
	}
	res, err := clientFactory.NewBrokerAuthenticationClient().Get(ctx, "rgiotoperations", "resource-name123", "resource-name123", "resource-name123", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.BrokerAuthenticationClientGetResponse{
	// 	BrokerAuthenticationResource: &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}()),
	// 		},
	// 	},
	// }
}

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

Sample response

Status code:

200

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

Definitions

Name	Description
BrokerAuthenticationMethod	Broker Authentication Mode
BrokerAuthenticationProperties	BrokerAuthentication Resource properties
BrokerAuthenticationResource	Instance broker authentication resource
BrokerAuthenticatorCustomAuth	Custom Authentication properties
BrokerAuthenticatorMethodCustom	Custom method for BrokerAuthentication
BrokerAuthenticatorMethods	Set of broker authentication policies. Only one method is supported for each entry.
BrokerAuthenticatorMethodSat	Service Account Token for BrokerAuthentication
BrokerAuthenticatorMethodX509	X509 for BrokerAuthentication.
BrokerAuthenticatorMethodX509Attributes	BrokerAuthenticatorMethodX509Attributes properties.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExtendedLocation	Extended location is an extension of Azure locations. They provide a way to use their Azure ARC enabled Kubernetes clusters as target locations for deploying Azure services instances.
ExtendedLocationType	The enum defining type of ExtendedLocation accepted.
ProvisioningState	The enum defining status of resource.
systemData	Metadata pertaining to creation and last modification of the resource.
X509ManualCertificate	X509 Certificate Authentication properties.

BrokerAuthenticationMethod

Broker Authentication Mode

Name	Type	Description
Custom	string	Custom authentication configuration.
ServiceAccountToken	string	ServiceAccountToken authentication configuration.
X509	string	X.509 authentication configuration.

BrokerAuthenticationProperties

BrokerAuthentication Resource properties

Name	Type	Description
authenticationMethods	BrokerAuthenticatorMethods[]	Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported.
provisioningState	ProvisioningState	The status of the last operation.

BrokerAuthenticationResource

Instance broker authentication resource

Name	Type	Description
extendedLocation	ExtendedLocation	Edge location of the resource.
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	BrokerAuthenticationProperties	The resource-specific properties for this resource.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

BrokerAuthenticatorCustomAuth

Custom Authentication properties

Name	Type	Description
x509	X509ManualCertificate	X509 Custom Auth type details.

BrokerAuthenticatorMethodCustom

Custom method for BrokerAuthentication

Name	Type	Description
auth	BrokerAuthenticatorCustomAuth	Optional authentication needed for authenticating with the custom authentication server.
caCertConfigMap	string	Optional CA certificate for validating the custom authentication server's certificate.
endpoint	string	Endpoint of the custom authentication server. Must be an HTTPS endpoint.
headers	object	Additional HTTP headers to pass to the custom authentication server.

BrokerAuthenticatorMethods

Set of broker authentication policies. Only one method is supported for each entry.

Name	Type	Description
customSettings	BrokerAuthenticatorMethodCustom	Custom authentication configuration.
method	BrokerAuthenticationMethod	Custom authentication configuration.
serviceAccountTokenSettings	BrokerAuthenticatorMethodSat	ServiceAccountToken authentication configuration.
x509Settings	BrokerAuthenticatorMethodX509	X.509 authentication configuration.

BrokerAuthenticatorMethodSat

Service Account Token for BrokerAuthentication

Name	Type	Description
audiences	string[]	List of allowed audience.

BrokerAuthenticatorMethodX509

X509 for BrokerAuthentication.

Name	Type	Default value	Description
authorizationAttributes	<string,  BrokerAuthenticatorMethodX509Attributes>		X509 authorization attributes properties.
trustedClientCaCert	string	client-ca	Name of the trusted client ca cert resource.

BrokerAuthenticatorMethodX509Attributes

BrokerAuthenticatorMethodX509Attributes properties.

Name	Type	Description
attributes	object	Attributes object.
subject	string	Subject of the X509 attribute.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ExtendedLocation

Extended location is an extension of Azure locations. They provide a way to use their Azure ARC enabled Kubernetes clusters as target locations for deploying Azure services instances.

Name	Type	Description
name	string	The name of the extended location.
type	ExtendedLocationType	Type of ExtendedLocation.

ExtendedLocationType

The enum defining type of ExtendedLocation accepted.

Name	Type	Description
CustomLocation	string	CustomLocation type

ProvisioningState

The enum defining status of resource.

Name	Type	Description
Accepted	string	Resource has been Accepted.
Canceled	string	Resource creation was canceled.
Deleting	string	Resource is Deleting.
Failed	string	Resource creation failed.
Provisioning	string	Resource is getting provisioned.
Succeeded	string	Resource has been created.
Updating	string	Resource is Updating.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

X509ManualCertificate

X509 Certificate Authentication properties.

Name	Type	Description
secretRef	string	Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself.