Broker Authorization - Get

Служба:

IoT Operations

Версия API:

2024-11-01

Получение брокераAuthorizationResource

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
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]$	Имя брокера.
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)	Идентификатор целевой подписки. Значение должно быть UUID.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	BrokerAuthorizationResource	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
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"
  }
}

Определения

Имя	Описание
AuthorizationConfig	Свойства AuthorizationConfig брокера
AuthorizationRule	Свойства правила AuthorizationConfig
BrokerAuthorizationProperties	Свойства ресурса BrokerAuthorization
BrokerAuthorizationResource	Ресурс авторизации брокера экземпляров
BrokerResourceDefinitionMethods	Разрешенные методы BrokerResourceDefinitionMethods
BrokerResourceRule	Свойства правила ресурсов брокера. Это определяет объекты, представляющие действия или разделы, например метод. Подключение, метод. Публикация и т. д.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
ExtendedLocation	Расширенное расположение — это расширение расположений Azure. Они предоставляют возможность использовать кластеры Kubernetes с поддержкой Azure ARC в качестве целевых расположений для развертывания экземпляров служб Azure.
ExtendedLocationType	Перечисление, определяющее тип extendedLocation, принятое.
OperationalMode	Свойства режима
PrincipalDefinition	Свойства PrincipalDefinition правила
ProvisioningState	Перечисление, определяющее состояние ресурса.
StateStoreResourceDefinitionMethods	Разрешенные методы StateStoreResourceDefinitionMethods
StateStoreResourceKeyTypes	Свойства StateStoreResourceKeyTypes
StateStoreResourceRule	Свойства правила ресурсов хранилища состояний.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

AuthorizationConfig

Object

Свойства AuthorizationConfig брокера

Имя	Тип	Default value	Описание
cache	OperationalMode	Enabled	Включите кэширование правил авторизации.
rules	AuthorizationRule[]		Следуйте правилам авторизации. Если правило не задано, но используется ресурс авторизации, который будет означать DenyAll.

AuthorizationRule

Object

Свойства правила AuthorizationConfig

Имя	Тип	Описание
brokerResources	BrokerResourceRule[]	Предоставление доступа к методам и темам брокера.
principals	PrincipalDefinition	Предоставление доступа клиентам на основе следующих свойств.
stateStoreResources	StateStoreResourceRule[]	Предоставление доступа к ресурсам хранилища состояний.

BrokerAuthorizationProperties

Object

Свойства ресурса BrokerAuthorization

Имя	Тип	Описание
authorizationPolicies	AuthorizationConfig	Список политик авторизации, поддерживаемых ресурсом авторизации.
provisioningState	ProvisioningState	Состояние последней операции.

BrokerAuthorizationResource

Object

Ресурс авторизации брокера экземпляров

Имя	Тип	Описание
extendedLocation	ExtendedLocation	Пограничное расположение ресурса.
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса
properties	BrokerAuthorizationProperties	Свойства, относящиеся к ресурсу, для этого ресурса.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

BrokerResourceDefinitionMethods

Перечисление

Разрешенные методы BrokerResourceDefinitionMethods

Значение	Описание
Connect	Разрешено подключение к брокеру
Publish	Разрешенная публикация в брокере
Subscribe	Разрешенная подписка на брокер

BrokerResourceRule

Object

Свойства правила ресурсов брокера. Это определяет объекты, представляющие действия или разделы, например метод. Подключение, метод. Публикация и т. д.

Имя	Тип	Описание
clientIds	string[]	Список идентификаторов клиентов, соответствующих клиентам. Идентификаторы клиентов чувствительны к регистру и должны соответствовать идентификаторам клиента, предоставляемым клиентами во время подключения. Это подфилд может быть задано, если метод connect.
method	BrokerResourceDefinitionMethods	Предоставление доступа к методу Broker (например, Connect, Subscribe или Publish).
topics	string[]	Список разделов или шаблонов тем, которые соответствуют темам, на которые клиенты могут публиковать или подписываться. Это подполея требуется, если метод является публикацией или подпиской.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

ExtendedLocation

Object

Расширенное расположение — это расширение расположений Azure. Они предоставляют возможность использовать кластеры Kubernetes с поддержкой Azure ARC в качестве целевых расположений для развертывания экземпляров служб Azure.

Имя	Тип	Описание
name	string	Имя расширенного расположения.
type	ExtendedLocationType	Тип ExtendedLocation.

ExtendedLocationType

Перечисление

Перечисление, определяющее тип extendedLocation, принятое.

Значение	Описание
CustomLocation	Тип CustomLocation

OperationalMode

Перечисление

Свойства режима

Значение	Описание
Disabled	Отключенный эквивалент false.
Enabled	Включено эквивалентно True

PrincipalDefinition

Object

Свойства PrincipalDefinition правила

Имя	Тип	Описание
attributes	object[]	Список пар "ключ-значение", которые соответствуют атрибутам клиентов. Атрибуты чувствительны к регистру и должны соответствовать атрибутам, предоставляемым клиентами во время проверки подлинности.
clientIds	string[]	Список идентификаторов клиентов, соответствующих клиентам. Идентификаторы клиентов чувствительны к регистру и должны соответствовать идентификаторам клиента, предоставляемым клиентами во время подключения.
usernames	string[]	Список имен пользователей, соответствующих клиентам. Имена пользователей чувствительны к регистру и должны соответствовать именам пользователей, предоставляемым клиентами во время проверки подлинности.

ProvisioningState

Перечисление

Перечисление, определяющее состояние ресурса.

Значение	Описание
Accepted	Ресурс принят.
Canceled	Создание ресурсов было отменено.
Deleting	Ресурс удаляется.
Failed	Не удалось создать ресурс.
Provisioning	Ресурс подготавливается.
Succeeded	Ресурс создан.
Updating	Ресурс обновляется.

StateStoreResourceDefinitionMethods

Перечисление

Разрешенные методы StateStoreResourceDefinitionMethods

Значение	Описание
Read	Get/KeyNotify из Магазина
ReadWrite	Разрешены все операции в Магазине: Get/KeyNotify/Set/Delete
Write	Установка и удаление в Магазине

StateStoreResourceKeyTypes

Перечисление

Свойства StateStoreResourceKeyTypes

Значение	Описание
Binary	Тип ключа — двоичный
Pattern	Тип ключа — шаблон
String	Тип ключа — строка

StateStoreResourceRule

Object

Свойства правила ресурсов хранилища состояний.

Имя	Тип	Описание
keyType	StateStoreResourceKeyTypes	Разрешен шаблон keyTypes, строка, двоичный файл. Тип ключа, используемый для сопоставления, например шаблон пытается сопоставить ключ с шаблоном стиля glob и ключом проверки строки равен значению, предоставленному в ключах.
keys	string[]	Предоставление доступа к ключам хранилища состояний для соответствующих субъектов. Если тип ключа — шаблон набора шаблонов в стиле glob (например, "", "клиенты/".
method	StateStoreResourceDefinitionMethods	Предоставление доступа для Read, Write и уровня доступа ReadWrite.

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.