az iot ops broker authn method

Note

This reference is part of the azure-iot-ops extension for the Azure CLI (version 2.62.0 or higher). De extensie installeert automatisch de eerste keer dat u een opdracht az iot ops broker authn method uitvoert. Learn more about extensions.

Verificatiemethodebewerkingen voor Mqtt-broker.

Opdracht

Name	Description	Type	Status
az iot ops broker authn method add	Voeg verificatiemethoden toe aan een mqtt Broker-verificatieresource.	Extension	GA

az iot ops broker authn method add

Voeg verificatiemethoden toe aan een mqtt Broker-verificatieresource.

Dit is een add method(s) bewerking. Als de doelverificatieresource niet bestaat, wordt deze door de opdracht gemaakt.

az iot ops broker authn method add --authn
                                   --instance
                                   --resource-group
                                   [--broker]
                                   [--custom-ca-ref]
                                   [--custom-ep]
                                   [--custom-header]
                                   [--custom-x509-secret-ref]
                                   [--sat-aud]
                                   [--show-config {false, true}]
                                   [--x509-attr]
                                   [--x509-client-ca-ref]

Voorbeelden

Configureer een SAT-verificatiemethode en voeg deze toe aan de bestaande standaardverificatieresource.

az iot ops broker authn method add --authn default --in myinstance -g myresourcegroup --sat-aud my-audience1 my-audience2

Configureer een x509-verificatiemethode en voeg deze toe aan een zojuist gemaakte verificatieresource.

az iot ops broker authn method add --authn myauthn --in myinstance -g myresourcegroup --x509-client-ca-ref client-ca --x509-attr root.subject='CN = Contoso Root CA Cert, OU = Engineering, C = US' root.attributes.organization=contoso --x509-attr intermediate.subject='CN = Contoso Intermediate CA' intermediate.attributes.city=seattle intermediate.attributes.foo=bar --x509-attr smartfan.subject='CN = smart-fan' smartfan.attributes.building=17

Configureer een aangepaste verificatieserviceverificatiemethode en voeg deze toe aan een zojuist gemaakte verificatieresource.

az iot ops broker authn method add --authn myauthn --in myinstance -g myresourcegroup --custom-ep https://myauthserver --custom-ca-ref myconfigmap --custom-x509-secret-ref mysecret --custom-header a=b c=d

Configureer en voeg twee afzonderlijke verificatiemethoden toe aan een bestaande verificatieresource.

az iot ops broker authn method add --authn myexistingauthn --in myinstance -g myresourcegroup --sat-aud my-audience1 my-audience2 --x509-client-ca-ref client-ca

Vereiste parameters

--authn -n

Naam van Mqtt-brokerverificatieresource.

--instance -i

Naam ioT Operations-exemplaar.

--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Optionele parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--broker -b

Mqtt-brokernaam.

Eigenschap	Waarde
Default value:	default

--custom-ca-ref

Naam van de configuratiemap met het CA-certificaat voor het valideren van het certificaat van de aangepaste verificatieserver.

Eigenschap	Waarde
Parameter group:	Custom Arguments

--custom-ep

Eindpunt dat moet worden gebruikt voor de aangepaste verificatieservice. Indeling is https://.*.

Eigenschap	Waarde
Parameter group:	Custom Arguments

--custom-header

Http-headers die moeten worden doorgegeven aan de aangepaste verificatieserver. De notatie is door spaties gescheiden sleutelparen. Kan een of meer keren worden gebruikt.

Eigenschap	Waarde
Parameter group:	Custom Arguments

--custom-x509-secret-ref

Verwijzing naar Kubernetes-geheim met een clientcertificaat.

Eigenschap	Waarde
Parameter group:	Custom Arguments

--sat-aud

Door ruimte gescheiden lijst met toegestane doelgroepen.

Eigenschap	Waarde
Parameter group:	SAT Arguments

--show-config

De gegenereerde resourceconfiguratie weergeven in plaats van de API eraan aan te roepen.

Eigenschap	Waarde
Geaccepteerde waarden:	false, true

--x509-attr

Geef kenmerken op in de verificatieresource voor het autoriseren van clients op basis van hun certificaateigenschappen. U kunt autorisatieregels toepassen op clients met behulp van x509-certificaten met deze kenmerken. De notatie is door spaties gescheiden sleutel-waardeparen waarbij de sleutel objectpuntnotatie gebruikt, zoals 'a.b.c=value'. Kan een of meer keren worden gebruikt.

Eigenschap	Waarde
Parameter group:	x509 Arguments

--x509-client-ca-ref

Naam van de configuratiemap die de certificaatresource van de vertrouwde client-CA bevat. De standaardwaarde is 'client-ca'.

Eigenschap	Waarde
Parameter group:	x509 Arguments

Globale parameters

--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap	Waarde
Default value:	False

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap	Waarde
Default value:	False

--output -o

Output format.

Eigenschap	Waarde
Default value:	json
Geaccepteerde waarden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap	Waarde
Default value:	False