az iot ops broker authn

Note

Bu başvuru, Azure CLI (sürüm 2.70.0 veya üzeri) için azure-iot-ops uzantısının bir parçasıdır. Uzantı, az iot ops broker authn komutunu ilk kez çalıştırdığınızda otomatik olarak yüklenir. Uzantılar hakkında daha fazla bilgi edinin.

Mqtt aracısı kimlik doğrulaması yönetimi.

Komutlar

Name Description Tür Durum
az iot ops broker authn apply

Bir mqtt aracısı kimlik doğrulama kaynağı oluşturun veya değiştirin.

Extension GA
az iot ops broker authn delete

Bir mqtt aracısı kimlik doğrulama kaynağını silin.

Extension GA
az iot ops broker authn list

Bir aracıyla ilişkili mqtt aracısı kimlik doğrulama kaynaklarını listeleyin.

Extension GA
az iot ops broker authn method

Mqtt aracısı kimlik doğrulama yöntemi işlemleri.

Extension GA
az iot ops broker authn method add

Bir mqtt aracısı kimlik doğrulama kaynağına kimlik doğrulama yöntemleri ekleyin.

Extension GA
az iot ops broker authn show

Mqtt aracısı kimlik doğrulama kaynağının ayrıntılarını gösterir.

Extension GA

az iot ops broker authn apply

Bir mqtt aracısı kimlik doğrulama kaynağı oluşturun veya değiştirin.

Yapılandırma dosyası biçimine bir örnek aşağıdaki gibidir:

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

Uygulama ile kullanıldığında yukarıdaki içerik, üç kimlik doğrulama yöntemiyle yapılandırılmış bir hedef kimlik doğrulama kaynağı oluşturur veya değiştirir.

az iot ops broker authn apply --config-file
                              --instance
                              --name
                              --resource-group
                              [--acquire-policy-token]
                              [--broker]
                              [--change-reference]

Örnekler

Yapılandırma dosyası kullanarak varsayılan aracı için bir kimlik doğrulama kaynağı oluşturun veya değiştirin.

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

Gerekli Parametreler

--config-file

JSON biçiminde kaynak özellikleri içeren bir yapılandırma dosyasının yolu. Yapılandırma dosyası, kaynağın ARM gösterimiyle uyumlu özelliklere sahip bir nesne içermelidir. Nesnesi, ARM kaynağının 'properties:{}' ile doğrudan bağıntı kurar.

Özellik Değer
Parametre grubu: Config Arguments
--instance -i

IoT İşlemleri örnek adı.

--name -n

Mqtt aracısı kimlik doğrulaması kaynak adı.

--resource-group -g

Kaynak grubunun adı. az configure --defaults group=<name>kullanarak varsayılan grubu yapılandırabilirsiniz.

İsteğe Bağlı Parametreler

Aşağıdaki parametreler isteğe bağlıdır, ancak bağlama bağlı olarak komutun başarıyla yürütülmesi için bir veya daha fazla parametre gerekli olabilir.

--acquire-policy-token

Bu kaynak işlemi için otomatik olarak bir Azure İlkesi belirteci alma.

Özellik Değer
Parametre grubu: Global Policy Arguments
--broker -b

Mqtt aracı adı.

Özellik Değer
Default value: default
--change-reference

Bu kaynak işlemi için ilgili değişiklik başvuru kimliği.

Özellik Değer
Parametre grubu: Global Policy Arguments
Global Parametreler
--debug

Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.

Özellik Değer
Default value: False
--help -h

Bu yardım iletisini göster ve çık.

--only-show-errors

Yalnızca hataları gösterir ve uyarıları gizler.

Özellik Değer
Default value: False
--output -o

Çıkış biçimi.

Özellik Değer
Default value: json
Kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz. http://jmespath.org/.

--subscription

Aboneliğin adı veya kimliği. az account set -s NAME_OR_IDkullanarak varsayılan aboneliği yapılandırabilirsiniz.

--verbose

Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.

Özellik Değer
Default value: False

az iot ops broker authn delete

Bir mqtt aracısı kimlik doğrulama kaynağını silin.

az iot ops broker authn delete --instance
                               --name
                               --resource-group
                               [--acquire-policy-token]
                               [--broker]
                               [--change-reference]
                               [--yes {false, true}]

Örnekler

Varsayılan aracıyla ilişkili 'authn' adlı aracı kimlik doğrulama kaynağını silin.

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

Önceki örnekte olduğu gibi ancak onay istemi atlanıyor.

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

Gerekli Parametreler

--instance -i

