az apic environment

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 environment komutunu ilk kez çalıştırdığınızda otomatik olarak yüklenir. Uzantılar hakkında daha fazla bilgi edinin.

API Center'da ortamları yönetme komutları.

Komutlar

Name	Description	Tür	Durum
az apic environment create	Yeni bir ortam oluşturun veya var olan bir ortamı güncelleştirin.	Extension	GA
az apic environment delete	Ortamı silin.	Extension	GA
az apic environment list	Ortam koleksiyonunu listeleyin.	Extension	GA
az apic environment show	Ortamın ayrıntılarını alın.	Extension	GA
az apic environment update	Mevcut ortamı güncelleştirin.	Extension	GA

az apic environment create

Yeni bir ortam oluşturun veya var olan bir ortamı güncelleştirin.

az apic environment create --environment-id
                           --resource-group
                           --service-name
                           --title
                           --type {development, production, staging, testing}
                           [--acquire-policy-token]
                           [--change-reference]
                           [--custom-properties]
                           [--description]
                           [--onboarding]
                           [--server]

Örnekler

Ortam oluşturma

az apic environment create -g api-center-test -n contosoeuap --environment-id public --title "Public cloud" --type "development"

Gerekli Parametreler

--environment-id

Ortamın 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ı.

--title

Ortam başlığı.

Özellik	Değer
Parametre grubu:	Properties Arguments

--type

Ortam türü.

Özellik	Değer
Parametre grubu:	Properties Arguments
Kabul edilen değerler:	development, production, staging, testing

İ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

Ortam açıklaması.

Özellik	Değer
Parametre grubu:	Properties Arguments

--onboarding

Ortamınızla ilgili ekleme belgeleri sağlayın; örneğin, {developerPortalUri:['https://developer.contoso.com'],instructions:'instructions markdown'} Shorthand-syntax, json-file ve yaml-file desteği. Daha fazla göstermek için "??" seçeneğini deneyin.

Özellik	Değer
Parametre grubu:	Properties Arguments

--server

Ortamın sunucu bilgileri. 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

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

Ortamı silin.

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

Örnekler

Ortam silme

az apic environment delete -g api-center-test -n contosoeuap --environment-id public

İ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

--environment-id

Ortamı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 environment list

Ortam koleksiyonunu listeleyin.

az apic environment list --resource-group
                         --service-name
                         [--filter]
                         [--max-items]
                         [--next-token]

Örnekler

Ortamları listeleme

az apic environment list -g api-center-test -n contosoeuap

Gerekli Parametreler

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

Ortamın ayrıntılarını alın.

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

Örnekler

Ortam ayrıntılarını göster

az apic environment show -g api-center-test -n contosoeuap --environment-id public

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

--environment-id

Ortamın kimliği.

Özellik	Değer
Parametre grubu:	Resource Id Arguments

--ids

Ö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 environment update

Mevcut ortamı güncelleştirin.

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

Örnekler

Ortamı güncelleştirme

az apic environment update -g api-center-test -n contosoeuap --environment-id public --title "Public cloud"

İ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

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

Description.

Özellik	Değer
Parametre grubu:	Properties Arguments

--environment-id

Ortamın kimliği.

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

Özellik	Değer
Parametre grubu:	Resource Id Arguments

--onboarding

{developerPortalUri:['https://developer.contoso.com'],instructions:'instructions markdown'} 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

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

Ortamın sunucu bilgileri. 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

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

Ortam başlığı.

Özellik	Değer
Parametre grubu:	Properties Arguments

--type

Ortam türü.

Özellik	Değer
Parametre grubu:	Properties Arguments
Kabul edilen değerler:	development, production, staging, testing

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

Geri Bildirim

Bu sayfayı yararlı buldunuz mu?