Udostępnij przez

az iot ops broker authz

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 authz . Dowiedz się więcej o rozszerzeniach.

Zarządzanie autoryzacją brokera Mqtt.

Polecenia

Nazwa Opis Typ Stan
az iot ops broker authz apply

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

 Extension ogólna dostępność
az iot ops broker authz delete

Usuń zasób autoryzacji brokera mqtt.

 Extension ogólna dostępność
az iot ops broker authz list

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

 Extension ogólna dostępność
az iot ops broker authz show

Pokaż szczegóły zasobu autoryzacji brokera mqtt.

 Extension ogólna dostępność

az iot ops broker authz apply

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

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

{
    "authorizationPolicies": {
        "cache": "Enabled",
        "rules": [
            {
                "principals": {
                    "clientIds": [
                        "temperature-sensor",
                        "humidity-sensor"
                    ],
                    "attributes": [
                        {
                            "city": "seattle",
                            "organization": "contoso"
                        }
                    ]
                },
                "brokerResources": [
                    {
                        "method": "Connect"
                    },
                    {
                        "method": "Publish",
                        "topics": [
                            "/telemetry/{principal.clientId}",
                            "/telemetry/{principal.attributes.organization}"
                        ]
                    },
                    {
                        "method": "Subscribe",
                        "topics": [
                            "/commands/{principal.attributes.organization}"
                        ]
                    }
                ]
            }
        ]
    }
}

W przypadku użycia z zastosowaniem powyższej zawartości zostanie utworzony lub zastąpiony docelowy zasób autoryzacji skonfigurowany za pomocą jednej reguły authz.

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

Przykłady

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

az iot ops broker authz apply -n authz --in myinstance -g myresourcegroup --config-file /path/to/authz/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 autoryzacji 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 authz delete

Usuń zasób autoryzacji brokera mqtt.

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

Przykłady

Usuń zasób autoryzacji brokera mqtt o nazwie "authz" skojarzony z brokerem domyślnym.

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

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

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

Parametry wymagane

--instance -i

Nazwa wystąpienia operacji IoT.

--name -n

Nazwa zasobu autoryzacji 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 authz list

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

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

Przykłady

Wylicza wszystkie zasoby autoryzacji brokera mqtt skojarzone z domyślnym brokerem.

az iot ops broker authz 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 authz show

Pokaż szczegóły zasobu autoryzacji brokera mqtt.

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

Przykłady

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

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

Parametry wymagane

--instance -i

Nazwa wystąpienia operacji IoT.

--name -n

Nazwa zasobu autoryzacji 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