IoT İşlemleri örnek adı.

--name -n

Mqtt aracısı kimlik doğrulaması kaynak adı.

--resource-group -g

Kaynak grubunun adı. az configure --defaults group=<name>kullanarak varsayılan grubu yapılandırabilirsiniz.

İsteğe Bağlı Parametreler

Aşağıdaki parametreler isteğe bağlıdır, ancak bağlama bağlı olarak komutun başarıyla yürütülmesi için bir veya daha fazla parametre gerekli olabilir.

--acquire-policy-token

Bu kaynak işlemi için otomatik olarak bir Azure İlkesi belirteci alma.

Özellik Değer
Parametre grubu: Global Policy Arguments
--broker -b

Mqtt aracı adı.

Özellik Değer
Default value: default
--change-reference

Bu kaynak işlemi için ilgili değişiklik başvuru kimliği.

Özellik Değer
Parametre grubu: Global Policy Arguments
--yes -y

[y]es öğesini istem olmadan onaylayın. CI ve otomasyon senaryoları için kullanışlıdır.

Özellik Değer
Kabul edilen değerler: false, true
Global Parametreler
--debug

Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.

Özellik Değer
Default value: False
--help -h

Bu yardım iletisini göster ve çık.

--only-show-errors

Yalnızca hataları gösterir ve uyarıları gizler.

Özellik Değer
Default value: False
--output -o

Çıkış biçimi.

Özellik Değer
Default value: json
Kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz. http://jmespath.org/.

--subscription

Aboneliğin adı veya kimliği. az account set -s NAME_OR_IDkullanarak varsayılan aboneliği yapılandırabilirsiniz.

--verbose

Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.

Özellik Değer
Default value: False

az iot ops broker authn list

Bir aracıyla ilişkili mqtt aracısı kimlik doğrulama kaynaklarını listeleyin.

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

Örnekler

Varsayılan aracıyla ilişkili tüm aracı kimlik doğrulama kaynaklarını numaralandırın.

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

Gerekli Parametreler

--instance -i

IoT İşlemleri örnek adı.

--resource-group -g

Kaynak grubunun adı. az configure --defaults group=<name>kullanarak varsayılan grubu yapılandırabilirsiniz.

İsteğe Bağlı Parametreler

Aşağıdaki parametreler isteğe bağlıdır, ancak bağlama bağlı olarak komutun başarıyla yürütülmesi için bir veya daha fazla parametre gerekli olabilir.

--broker -b

Mqtt aracı adı.

Özellik Değer
Default value: default
Global Parametreler
--debug

Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.

Özellik Değer
Default value: False
--help -h

Bu yardım iletisini göster ve çık.

--only-show-errors

Yalnızca hataları gösterir ve uyarıları gizler.

Özellik Değer
Default value: False
--output -o

Çıkış biçimi.

Özellik Değer
Default value: json
Kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz. http://jmespath.org/.

--subscription

Aboneliğin adı veya kimliği. az account set -s NAME_OR_IDkullanarak varsayılan aboneliği yapılandırabilirsiniz.

--verbose

Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.

Özellik Değer
Default value: False

az iot ops broker authn show

Mqtt aracısı kimlik doğrulama kaynağının ayrıntılarını gösterir.

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

Örnekler

Varsayılan aracıyla ilişkili varsayılan kimlik doğrulama kaynağının ayrıntılarını gösterin.

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

Gerekli Parametreler

--instance -i

IoT İşlemleri örnek adı.

--name -n

Mqtt aracısı kimlik doğrulaması kaynak adı.

--resource-group -g

Kaynak grubunun adı. az configure --defaults group=<name>kullanarak varsayılan grubu yapılandırabilirsiniz.

İsteğe Bağlı Parametreler

Aşağıdaki parametreler isteğe bağlıdır, ancak bağlama bağlı olarak komutun başarıyla yürütülmesi için bir veya daha fazla parametre gerekli olabilir.

--broker -b

Mqtt aracı adı.

Özellik Değer
Default value: default
Global Parametreler
--debug

Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.

Özellik Değer
Default value: False
--help -h

Bu yardım iletisini göster ve çık.

--only-show-errors

Yalnızca hataları gösterir ve uyarıları gizler.

Özellik Değer
Default value: False
--output -o

Çıkış biçimi.

Özellik Değer
Default value: json
Kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz. http://jmespath.org/.

--subscription

Aboneliğin adı veya kimliği. az account set -s NAME_OR_IDkullanarak varsayılan aboneliği yapılandırabilirsiniz.

--verbose

Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.

Özellik Değer
Default value: False