Broker Authentication - Get

Başvuru

Hizmet:: IoT Operations

API Sürümü:: 2025-04-01

BrokerAuthenticationResource alma

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
authenticationName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	Örnek aracısı kimlik doğrulama kaynağının adı
brokerName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	Aracı adı.
instanceName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	Örneğin adı.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	BrokerAuthenticationResource	Azure işlemi başarıyla tamamlandı.
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

BrokerAuthentication_Get

Örnek isteği

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=2025-04-01

Örnek yanıt

Durum kodu:: 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"
  }
}

Tanımlar

Name	Description
BrokerAuthenticationMethod	Aracı Kimlik Doğrulama Modu
BrokerAuthenticationProperties	BrokerAuthentication Kaynak özellikleri
BrokerAuthenticationResource	Örnek aracısı kimlik doğrulama kaynağı
BrokerAuthenticatorCustomAuth	Özel Kimlik Doğrulama özellikleri
BrokerAuthenticatorMethodCustom	BrokerAuthentication için özel yöntem
BrokerAuthenticatorMethods	Aracı kimlik doğrulama ilkeleri kümesi. Her giriş için yalnızca bir yöntem desteklenir.
BrokerAuthenticatorMethodSat	BrokerAuthentication için Hizmet Hesabı Belirteci
BrokerAuthenticatorMethodX509	BrokerAuthentication için X509.
BrokerAuthenticatorMethodX509Attributes	BrokerAuthenticatorMethodX509Attributes özellikleri.
createdByType	Kaynağı oluşturan kimliğin türü.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
ExtendedLocation	Genişletilmiş konum, Azure konumlarının bir uzantısıdır. Azure ARC özellikli Kubernetes kümelerini Azure hizmet örneklerini dağıtmak için hedef konumlar olarak kullanmak için bir yol sağlar.
ExtendedLocationType	ExtendedLocation türünü tanımlayan sabit listesi kabul edildi.
ProvisioningState	Kaynağın durumunu tanımlayan sabit listesi.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
X509ManualCertificate	X509 Sertifika Kimlik Doğrulaması özellikleri.

BrokerAuthenticationMethod

Listeleme

Aracı Kimlik Doğrulama Modu

Değer	Description
Custom	Özel kimlik doğrulama yapılandırması.
ServiceAccountToken	ServiceAccountToken kimlik doğrulaması yapılandırması.
X509	X.509 kimlik doğrulaması yapılandırması.

BrokerAuthenticationProperties

Object

BrokerAuthentication Kaynak özellikleri

Name	Tür	Description
authenticationMethods	BrokerAuthenticatorMethods[]	`BrokerListeners`üzerinde kullanılacak bir aracı kimlik doğrulama yöntemleri kümesini tanımlar. Her dizi öğesi için bir doğrulayıcı türü desteklenir.
provisioningState	ProvisioningState	Son işlemin durumu.

BrokerAuthenticationResource

Object

Örnek aracısı kimlik doğrulama kaynağı

Name	Tür	Description
extendedLocation	ExtendedLocation	Kaynağın kenar konumu.
id	string (arm-id)	Kaynağın tam kaynak kimliği. Örneğin, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Kaynağın adı
properties	BrokerAuthenticationProperties	Bu kaynağın kaynağa özgü özellikleri.
systemData	systemData	createdBy ve modifiedBy bilgilerini içeren Azure Resource Manager meta verileri.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

BrokerAuthenticatorCustomAuth

Object

Özel Kimlik Doğrulama özellikleri

Name	Tür	Description
x509	X509ManualCertificate	X509 Özel Kimlik Doğrulaması türü ayrıntıları.

BrokerAuthenticatorMethodCustom

Object

BrokerAuthentication için özel yöntem

Name	Tür	Description
auth	BrokerAuthenticatorCustomAuth	Özel kimlik doğrulama sunucusuyla kimlik doğrulaması için isteğe bağlı kimlik doğrulaması gerekir.
caCertConfigMap	string	Özel kimlik doğrulama sunucusunun sertifikasını doğrulamak için isteğe bağlı CA sertifikası.
endpoint	string (uri) pattern: ^https://.*$	Özel kimlik doğrulama sunucusunun uç noktası. HTTPS uç noktası olmalıdır.
headers	object	Özel kimlik doğrulama sunucusuna geçirmek için ek HTTP üst bilgileri.

