Broker Authentication - Update

Reference

Služba:: IoT MQ

Verze rozhraní API:: 2023-10-04-preview

Aktualizace zprostředkovatele BrokerAuthenticationResource

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/broker/{brokerName}/authentication/{authenticationName}?api-version=2023-10-04-preview

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
authenticationName	path	True	string	Název prostředku zprostředkovatele nebo ověřování MQ Vzor regulárního výrazu: `^[a-zA-Z0-9-]{3,24}$`
brokerName	path	True	string	Název prostředku zprostředkovatele MQ Vzor regulárního výrazu: `^[a-zA-Z0-9-]{3,24}$`
mqName	path	True	string	Název prostředku MQ Vzor regulárního výrazu: `^[a-zA-Z0-9-]{3,24}$`
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
properties.authenticationMethods	BrokerAuthenticatorMethods[]	Seznam metod ověřování podporovaných ověřovacím prostředkem Pro každý prvek pole POZNÁMKA – podporuje se pouze typ ověřovacího objektu výčtu.
properties.listenerRef	string[]	Pole prostředků naslouchacího procesu, které podporuje.
tags	object	Značky prostředků.

Odpovědi

Name	Typ	Description
200 OK	BrokerAuthenticationResource	Operace Azure se úspěšně dokončila.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

BrokerAuthentication_Update

Ukázkový požadavek

HTTP

PATCH https://management.azure.com/subscriptions/2408F1A7-C077-406C-814C-FBD93E129C00/resourceGroups/rgiotoperationsmq/providers/Microsoft.IoTOperationsMQ/mq/--2-yu7-a--s-6/broker/-18XI--g-3/authentication/J1-GL1ColXv?api-version=2023-10-04-preview

{
  "tags": {},
  "properties": {
    "authenticationMethods": [
      {
        "custom": {
          "auth": {
            "x509": {
              "keyVault": {
                "vault": {
                  "credentials": {
                    "servicePrincipalLocalSecretName": "wuimjwpbhoglbsxxa"
                  },
                  "directoryId": "eyjniptiykzcgbzok",
                  "name": "lxmwfan"
                },
                "vaultCaChainSecret": {
                  "name": "bmectskddmpjxnsogwooexj",
                  "version": "unjfbf"
                },
                "vaultCert": {
                  "name": "bmectskddmpjxnsogwooexj",
                  "version": "unjfbf"
                }
              },
              "secretName": "dordbwjewnqkhfd"
            }
          },
          "caCertConfigMap": "diufihyysdcosgy",
          "endpoint": "yy",
          "headers": {}
        },
        "sat": {
          "audiences": [
            "fiyitxutbuuhwtltukyjacads"
          ]
        },
        "svid": {
          "agentSocketPath": "gnyowebmeaj",
          "identityMaxRetry": 4031184731,
          "identityWaitRetryMs": 2243705844935085600
        },
        "usernamePassword": {
          "keyVault": {
            "vault": {
              "credentials": {
                "servicePrincipalLocalSecretName": "wuimjwpbhoglbsxxa"
              },
              "directoryId": "eyjniptiykzcgbzok",
              "name": "lxmwfan"
            },
            "vaultSecret": {
              "name": "bmectskddmpjxnsogwooexj",
              "version": "unjfbf"
            }
          },
          "secretName": "blk"
        },
        "x509": {
          "attributes": {
            "keyVault": {
              "vault": {
                "credentials": {
                  "servicePrincipalLocalSecretName": "wuimjwpbhoglbsxxa"
                },
                "directoryId": "eyjniptiykzcgbzok",
                "name": "lxmwfan"
              },
              "vaultSecret": {
                "name": "bmectskddmpjxnsogwooexj",
                "version": "unjfbf"
              }
            },
            "secretName": "ybcke"
          },
          "trustedClientCaCertConfigMap": "udidafmnpt"
        }
      }
    ],
    "listenerRef": [
      "johyupxmkijmdmc"
    ]
  }
}

Ukázková odpověď

Stavový kód:: 200

