az apim api operation

  • Başvuru

Azure API Management API İşlemlerini yönetme.

Komutlar

Name Description Tür Durum
az apim api operation create

API'de yeni bir işlem oluşturur.

 Temel GA
az apim api operation delete

API'de belirtilen işlemi siler.

 Temel GA
az apim api operation list

Belirtilen API için işlem koleksiyonunu listeleyin.

 Temel GA
az apim api operation show

Tanımlayıcısı tarafından belirtilen API İşleminin ayrıntılarını alır.

 Temel GA
az apim api operation update

api'de tanımlayıcısı tarafından belirtilen işlemin ayrıntılarını Güncelleştirmeler.

 Temel GA

az apim api operation create

Düzenle

API'de yeni bir işlem oluşturur.

az apim api operation create --api-id
                             --display-name
                             --method
                             --resource-group
                             --service-name
                             --url-template
                             [--description]
                             [--if-match]
                             [--operation-id]
                             [--params]

Örnekler

API'de çeşitli parametrelerle yeni bir işlem oluşturur

az apim api operation create --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --url-template "/session/{param1}/{param2}" --method "GET" --display-name MyOperationName --description MyDescription --template-parameters name=param1 description=descriptionContent type=paramType required="true" --template-parameters name=param2 required="false" type="string"

Gerekli Parametreler

--api-id

API tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.

--display-name

Gerekli. İşlem Adı.

--method

Gerekli. Geçerli bir HTTP İşlem Yöntemi. GET, PUT, POST gibi tipik Http Yöntemleri ancak yalnızca bunlarla sınırlı değildir.

--resource-group -g

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

--service-name -n

API Management hizmet örneğinin adı.

--url-template

Bu işlem için hedef kaynağı tanımlayan göreli URL şablonu. Parametreleri içerebilir.

İsteğe Bağlı Parametreler

--description

İşlemin açıklaması. HTML biçimlendirme etiketleri içerebilir.

--if-match

Varlığın ETag'i.

--operation-id

API içindeki işlem tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.

--params --template-parameters -p

URL şablonu parametrelerinin koleksiyonu.

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.

--help -h

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

--only-show-errors

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

--output -o

Çıkış biçimi.

kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc
varsayılan değer: json
--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayı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.

az apim api operation delete

Düzenle

API'de belirtilen işlemi siler.

az apim api operation delete --api-id
                             --operation-id
                             --resource-group
                             --service-name
                             [--if-match]

Örnekler

API'de belirtilen işlemi siler.

az apim api operation delete --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId

Gerekli Parametreler

--api-id

API tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.

--operation-id

API içindeki işlem tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.

--resource-group -g

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

--service-name -n

API Management hizmet örneğinin adı.

İsteğe Bağlı Parametreler

--if-match

Varlığın ETag'i.

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.

--help -h

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

--only-show-errors

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

--output -o

Çıkış biçimi.

kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc
varsayılan değer: json
--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayı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.

az apim api operation list

Düzenle

Belirtilen API için işlem koleksiyonunu listeleyin.

az apim api operation list --api-id
                           --resource-group
                           --service-name

Örnekler

Belirtilen API için işlem koleksiyonunu listeleyin.

az apim api operation list --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId

Gerekli Parametreler

--api-id

API tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.

--resource-group -g

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

--service-name -n

API Management hizmet örneğinin adı.

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.

--help -h

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

--only-show-errors

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

--output -o

Çıkış biçimi.

kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc
varsayılan değer: json
--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayı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.

az apim api operation show

Düzenle

Tanımlayıcısı tarafından belirtilen API İşleminin ayrıntılarını alır.

az apim api operation show --api-id
                           --operation-id
                           --resource-group
                           --service-name

Örnekler

Tanımlayıcısı tarafından belirtilen API İşleminin ayrıntılarını alır.

az apim api operation show --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId

Gerekli Parametreler

--api-id

API tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.

--operation-id

API içindeki işlem tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.

--resource-group -g

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

--service-name -n

API Management hizmet örneğinin adı.

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.

--help -h

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

--only-show-errors

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

--output -o

Çıkış biçimi.

kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc
varsayılan değer: json
--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayı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.

az apim api operation update

Düzenle

api'de tanımlayıcısı tarafından belirtilen işlemin ayrıntılarını Güncelleştirmeler.

az apim api operation update --api-id
                             --operation-id
                             --resource-group
                             --service-name
                             [--add]
                             [--description]
                             [--display-name]
                             [--force-string]
                             [--if-match]
                             [--method]
                             [--remove]
                             [--set]
                             [--url-template]

Örnekler

Güncelleştirmeler yöntemi, displayname, tanımlayıcısı tarafından belirtilen API'deki işlemin açıklaması.

az apim api operation update --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId --method "PUT" --display-name NewDisplayName --description NewDescription

Gerekli Parametreler

--api-id

API tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.

--operation-id

API içindeki işlem tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.

--resource-group -g

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

--service-name -n

API Management hizmet örneğinin adı.

İsteğe Bağlı Parametreler

--add

Bir yol ve anahtar değer çiftleri belirterek nesne listesine nesne ekleyin. Örnek: --add property.listProperty <key=value, string or JSON string>.

varsayılan değer: []
--description

İşlemin açıklaması. HTML biçimlendirme etiketleri içerebilir.

--display-name

Gerekli. İşlem Adı.

--force-string

'set' veya 'add' kullanırken, JSON'a dönüştürmeye çalışmak yerine dize değişmez değerlerini koruyun.

varsayılan değer: False
--if-match

Varlığın ETag'i.

--method

Gerekli. Geçerli bir HTTP İşlem Yöntemi. GET, PUT, POST gibi tipik Http Yöntemleri ancak yalnızca bunlarla sınırlı değildir.

--remove

Bir özelliği veya öğeyi listeden kaldırın. Örnek: --remove property.list <indexToRemove> OR --remove propertyToRemove.

varsayılan değer: []
--set

Ayarlanacağı özellik yolunu ve değerini belirterek nesneyi güncelleştirin. Örnek: --set property1.property2=<value>.

varsayılan değer: []
--url-template

Bu işlem için hedef kaynağı tanımlayan göreli URL şablonu. Parametreleri içerebilir.

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.

--help -h

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

--only-show-errors

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

--output -o

Çıkış biçimi.

kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc
varsayılan değer: json
--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayı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.