BrokerAuthenticatorMethods

Object

Aracı kimlik doğrulama ilkeleri kümesi. Her giriş için yalnızca bir yöntem desteklenir.

Name	Tür	Description
customSettings	BrokerAuthenticatorMethodCustom	Özel kimlik doğrulama yapılandırması.
method	BrokerAuthenticationMethod	Özel kimlik doğrulama yapılandırması.
serviceAccountTokenSettings	BrokerAuthenticatorMethodSat	ServiceAccountToken kimlik doğrulaması yapılandırması.
x509Settings	BrokerAuthenticatorMethodX509	X.509 kimlik doğrulaması yapılandırması.

BrokerAuthenticatorMethodSat

Object

BrokerAuthentication için Hizmet Hesabı Belirteci

Name	Tür	Description
audiences	string[]	İzin verilen hedef kitlenin listesi.

BrokerAuthenticatorMethodX509

Object

BrokerAuthentication için X509.

Name	Tür	Default value	Description
authorizationAttributes	<string, BrokerAuthenticatorMethodX509Attributes>		X509 yetkilendirme öznitelikleri özellikleri.
trustedClientCaCert	string	client-ca	Güvenilen istemci ca sertifika kaynağının adı.

BrokerAuthenticatorMethodX509Attributes

Object

BrokerAuthenticatorMethodX509Attributes özellikleri.

Name	Tür	Description
attributes	object	Öznitelikler nesnesi.
subject	string	X509 özniteliğinin konusu.

createdByType

Listeleme

Kaynağı oluşturan kimliğin türü.

Değer	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Object

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Object

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

ExtendedLocation

Object

Genişletilmiş konum, Azure konumlarının bir uzantısıdır. Azure ARC özellikli Kubernetes kümelerini Azure hizmet örneklerini dağıtmak için hedef konumlar olarak kullanmak için bir yol sağlar.

Name	Tür	Description
name	string	Genişletilmiş konumun adı.
type	ExtendedLocationType	ExtendedLocation türü.

ExtendedLocationType

Listeleme

ExtendedLocation türünü tanımlayan sabit listesi kabul edildi.

Değer	Description
CustomLocation	CustomLocation türü

ProvisioningState

Listeleme

Kaynağın durumunu tanımlayan sabit listesi.

Değer	Description
Accepted	Kaynak Kabul Edildi.
Canceled	Kaynak oluşturma işlemi iptal edildi.
Deleting	Kaynak Siliniyor.
Failed	Kaynak oluşturulamadı.
Provisioning	Kaynak sağlanıyor.
Succeeded	Kaynak oluşturuldu.
Updating	Kaynak Güncelleştiriliyor.

systemData

Object

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string (date-time)	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string (date-time)	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimlik türü.

X509ManualCertificate

Object

X509 Sertifika Kimlik Doğrulaması özellikleri.

Name	Tür	Description
secretRef	string	X.509 istemci sertifikası içeren Kubernetes gizli dizisi. Bu, gizli dizinin kendisi değil, tanımlayıcı bir ad aracılığıyla gizli diziye yapılan bir başvurudur.

Aracılığıyla paylaş

Broker Authentication - Get

URI Parametreleri

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

BrokerAuthentication_Get

Örnek isteği

Örnek yanıt

Tanımlar

BrokerAuthenticationMethod

BrokerAuthenticationProperties

BrokerAuthenticationResource

BrokerAuthenticatorCustomAuth

BrokerAuthenticatorMethodCustom

BrokerAuthenticatorMethods

BrokerAuthenticatorMethodSat

BrokerAuthenticatorMethodX509

BrokerAuthenticatorMethodX509Attributes

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedLocation

ExtendedLocationType

ProvisioningState

systemData

X509ManualCertificate