az apic api deployment

Note

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

API Center'da API dağıtımlarını yönetme komutları.

Komutlar

Name	Description	Tür	Durum
az apic api deployment create	Yeni bir API dağıtımı oluşturun veya mevcut API dağıtımlarını güncelleştirin.	Extension	GA
az apic api deployment delete	API dağıtımlarını silin.	Extension	GA
az apic api deployment list	API dağıtımları koleksiyonunu listeleyin.	Extension	GA
az apic api deployment show	API dağıtımının ayrıntılarını alın.	Extension	GA
az apic api deployment update	Mevcut API dağıtımlarını güncelleştirin.	Extension	GA

az apic api deployment create

Yeni bir API dağıtımı oluşturun veya mevcut API dağıtımlarını güncelleştirin.

az apic api deployment create --api-id
                              --definition-id
                              --deployment-id
                              --environment-id
                              --resource-group
                              --server
                              --service-name
                              --title
                              [--acquire-policy-token]
                              [--change-reference]
                              [--custom-properties]
                              [--description]

Örnekler

Dağıtım oluşturun

az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '{"runtimeUri":["https://example.com"]}'

Sunucu json dosyasını kullanarak dağıtım oluşturma

az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '@server.json'

Gerekli Parametreler

--api-id

API'nin kimliği.

--definition-id

API merkezi kapsamlı tanım kaynak kimliği.

Özellik	Değer
Parametre grubu:	Properties Arguments

--deployment-id

API dağıtımının kimliği.

--environment-id

API merkezi kapsamlı ortam kaynak kimliği.

Özellik	Değer
Parametre grubu:	Properties Arguments

--resource-group -g

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

--server

Sunucu Desteği kısa söz dizimi, json-file ve yaml-file. Daha fazla göstermek için "??" seçeneğini deneyin.

Özellik	Değer
Parametre grubu:	Properties Arguments

--service-name -n

Azure API Center hizmetinin adı.

--title

Dağıtım başlığı.

Özellik	Değer
Parametre grubu:	Properties Arguments

İ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

--change-reference

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

Özellik	Değer
Parametre grubu:	Global Policy Arguments

--custom-properties

API kataloğu varlıkları için tanımlanan özel meta veriler. Kısa söz dizimi, json-file ve yaml-file desteği. Daha fazla göstermek için "??" seçeneğini deneyin.

Özellik	Değer
Parametre grubu:	Properties Arguments

--description

Dağıtımın açıklaması.

Özellik	Değer
Parametre grubu:	Properties 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 apic api deployment delete

API dağıtımlarını silin.

az apic api deployment delete [--acquire-policy-token]
                              [--api-id]
                              [--change-reference]
                              [--deployment-id]
                              [--ids]
                              [--resource-group]
                              [--service-name]
                              [--subscription]
                              [--yes]

Örnekler

API dağıtımlarını silme

az apic api deployment delete -g api-center-test -n contoso --deployment-id production --api-id echo-api

İ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

--api-id

API'nin kimliği.

Özellik	Değer
Parametre grubu:	Resource Id Arguments

--change-reference

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

Özellik	Değer
Parametre grubu:	Global Policy Arguments

--deployment-id

API dağıtımının kimliği.

Özellik	Değer
Parametre grubu:	Resource Id Arguments

--ids

Bir veya daha fazla kaynak kimliği (boşlukla ayrılmış). 'Kaynak Kimliği' bağımsız değişkenlerinin tüm bilgilerini içeren eksiksiz bir kaynak kimliği olmalıdır. --ids veya diğer 'Kaynak Kimliği' parametrelerini vermelisiniz.

Özellik	Değer
Parametre grubu:	Resource Id Arguments

--resource-group -g

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

Özellik	Değer
Parametre grubu:	Resource Id Arguments

--service-name -n

Azure API Center hizmetinin adı.

Özellik	Değer
Parametre grubu:	Resource Id Arguments

--subscription

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

Özellik	Değer
Parametre grubu:	Resource Id Arguments

--yes -y

Onay istemde bulunmayın.

Özellik	Değer
Default value:	False

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/.

--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 apic api deployment list

API dağıtımları koleksiyonunu listeleyin.

az apic api deployment list --api-id
                            --resource-group
                            --service-name
                            [--filter]
                            [--max-items]
                            [--next-token]

Örnekler

API dağıtımlarını listeleme

az apic api deployment list -g api-center-test -n contoso --api-id echo-api

Gerekli Parametreler

--api-id

API'nin kimliği.

--resource-group -g

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

--service-name -n

Azure API Center hizmetinin adı.

İ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.

--filter

OData filtre parametresi.

--max-items

Komutun çıkışında döndürülecek toplam öğe sayısı. Kullanılabilir öğelerin toplam sayısı belirtilen değerden fazlaysa, komutun çıkışında bir belirteç sağlanır. Sayfalandırmayı sürdürmek için sonraki bir komutun --next-token bağımsız değişkeninde belirteç değerini sağlayın.

