az iot ops broker authn

Note

Ta dokumentacja jest częścią rozszerzenia azure-iot-ops dla interfejsu wiersza polecenia platformy Azure (wersja 2.67.0 lub nowsza). Rozszerzenie zostanie automatycznie zainstalowane przy pierwszym uruchomieniu polecenia az iot ops broker authn . Dowiedz się więcej o rozszerzeniach.

Zarządzanie uwierzytelnianiem brokera Mqtt.

Polecenia

Nazwa	Opis	Typ	Stan
az iot ops broker authn apply	Utwórz lub zastąp zasób uwierzytelniania brokera mqtt.	Extension	ogólna dostępność
az iot ops broker authn delete	Usuń zasób uwierzytelniania brokera mqtt.	Extension	ogólna dostępność
az iot ops broker authn list	Wyświetl listę zasobów uwierzytelniania brokera mqtt skojarzonych z brokerem.	Extension	ogólna dostępność
az iot ops broker authn method	Operacje metody authn brokera Mqtt.	Extension	ogólna dostępność
az iot ops broker authn method add	Dodaj metody uwierzytelniania do zasobu uwierzytelniania brokera mqtt.	Extension	ogólna dostępność
az iot ops broker authn show	Pokaż szczegóły zasobu uwierzytelniania brokera mqtt.	Extension	ogólna dostępność

az iot ops broker authn apply

Utwórz lub zastąp zasób uwierzytelniania brokera mqtt.

Przykład formatu pliku konfiguracji wygląda następująco:

{
    "authenticationMethods": [
        {
            "method": "Custom",
            "customSettings": {
                "endpoint": "https://auth-server-template",
                "caCertConfigMap": "custom-auth-ca",
                "auth": {
                    "x509": {
                        "secretRef": "custom-auth-client-cert"
                    }
                },
                "headers": {
                    "header_key": "header_value"
                }
            }
        },
        {
            "method": "ServiceAccountToken",
            "serviceAccountTokenSettings": {
                "audiences": [
                    "aio-internal",
                    "my-audience"
                ]
            }
        },
        {
            "method": "X509",
            "x509Settings": {
                "trustedClientCaCert": "client-ca",
                "authorizationAttributes": {
                    "root": {
                        "attributes": {
                            "organization": "contoso"
                        },
                        "subject": "CN = Contoso Root CA Cert, OU = Engineering, C = US"
                    },
                    "intermediate": {
                        "attributes": {
                            "city": "seattle",
                            "foo": "bar"
                        },
                        "subject": "CN = Contoso Intermediate CA"
                    },
                    "smartfan": {
                        "attributes": {
                            "building": "17"
                        },
                        "subject": "CN = smart-fan"
                    }
                }
            }
        }
    ]
}

W przypadku użycia z zastosowaniem powyższej zawartości utworzy lub zastąpi docelowy zasób uwierzytelniania skonfigurowany za pomocą trzech metod authn.

az iot ops broker authn apply --config-file
                              --instance
                              --name
                              --resource-group
                              [--broker]

Przykłady

Utwórz lub zastąp zasób uwierzytelniania dla domyślnego brokera przy użyciu pliku konfiguracji.

az iot ops broker authn apply -n authn --in myinstance -g myresourcegroup --config-file /path/to/authn/config.json

Parametry wymagane

--config-file

Ścieżka do pliku konfiguracji zawierającego właściwości zasobu w formacie json. Plik konfiguracji powinien zawierać obiekt z właściwościami zgodnymi z reprezentacją zasobu w usłudze ARM. Obiekt jest skorelowany bezpośrednio z elementem "properties:{}" zasobu usługi ARM.

Właściwość	Wartość
Grupa parametrów:	Config Arguments

--instance -i

Nazwa wystąpienia operacji IoT.

--name -n

Nazwa zasobu uwierzytelniania brokera Mqtt.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--broker -b

Nazwa brokera Mqtt.

Właściwość	Wartość
Domyślna wartość:	default

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

az iot ops broker authn delete

Usuń zasób uwierzytelniania brokera mqtt.

az iot ops broker authn delete --instance
                               --name
                               --resource-group
                               [--broker]
                               [--yes {false, true}]

Przykłady

Usuń zasób uwierzytelniania brokera o nazwie "authn" skojarzony z domyślnym brokerem.

az iot ops broker authn delete -n authn --in myinstance -g myresourcegroup

Tak samo jak w poprzednim przykładzie, ale pomijanie monitu o potwierdzenie.

az iot ops broker authn delete -n authn --in myinstance -g myresourcegroup -y

Parametry wymagane

--instance -i

Nazwa wystąpienia operacji IoT.

--name -n

Nazwa zasobu uwierzytelniania brokera Mqtt.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--broker -b

Nazwa brokera Mqtt.

Właściwość	Wartość
Domyślna wartość:	default

--yes -y

Potwierdź [y]es bez monitu. Przydatne w scenariuszach ciągłej integracji i automatyzacji.

Właściwość	Wartość
Dopuszczalne wartości:	false, true

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

az iot ops broker authn list

Wyświetl listę zasobów uwierzytelniania brokera mqtt skojarzonych z brokerem.

az iot ops broker authn list --instance
                             --resource-group
                             [--broker]

Przykłady

Wyliczanie wszystkich zasobów uwierzytelniania brokera skojarzonych z domyślnym brokerem.

az iot ops broker authn list --in myinstance -g myresourcegroup

Parametry wymagane

--instance -i

Nazwa wystąpienia operacji IoT.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--broker -b

Nazwa brokera Mqtt.

Właściwość	Wartość
Domyślna wartość:	default

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

az iot ops broker authn show

Pokaż szczegóły zasobu uwierzytelniania brokera mqtt.

az iot ops broker authn show --instance
                             --name
                             --resource-group
                             [--broker]

Przykłady

Pokaż szczegóły domyślnego zasobu uwierzytelniania skojarzonego z domyślnym brokerem.

az iot ops broker authn show -n authn --in myinstance -g myresourcegroup

Parametry wymagane

--instance -i

Nazwa wystąpienia operacji IoT.

--name -n

Nazwa zasobu uwierzytelniania brokera Mqtt.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--broker -b

Nazwa brokera Mqtt.

Właściwość	Wartość
Domyślna wartość:	default

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

Sprzężenie zwrotne

Czy ta strona była pomocna?

Udostępnij przez

az iot ops broker authn

Polecenia

az iot ops broker authn apply

Przykłady

Parametry wymagane

Parametry opcjonalne

az iot ops broker authn delete

Przykłady

Parametry wymagane

Parametry opcjonalne

az iot ops broker authn list

Przykłady

Parametry wymagane

Parametry opcjonalne

az iot ops broker authn show

Przykłady

Parametry wymagane

Parametry opcjonalne

Sprzężenie zwrotne