Broker Authentication - Update

Référence

Service:: IoT MQ

Version d'API:: 2023-10-04-preview

Mettre à jour une ressource 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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
authenticationName	path	True	string	Nom de la ressource broker/authentification MQ Modèle d’expression régulière: `^[a-zA-Z0-9-]{3,24}$`
brokerName	path	True	string	Nom de la ressource broker MQ Modèle d’expression régulière: `^[a-zA-Z0-9-]{3,24}$`
mqName	path	True	string	Nom de la ressource MQ Modèle d’expression régulière: `^[a-zA-Z0-9-]{3,24}$`
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
properties.authenticationMethods	BrokerAuthenticatorMethods[]	Liste des méthodes d’authentification prises en charge par la ressource d’authentification. Pour chaque élément de tableau, REMARQUE - Type d’authentificateur enum uniquement pris en charge.
properties.listenerRef	string[]	Tableau des ressources de l’écouteur qu’il prend en charge.
tags	object	Balises de ressource.

Réponses

Nom	Type	Description
200 OK	BrokerAuthenticationResource	L’opération Azure s’est terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

BrokerAuthentication_Update

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
  }
}

Définitions

Nom	Description
BrokerAuthenticationResource	Ressource broker/authentification MQ
BrokerAuthenticationResourceUpdate	Type utilisé pour les opérations de mise à jour de BrokerAuthenticationResource.
BrokerAuthenticatorCustomAuth	Propriétés d’authentification personnalisées
BrokerAuthenticatorCustomAuthX509	Propriétés d’authentification personnalisée X509. REMARQUE : Énumérer uniquement le type d’authentificateur pris en charge à la fois.
BrokerAuthenticatorMethodCustom	Méthode personnalisée pour BrokerAuthentication
BrokerAuthenticatorMethods	Collection de différentes méthodes CrdAuthenticator de Broker Resource. REMARQUE Énumération : une seule méthode est prise en charge pour chaque entrée.
BrokerAuthenticatorMethodSat	Jeton de compte de service pour BrokerAuthentication
BrokerAuthenticatorMethodSvid	SVID pour BrokerAuthentication
BrokerAuthenticatorMethodUsernamePassword	UsernamePassword pour BrokerAuthentication
BrokerAuthenticatorMethodX509	X509 pour BrokerAuthentication.
BrokerAuthenticatorMethodX509Attributes	Propriétés BrokerAuthenticatorMethodX509Attributes. REMARQUE : Type d’énumération uniquement pris en charge à la fois.
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
ExtendedLocationProperty	Propriétés ExtendedLocation
ExtendedLocationType	Type d’énumération définissant ExtendedLocation accepté.
KeyVaultCertificateProperties	Propriétés du certificat KeyVault
KeyVaultConnectionProperties	Propriétés de KeyVault
KeyVaultCredentialsProperties	Propriétés des informations d’identification KeyVault. REMARQUE : à l’avenir, ce sera ENUM.
KeyVaultSecretObject	Propriétés de l’objet secret KeyVault
KeyVaultSecretProperties	Propriétés du secret KeyVault
ProvisioningState	Énumération définissant status de ressource.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

BrokerAuthenticationResource

Ressource broker/authentification MQ

Nom	Type	Description
extendedLocation	ExtendedLocationProperty	Emplacement étendu
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Emplacement géographique où réside la ressource
name	string	nom de la ressource.
properties.authenticationMethods	BrokerAuthenticatorMethods[]	Liste des méthodes d’authentification prises en charge par la ressource d’authentification. Pour chaque élément de tableau, NOTE - Enum uniquement le type d’authentificateur pris en charge.
properties.listenerRef	string[]	Tableau de ressources d’écouteur qu’il prend en charge.
properties.provisioningState	ProvisioningState	Status de la dernière opération.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

BrokerAuthenticationResourceUpdate

Type utilisé pour les opérations de mise à jour de BrokerAuthenticationResource.

Nom	Type	Description
properties.authenticationMethods	BrokerAuthenticatorMethods[]	Liste des méthodes d’authentification prises en charge par la ressource d’authentification. Pour chaque élément de tableau, NOTE - Enum uniquement le type d’authentificateur pris en charge.
properties.listenerRef	string[]	Tableau de ressources d’écouteur qu’il prend en charge.
tags	object	Balises de ressource.

BrokerAuthenticatorCustomAuth

Propriétés d’authentification personnalisées

Nom	Type	Description
x509	BrokerAuthenticatorCustomAuthX509	X509 Détails du type d’authentification personnalisée.

BrokerAuthenticatorCustomAuthX509

Propriétés d’authentification personnalisée X509. REMARQUE : Énumérer uniquement le type d’authentificateur pris en charge à la fois.

Nom	Type	Description
keyVault	KeyVaultCertificateProperties	Propriétés du secret keyvault X509.
secretName	string	Secret dans lequel les détails du certificat sont stockés.

BrokerAuthenticatorMethodCustom