{
  "properties": {
    "authenticationMethods": [
      {
        "custom": {
          "auth": {
            "x509": {
              "keyVault": {
                "vault": {
                  "credentials": {
                    "servicePrincipalLocalSecretName": "wuimjwpbhoglbsxxa"
                  },
                  "directoryId": "eyjniptiykzcgbzok",
                  "name": "lxmwfan"
                },
                "vaultCaChainSecret": {
                  "name": "bmectskddmpjxnsogwooexj",
                  "version": "unjfbf"
                },
                "vaultCert": {
                  "name": "bmectskddmpjxnsogwooexj",
                  "version": "unjfbf"
                }
              },
              "secretName": "dordbwjewnqkhfd"
            }
          },
          "caCertConfigMap": "diufihyysdcosgy",
          "endpoint": "yy",
          "headers": {}
        },
        "sat": {
          "audiences": [
            "fiyitxutbuuhwtltukyjacads"
          ]
        },
        "svid": {
          "agentSocketPath": "gnyowebmeaj",
          "identityMaxRetry": 4031184731,
          "identityWaitRetryMs": 2243705844935085600
        },
        "usernamePassword": {
          "keyVault": {
            "vault": {
              "credentials": {
                "servicePrincipalLocalSecretName": "wuimjwpbhoglbsxxa"
              },
              "directoryId": "eyjniptiykzcgbzok",
              "name": "lxmwfan"
            },
            "vaultSecret": {
              "name": "bmectskddmpjxnsogwooexj",
              "version": "unjfbf"
            }
          },
          "secretName": "blk"
        },
        "x509": {
          "attributes": {
            "keyVault": {
              "vault": {
                "credentials": {
                  "servicePrincipalLocalSecretName": "wuimjwpbhoglbsxxa"
                },
                "directoryId": "eyjniptiykzcgbzok",
                "name": "lxmwfan"
              },
              "vaultSecret": {
                "name": "bmectskddmpjxnsogwooexj",
                "version": "unjfbf"
              }
            },
            "secretName": "ybcke"
          },
          "trustedClientCaCertConfigMap": "udidafmnpt"
        }
      }
    ],
    "listenerRef": [
      "johyupxmkijmdmc"
    ],
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "an",
    "type": "CustomLocation"
  },
  "tags": {},
  "location": "vtxegvaeqwyupplnm",
  "id": "rtmmdnvzvrabsmvmhdm",
  "name": "ktgtbdoqrmk",
  "type": "djuvudmbmryh",
  "systemData": {
    "createdBy": "lsch",
    "createdByType": "User",
    "createdAt": "2023-10-06T15:04:36.253Z",
    "lastModifiedBy": "moncedixbtiffwcevatm",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2023-10-06T15:04:36.256Z"
  }
}

Definice

Name	Description
BrokerAuthenticationResource	Prostředek pro ověřování nebo zprostředkovatel MQ
BrokerAuthenticationResourceUpdate	Typ použitý pro operace aktualizace BrokerAuthenticationResource.
BrokerAuthenticatorCustomAuth	Vlastní vlastnosti ověřování
BrokerAuthenticatorCustomAuthX509	Vlastnosti vlastního ověřování X509 POZNÁMKA: Najednou se podporuje pouze typ authenticatoru výčtu.
BrokerAuthenticatorMethodCustom	Vlastní metoda pro BrokerAuthentication
BrokerAuthenticatorMethods	Kolekce různých metod CrdAuthenticator prostředku zprostředkovatele. POZNÁMKA: Výčet – Pro každou položku je podporována pouze jedna metoda.
BrokerAuthenticatorMethodSat	Token účtu služby pro BrokerAuthentication
BrokerAuthenticatorMethodSvid	SVID pro BrokerAuthentication
BrokerAuthenticatorMethodUsernamePassword	Uživatelské jménoPassword pro BrokerAuthentication
BrokerAuthenticatorMethodX509	X509 pro BrokerAuthentication.
BrokerAuthenticatorMethodX509Attributes	BrokerAuthenticatorMethodX509Attributes – vlastnosti. POZNÁMKA: Typ výčtu je podporován pouze najednou.
createdByType	Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě
ErrorResponse	Chybová odpověď
ExtendedLocationProperty	ExtendedLocation – vlastnosti
ExtendedLocationType	Výčet definující typ ExtendedLocation byl přijat.
KeyVaultCertificateProperties	Vlastnosti certifikátu služby KeyVault
KeyVaultConnectionProperties	Vlastnosti služby KeyVault
KeyVaultCredentialsProperties	Vlastnosti přihlašovacích údajů služby KeyVault. POZNÁMKA: V budoucnu to bude ENUM.
KeyVaultSecretObject	Vlastnosti objektu tajného kódu služby Key Vault
KeyVaultSecretProperties	Vlastnosti tajného kódu služby Key Vault
ProvisioningState	Výčet definující stav prostředku.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