Özellik	Değer
Parametre grubu:	Pagination Arguments

--next-token

Sayfalandırmanın nereden başlatılacağını belirtmek için belirteç. Bu, daha önce kesilmiş bir yanıttan alınan belirteç değeridir.

Özellik	Değer
Parametre grubu:	Pagination 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 apic api deployment show

API dağıtımının ayrıntılarını alın.

az apic api deployment show [--api-id]
                            [--deployment-id]
                            [--ids]
                            [--resource-group]
                            [--service-name]
                            [--subscription]

Örnekler

API dağıtım ayrıntılarını göster

az apic api deployment show -g api-center-test -n contoso --deployment-id production --api-id echo-api

İ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.

--api-id

API'nin kimliği.

Özellik	Değer
Parametre grubu:	Resource Id Arguments

--deployment-id

API dağıtımının kimliği.

Özellik	Değer
Parametre grubu:	Resource Id Arguments

--ids

Bir veya daha fazla kaynak kimliği (boşlukla ayrılmış). 'Kaynak Kimliği' bağımsız değişkenlerinin tüm bilgilerini içeren eksiksiz bir kaynak kimliği olmalıdır. --ids veya diğer 'Kaynak Kimliği' parametrelerini vermelisiniz.

Özellik	Değer
Parametre grubu:	Resource Id Arguments

--resource-group -g

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

Özellik	Değer
Parametre grubu:	Resource Id Arguments

--service-name -n

Azure API Center hizmetinin adı.

Özellik	Değer
Parametre grubu:	Resource Id Arguments

--subscription

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

Özellik	Değer
Parametre grubu:	Resource Id 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/.

--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 apic api deployment update

Mevcut API dağıtımlarını güncelleştirin.

az apic api deployment update [--acquire-policy-token]
                              [--add]
                              [--api-id]
                              [--change-reference]
                              [--custom-properties]
                              [--definition-id]
                              [--deployment-id]
                              [--description]
                              [--environment-id]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--remove]
                              [--resource-group]
                              [--server]
                              [--service-name]
                              [--set]
                              [--subscription]
                              [--title]

Örnekler

API dağıtımlarını güncelleştirme

az apic api deployment update -g api-center-test -n contoso --deployment-id production --title "Production deployment" --api-id echo-api

İ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

--add

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

Özellik	Değer
Parametre grubu:	Generic Update Arguments

--api-id

API'nin kimliği.

Özellik	Değer
Parametre grubu:	Resource Id Arguments

--change-reference

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

Özellik	Değer
Parametre grubu:	Global Policy Arguments

--custom-properties

API kataloğu varlıkları için tanımlanan özel meta veriler. Kısa söz dizimi, json-file ve yaml-file desteği. Daha fazla göstermek için "??" seçeneğini deneyin.

Özellik	Değer
Parametre grubu:	Properties Arguments

--definition-id

Hizmet kapsamlı tanım kaynak kimliği.

Özellik	Değer
Parametre grubu:	Properties Arguments

--deployment-id

API dağıtımının kimliği.

Özellik	Değer
Parametre grubu:	Resource Id Arguments

--description

Dağıtımın açıklaması.

Özellik	Değer
Parametre grubu:	Properties Arguments

--environment-id

Hizmet kapsamlı ortam kaynak kimliği.

Özellik	Değer
Parametre grubu:	Properties Arguments

--force-string

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

Özellik	Değer
Parametre grubu:	Generic Update Arguments
Kabul edilen değerler:	0, 1, f, false, n, no, t, true, y, yes

--ids

Bir veya daha fazla kaynak kimliği (boşlukla ayrılmış). 'Kaynak Kimliği' bağımsız değişkenlerinin tüm bilgilerini içeren eksiksiz bir kaynak kimliği olmalıdır. --ids veya diğer 'Kaynak Kimliği' parametrelerini vermelisiniz.

Özellik	Değer
Parametre grubu:	Resource Id Arguments

--remove

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

Özellik	Değer
Parametre grubu:	Generic Update Arguments

--resource-group -g

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

Özellik	Değer
Parametre grubu:	Resource Id Arguments

--server

Sunucu Desteği kısa söz dizimi, json-file ve yaml-file. Daha fazla göstermek için "??" seçeneğini deneyin.

Özellik	Değer
Parametre grubu:	Properties Arguments

--service-name -n

Azure API Center hizmetinin adı.

Özellik	Değer
Parametre grubu:	Resource Id Arguments

--set

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

Özellik	Değer
Parametre grubu:	Generic Update Arguments

--subscription

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

Özellik	Değer
Parametre grubu:	Resource Id Arguments

--title

Title.

Özellik	Değer
Parametre grubu:	Properties 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/.

--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