Broker Authorization - Get

서비스:

IoT Operations

API 버전:

2024-11-01

BrokerAuthorizationResource 가져오기

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
authorizationName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	인스턴스 브로커 권한 부여 리소스의 이름
brokerName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	broker의 이름입니다.
instanceName	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)	대상 구독의 ID입니다. 값은 UUID여야 합니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	BrokerAuthorizationResource	Azure 작업이 성공적으로 완료되었습니다.
Other Status Codes	ErrorResponse	예기치 않은 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

BrokerAuthorization_Get

샘플 요청

HTTP

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

Java

/**
 * Samples for BrokerAuthorization Get.
 */
public final class Main {
    /*
     * x-ms-original-file: 2024-11-01/BrokerAuthorization_Get_MaximumSet_Gen.json
     */
    /**
     * Sample code: BrokerAuthorization_Get.
     * 
     * @param manager Entry point to IoTOperationsManager.
     */
    public static void brokerAuthorizationGet(com.azure.resourcemanager.iotoperations.IoTOperationsManager manager) {
        manager.brokerAuthorizations().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_authorization_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_authorization.get(
        resource_group_name="rgiotoperations",
        instance_name="resource-name123",
        broker_name="resource-name123",
        authorization_name="resource-name123",
    )
    print(response)


# x-ms-original-file: 2024-11-01/BrokerAuthorization_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/BrokerAuthorization_Get_MaximumSet_Gen.json
func ExampleBrokerAuthorizationClient_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.NewBrokerAuthorizationClient().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.BrokerAuthorizationClientGetResponse{
	// 	BrokerAuthorizationResource: &armiotoperations.BrokerAuthorizationResource{
	// 		Properties: &armiotoperations.BrokerAuthorizationProperties{
	// 			AuthorizationPolicies: &armiotoperations.AuthorizationConfig{
	// 				Cache: to.Ptr(armiotoperations.OperationalModeEnabled),
	// 				Rules: []*armiotoperations.AuthorizationRule{
	// 					{
	// 						BrokerResources: []*armiotoperations.BrokerResourceRule{
	// 							{
	// 								Method: to.Ptr(armiotoperations.BrokerResourceDefinitionMethodsConnect),
	// 								ClientIDs: []*string{
	// 									to.Ptr("nlc"),
	// 								},
	// 								Topics: []*string{
	// 									to.Ptr("wvuca"),
	// 								},
	// 							},
	// 						},
	// 						Principals: &armiotoperations.PrincipalDefinition{
	// 							Attributes: []map[string]*string{
	// 								map[string]*string{
	// 									"key5526": to.Ptr("nydhzdhbldygqcn"),
	// 								},
	// 							},
	// 							ClientIDs: []*string{
	// 								to.Ptr("smopeaeddsygz"),
	// 							},
	// 							Usernames: []*string{
	// 								to.Ptr("iozngyqndrteikszkbasinzdjtm"),
	// 							},
	// 						},
	// 						StateStoreResources: []*armiotoperations.StateStoreResourceRule{
	// 							{
	// 								KeyType: to.Ptr(armiotoperations.StateStoreResourceKeyTypesPattern),
	// 								Keys: []*string{
	// 									to.Ptr("tkounsqtwvzyaklxjqoerpu"),
	// 								},
	// 								Method: to.Ptr(armiotoperations.StateStoreResourceDefinitionMethodsRead),
	// 							},
	// 						},
	// 					},
	// 				},
	// 			},
	// 			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/authorizations/resource-name123"),
	// 		Name: to.Ptr("anqrqsvrjmlvzkrbuav"),
	// 		Type: to.Ptr("yjlsfarshqoxojvgmy"),
	// 		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

샘플 응답

상태 코드:

200

{
  "properties": {
    "authorizationPolicies": {
      "cache": "Enabled",
      "rules": [
        {
          "brokerResources": [
            {
              "method": "Connect",
              "clientIds": [
                "nlc"
              ],
              "topics": [
                "wvuca"
              ]
            }
          ],
          "principals": {
            "attributes": [
              {
                "key5526": "nydhzdhbldygqcn"
              }
            ],
            "clientIds": [
              "smopeaeddsygz"
            ],
            "usernames": [
              "iozngyqndrteikszkbasinzdjtm"
            ]
          },
          "stateStoreResources": [
            {
              "keyType": "Pattern",
              "keys": [
                "tkounsqtwvzyaklxjqoerpu"
              ],
              "method": "Read"
            }
          ]
        }
      ]
    },
    "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/authorizations/resource-name123",
  "name": "anqrqsvrjmlvzkrbuav",
  "type": "yjlsfarshqoxojvgmy",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

정의

Name	Description
AuthorizationConfig	Broker AuthorizationConfig 속성
AuthorizationRule	AuthorizationConfig 규칙 속성
BrokerAuthorizationProperties	BrokerAuthorization 리소스 속성
BrokerAuthorizationResource	인스턴스 브로커 권한 부여 리소스
BrokerResourceDefinitionMethods	BrokerResourceDefinitionMethods 메서드가 허용됨
BrokerResourceRule	Broker 리소스 규칙 속성입니다. 이렇게 하면 작업 또는 토픽(예: - 메서드)을 나타내는 개체가 정의됩니다. Connect, 메서드. 게시 등
createdByType	리소스를 만든 ID의 형식입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
ExtendedLocation	확장 위치는 Azure 위치의 확장입니다. Azure 서비스 인스턴스를 배포하기 위한 대상 위치로 Azure ARC 지원 Kubernetes 클러스터를 사용하는 방법을 제공합니다.
ExtendedLocationType	허용되는 ExtendedLocation의 열거형 정의 형식입니다.
OperationalMode	모드 속성
PrincipalDefinition	Rule의 PrincipalDefinition 속성
ProvisioningState	리소스의 열거형 정의 상태입니다.
StateStoreResourceDefinitionMethods	StateStoreResourceDefinitionMethods 메서드 허용
StateStoreResourceKeyTypes	StateStoreResourceKeyTypes 속성
StateStoreResourceRule	상태 저장소 리소스 규칙 속성입니다.
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

AuthorizationConfig

Object

Broker AuthorizationConfig 속성

Name	형식	Default value	Description
cache	OperationalMode	Enabled	권한 부여 규칙의 캐싱을 사용하도록 설정합니다.
rules	AuthorizationRule[]		따라야 할 권한 부여 규칙입니다. 규칙이 설정되지 않았지만 권한 부여 리소스가 사용되는 경우 DenyAll을 의미합니다.

AuthorizationRule

Object

AuthorizationConfig 규칙 속성

Name	형식	Description
brokerResources	BrokerResourceRule[]	Broker 메서드 및 토픽에 대한 액세스 권한을 부여합니다.
principals	PrincipalDefinition	다음 속성에 따라 클라이언트에 대한 액세스 권한을 부여합니다.
stateStoreResources	StateStoreResourceRule[]	상태 저장소 리소스에 대한 액세스 권한을 부여합니다.

BrokerAuthorizationProperties

Object

BrokerAuthorization 리소스 속성

Name	형식	Description
authorizationPolicies	AuthorizationConfig	권한 부여 리소스에서 지원하는 권한 부여 정책 목록입니다.
provisioningState	ProvisioningState	마지막 작업의 상태입니다.

BrokerAuthorizationResource

Object

인스턴스 브로커 권한 부여 리소스

Name	형식	Description
extendedLocation	ExtendedLocation	리소스의 에지 위치입니다.
id	string (arm-id)	리소스에 대한 정규화된 리소스 ID입니다. 예: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	리소스의 이름
properties	BrokerAuthorizationProperties	이 리소스에 대한 리소스별 속성입니다.
systemData	systemData	createdBy 및 modifiedBy 정보가 포함된 Azure Resource Manager 메타데이터입니다.
type	string	리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

BrokerResourceDefinitionMethods

열거형

BrokerResourceDefinitionMethods 메서드가 허용됨

값	Description
Connect	Broker에 연결할 수 있습니다.
Publish	Broker에 게시 허용
Subscribe	Broker에 대한 허용된 구독

BrokerResourceRule

Object

Broker 리소스 규칙 속성입니다. 이렇게 하면 작업 또는 토픽(예: - 메서드)을 나타내는 개체가 정의됩니다. Connect, 메서드. 게시 등

Name	형식	Description
clientIds	string[]	클라이언트와 일치하는 클라이언트 ID 목록입니다. 클라이언트 ID는 대/소문자를 구분하며 연결 중에 클라이언트가 제공한 클라이언트 ID와 일치해야 합니다. 메서드가 Connect인 경우 이 하위 필드를 설정할 수 있습니다.
method	BrokerResourceDefinitionMethods	Broker 메서드(예: Connect, Subscribe 또는 Publish)에 대한 액세스 권한을 부여합니다.
topics	string[]	클라이언트가 게시하거나 구독할 수 있는 토픽과 일치하는 토픽 또는 토픽 패턴 목록입니다. 이 하위 필드는 메서드가 게시 또는 구독인 경우 필요합니다.

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

ExtendedLocation

Object

확장 위치는 Azure 위치의 확장입니다. Azure 서비스 인스턴스를 배포하기 위한 대상 위치로 Azure ARC 지원 Kubernetes 클러스터를 사용하는 방법을 제공합니다.

Name	형식	Description
name	string	확장된 위치의 이름입니다.
type	ExtendedLocationType	ExtendedLocation의 형식입니다.

ExtendedLocationType

열거형

허용되는 ExtendedLocation의 열거형 정의 형식입니다.

값	Description
CustomLocation	CustomLocation 유형

OperationalMode

열거형

모드 속성

값	Description
Disabled	사용 안 함은 False와 동일합니다.
Enabled	사용은 True와 동일합니다.

PrincipalDefinition

Object

Rule의 PrincipalDefinition 속성

Name	형식	Description
attributes	object[]	클라이언트의 특성과 일치하는 키-값 쌍의 목록입니다. 특성은 대/소문자를 구분하며 인증 중에 클라이언트에서 제공하는 특성과 일치해야 합니다.
clientIds	string[]	클라이언트와 일치하는 클라이언트 ID 목록입니다. 클라이언트 ID는 대/소문자를 구분하며 연결 중에 클라이언트가 제공한 클라이언트 ID와 일치해야 합니다.
usernames	string[]	클라이언트와 일치하는 사용자 이름 목록입니다. 사용자 이름은 대/소문자를 구분하며 인증 중에 클라이언트에서 제공하는 사용자 이름과 일치해야 합니다.

ProvisioningState

열거형

리소스의 열거형 정의 상태입니다.

값	Description
Accepted	리소스가 수락되었습니다.
Canceled	리소스 만들기가 취소되었습니다.
Deleting	리소스가 삭제되고 있습니다.
Failed	리소스를 만들지 못했습니다.
Provisioning	리소스가 프로비전되고 있습니다.
Succeeded	리소스가 만들어졌습니다.
Updating	리소스가 업데이트되고 있습니다.

StateStoreResourceDefinitionMethods

열거형

StateStoreResourceDefinitionMethods 메서드 허용

값	Description
Read	스토어에서 Get/KeyNotify
ReadWrite	스토어에서 모든 작업 허용 - Get/KeyNotify/Set/Delete
Write	스토어에서 설정/삭제

StateStoreResourceKeyTypes

열거형

StateStoreResourceKeyTypes 속성

값	Description
Binary	키 형식 - 이진
Pattern	키 형식 - 패턴
String	키 형식 - 문자열

StateStoreResourceRule

Object

상태 저장소 리소스 규칙 속성입니다.

Name	형식	Description
keyType	StateStoreResourceKeyTypes	허용되는 keyTypes 패턴, 문자열, 이진입니다. 일치에 사용되는 키 형식입니다. 예를 들어 패턴은 키를 glob 스타일 패턴과 일치시키려고 하고 문자열 검사 키는 키에 제공된 값과 같습니다.
keys	string[]	정의된 해당 보안 주체에 대한 상태 저장소 키에 대한 액세스 권한을 부여합니다. 키 형식이 패턴 집합 glob 스타일 패턴인 경우(예: '', 'clients/').
method	StateStoreResourceDefinitionMethods	Read, Write 및 ReadWrite 액세스 수준에 대한 액세스 권한을 부여합니다.

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string (date-time)	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string (date-time)	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.