BrokerAuthenticationResource

Prostředek pro ověřování nebo zprostředkovatel MQ

Name	Typ	Description
extendedLocation	ExtendedLocationProperty	Rozšířené umístění
id	string	Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
location	string	Geografické umístění, kde se prostředek nachází
name	string	Název prostředku
properties.authenticationMethods	BrokerAuthenticatorMethods[]	Seznam metod ověřování podporovaných ověřovacím prostředkem Pro každý prvek pole POZNÁMKA – podporuje se pouze typ ověřovacího objektu výčtu.
properties.listenerRef	string[]	Pole prostředků naslouchacího procesu, které podporuje.
properties.provisioningState	ProvisioningState	Stav poslední operace.
systemData	systemData	Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.
tags	object	Značky prostředků.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

BrokerAuthenticationResourceUpdate

Typ použitý pro operace aktualizace BrokerAuthenticationResource.

Name	Typ	Description
properties.authenticationMethods	BrokerAuthenticatorMethods[]	Seznam metod ověřování podporovaných ověřovacím prostředkem Pro každý prvek pole POZNÁMKA – podporuje se pouze typ ověřovacího objektu výčtu.
properties.listenerRef	string[]	Pole prostředků naslouchacího procesu, které podporuje.
tags	object	Značky prostředků.

BrokerAuthenticatorCustomAuth

Vlastní vlastnosti ověřování

Name	Typ	Description
x509	BrokerAuthenticatorCustomAuthX509	Podrobnosti o vlastním typu ověřování X509

BrokerAuthenticatorCustomAuthX509

Vlastnosti vlastního ověřování X509 POZNÁMKA: Najednou se podporuje pouze typ authenticatoru výčtu.

Name	Typ	Description
keyVault	KeyVaultCertificateProperties	Vlastnosti tajného kódu X509 služby KeyVault.
secretName	string	Tajný klíč, ve kterém jsou uložené podrobnosti o certifikátu.

BrokerAuthenticatorMethodCustom

Vlastní metoda pro BrokerAuthentication

Name	Typ	Description
auth	BrokerAuthenticatorCustomAuth	Metoda ověřování vlastního zprostředkovatele
caCertConfigMap	string	Mapa konfigurace certifikátu certifikační autority, která se má použít.
endpoint	string	Koncový bod, ke kterému se chcete připojit.
headers	object	Konfigurační hlavičky, které se mají použít.

BrokerAuthenticatorMethods

Kolekce různých metod CrdAuthenticator prostředku zprostředkovatele. POZNÁMKA: Výčet – Pro každou položku je podporována pouze jedna metoda.

Name	Typ	Description
custom	BrokerAuthenticatorMethodCustom	Vlastní metoda ověřování.
sat	BrokerAuthenticatorMethodSat	Metoda tokenu účtu služby.
svid	BrokerAuthenticatorMethodSvid	Metoda tokenu účtu služby.
usernamePassword	BrokerAuthenticatorMethodUsernamePassword	UsernamePassword – metoda
x509	BrokerAuthenticatorMethodX509	X509 – metoda.

BrokerAuthenticatorMethodSat

Token účtu služby pro BrokerAuthentication

Name	Typ	Description
audiences	string[]	Seznam povolených cílových skupin

BrokerAuthenticatorMethodSvid