Méthode personnalisée pour BrokerAuthentication

Nom	Type	Description
auth	BrokerAuthenticatorCustomAuth	Méthode d’authentification Broker personnalisée.
caCertConfigMap	string	Carte de configuration des certificats d’autorité de certification à utiliser.
endpoint	string	Point de terminaison auquel se connecter.
headers	object	En-têtes de configuration à utiliser.

BrokerAuthenticatorMethods

Collection de différentes méthodes CrdAuthenticator de Broker Resource. REMARQUE Énumération : une seule méthode est prise en charge pour chaque entrée.

Nom	Type	Description
custom	BrokerAuthenticatorMethodCustom	Méthode d’authentification personnalisée.
sat	BrokerAuthenticatorMethodSat	Méthode de jeton de compte de service.
svid	BrokerAuthenticatorMethodSvid	Méthode de jeton de compte de service.
usernamePassword	BrokerAuthenticatorMethodUsernamePassword	UsernamePassword, méthode.
x509	BrokerAuthenticatorMethodX509	X509, méthode.

BrokerAuthenticatorMethodSat

Jeton de compte de service pour BrokerAuthentication

Nom	Type	Description
audiences	string[]	Liste du public autorisé.

BrokerAuthenticatorMethodSvid

SVID pour BrokerAuthentication

Nom	Type	Valeur par défaut	Description
agentSocketPath	string		Chemin du socket monté pour l’agent spiffe.
identityMaxRetry	integer	3	Nombre maximal de nouvelles tentatives d’extraction d’identité.
identityWaitRetryMs	integer	5000	Temps maximal d’attente avant de récupérer à nouveau l’identité.

BrokerAuthenticatorMethodUsernamePassword

UsernamePassword pour BrokerAuthentication

Nom	Type	Description
keyVault	KeyVaultSecretProperties	Propriétés secrètes du mot de passe du nom d’utilisateur keyvault.
secretName	string	Secret dans lequel le nom d’utilisateur et le mot de passe sont stockés.

BrokerAuthenticatorMethodX509

X509 pour BrokerAuthentication.

Nom	Type	Valeur par défaut	Description
attributes	BrokerAuthenticatorMethodX509Attributes		Nom du secret K8S à monter pour le nom d’utilisateur et le mot de passe.
trustedClientCaCertConfigMap	string	client-ca	Carte de configuration du certificat du client approuvé.

BrokerAuthenticatorMethodX509Attributes

Propriétés BrokerAuthenticatorMethodX509Attributes. REMARQUE : Type d’énumération uniquement pris en charge à la fois.

Nom	Type	Description
keyVault	KeyVaultSecretProperties	Keyvault x509 attributs propriétés secrètes.
secretName	string	Secret où sont stockés les attributs x509.

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ExtendedLocationProperty

Propriétés ExtendedLocation

Nom	Type	Description
name	string	Nom de l’emplacement étendu.
type	ExtendedLocationType	Type d’ExtendedLocation.

ExtendedLocationType

Type d’énumération définissant ExtendedLocation accepté.

Nom	Type	Description
CustomLocation	string	Type CustomLocation

KeyVaultCertificateProperties

Propriétés du certificat KeyVault

Nom	Type	Description
vault	KeyVaultConnectionProperties	Propriétés de KeyVault.
vaultCaChainSecret	KeyVaultSecretObject	Détails du secret de chaîne de l’autorité de certification KeyVault.
vaultCert	KeyVaultSecretObject	Détails du secret du certificat KeyVault.

KeyVaultConnectionProperties

Propriétés de KeyVault

Nom	Type	Description
credentials	KeyVaultCredentialsProperties	Informations d’identification KeyVault.
directoryId	string	KeyVault directoryId.
name	string	Nom de KeyVault.

KeyVaultCredentialsProperties

Propriétés des informations d’identification KeyVault. REMARQUE : à l’avenir, ce sera ENUM.

Nom	Type	Description
servicePrincipalLocalSecretName	string	Nom du secret local du principal du service KeyVault.

KeyVaultSecretObject

Propriétés de l’objet secret KeyVault

Nom	Type	Description
name	string	Nom du secret KeyVault.
version	string	Version du secret KeyVault.

KeyVaultSecretProperties

Propriétés du secret KeyVault

Nom	Type	Description
vault	KeyVaultConnectionProperties	Propriétés de KeyVault.
vaultSecret	KeyVaultSecretObject	Détails du secret KeyVault.

ProvisioningState

Énumération définissant status de ressource.

Nom	Type	Description
Accepted	string	La ressource a été acceptée.
Canceled	string	La création de ressource a été annulée.
Deleting	string	La ressource est suppression.
Failed	string	Échec de la création des ressources.
Provisioning	string	La ressource est en cours d’approvisionnement.
Succeeded	string	La ressource a été créée.
Updating	string	La ressource est mise à jour.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la dernière ressource.
lastModifiedByType	createdByType	Type d’identité qui a modifié la dernière ressource.

Partager via