SVID pro BrokerAuthentication

Name	Typ	Default value	Description
agentSocketPath	string		Připojená cesta soketu pro agenta spiffe.
identityMaxRetry	integer	3	Maximální počet opakovaných pokusů o načtení identity
identityWaitRetryMs	integer	5000	Maximální doba čekání, než se identita znovu načte.

BrokerAuthenticatorMethodUsernamePassword

Uživatelské jménoPassword pro BrokerAuthentication

Name	Typ	Description
keyVault	KeyVaultSecretProperties	Vlastnosti tajného kódu uživatelského jména hesla keyvault.
secretName	string	Tajný kód, ve kterém je uložené uživatelské jméno a heslo.

BrokerAuthenticatorMethodX509

X509 pro BrokerAuthentication.

Name	Typ	Default value	Description
attributes	BrokerAuthenticatorMethodX509Attributes		Název tajného klíče K8S pro připojení pro uživatelské jméno a heslo.
trustedClientCaCertConfigMap	string	client-ca	Mapa konfigurace certifikátu ca důvěryhodného klienta

BrokerAuthenticatorMethodX509Attributes

BrokerAuthenticatorMethodX509Attributes – vlastnosti. POZNÁMKA: Typ výčtu je podporován pouze najednou.

Name	Typ	Description
keyVault	KeyVaultSecretProperties	Vlastnosti tajného kódu atributů x509 služby Keyvault
secretName	string	Tajný kód, kde jsou uloženy atributy x509.

createdByType

Typ identity, která prostředek vytvořila.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Typ další informace.

ErrorDetail

Podrobnosti o chybě

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ExtendedLocationProperty

ExtendedLocation – vlastnosti

Name	Typ	Description
name	string	Název rozšířeného umístění.
type	ExtendedLocationType	Typ ExtendedLocation.

ExtendedLocationType

Výčet definující typ ExtendedLocation byl přijat.

Name	Typ	Description
CustomLocation	string	Typ CustomLocation

KeyVaultCertificateProperties

Vlastnosti certifikátu služby KeyVault

Name	Typ	Description
vault	KeyVaultConnectionProperties	Vlastnosti služby KeyVault.
vaultCaChainSecret	KeyVaultSecretObject	Podrobnosti o tajném kódu zřetězený certifikační autoritou KeyVault
vaultCert	KeyVaultSecretObject	Podrobnosti o tajném kódu certifikátu služby Key Vault

KeyVaultConnectionProperties

Vlastnosti služby KeyVault

Name	Typ	Description
credentials	KeyVaultCredentialsProperties	Přihlašovací údaje služby Key Vault.
directoryId	string	Id adresáře služby KeyVault.
name	string	Název trezoru klíčů.

KeyVaultCredentialsProperties

Vlastnosti přihlašovacích údajů služby KeyVault. POZNÁMKA: V budoucnu to bude ENUM.

Name	Typ	Description
servicePrincipalLocalSecretName	string	Název místního tajného klíče instančního objektu služby KeyVault.

KeyVaultSecretObject

Vlastnosti objektu tajného kódu služby Key Vault

Name	Typ	Description
name	string	Název tajného kódu služby Key Vault.
version	string	Verze tajného kódu služby Key Vault.

KeyVaultSecretProperties

Vlastnosti tajného kódu služby Key Vault

Name	Typ	Description
vault	KeyVaultConnectionProperties	Vlastnosti služby KeyVault.
vaultSecret	KeyVaultSecretObject	Podrobnosti o tajném kódu služby KeyVault

ProvisioningState

Výčet definující stav prostředku.

Name	Typ	Description
Accepted	string	Prostředek byl přijat.
Canceled	string	Vytváření prostředků se zrušilo.
Deleting	string	Prostředek se odstraňuje.
Failed	string	Vytvoření prostředku se nezdařilo.
Provisioning	string	Zřizují se prostředky.
Succeeded	string	Prostředek se vytvořil.
Updating	string	Prostředek se aktualizuje.

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která vytvořila prostředek.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Časové razítko poslední změny prostředku (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Sdílet prostřednictvím