Azure API Management'ta düzeltmeler

UYGULANANLAR: Tüm API Management katmanları

Düzeltmeler, API'lerinizde denetimli ve güvenli bir şekilde değişiklik yapmanıza olanak sağlar. Değişiklik yapmak istediğinizde yeni bir düzeltme oluşturun. Daha sonra API tüketicilerinizi rahatsız etmeden API'nizi düzenleyebilir ve test edebilirsiniz. Hazır olduğunuzda revizyonunuzu geçerli hale getirirsiniz. Aynı zamanda, API tüketicilerinizi yaptığınız değişikliklerle güncel tutmak için isteğe bağlı olarak değişiklik günlüğüne bir giriş gönderebilirsiniz. Değişiklik günlüğü geliştirici portalınızda yayımlanır.

Uyarı

Geliştirici portalı Tüketim katmanında kullanılamaz.

Düzeltmelerle şunları yapabilirsiniz:

• Üretim API'nizi rahatsız etmeden API tanımlarınızda ve ilkelerinizde güvenle değişiklikler yapın.
• Değişiklikleri yayımlamadan önce deneyin.
• Geliştiricilerinizin yeni olanları anlaması için yaptığınız değişiklikleri belgeleyebilirsiniz.
• Sorun bulursanız geri alın.

Kılavuzu izleyerek düzeltmelere başlayın.

Belirli düzeltmelere erişme

API'nizdeki her düzeltmeye özel olarak biçimlendirilmiş bir URL kullanılarak erişilebilir. API'nin belirli bir sürümüne erişmek için ;rev={revisionNumber} karakterini sorgu dizesinden önce, ancak API URL'nizin sonuna ekleyin. Örneğin, API'nin 3. düzeltmesine erişmek için bu URL'yi customers kullanabilirsiniz:

https://apis.contoso.com/customers;rev=3/leads?customerId=123

Varsayılan olarak, her düzeltme geçerli düzeltmeyle aynı güvenlik ayarlarına sahiptir. Her düzeltme için farklı güvenlik uygulanmasını istiyorsanız, belirli bir düzeltmenin ilkelerini kasıtlı olarak değiştirebilirsiniz. Örneğin, dış arayanların hala geliştirme aşamasında olan bir düzeltmeye erişmesini önlemek için bir IP filtreleme ilkesi eklemek isteyebilirsiniz.

Uyarı

;rev={id} URI yoluna değil API kimliğine eklenmelidir.

Geçerli revizyon

Geçerli düzeltme olarak tek bir düzeltme ayarlanabilir. Bu düzeltme, URL'de açık bir düzeltme numarası belirtmeyen tüm API istekleri için kullanılan düzeltmedir. Bu düzeltmeyi geçerli olarak ayarlayarak önceki bir düzeltmeye geri dönebilirsiniz.

Azure portalını kullanarak bir düzeltmeyi geçerli olarak ayarlayabilirsiniz. PowerShell kullanıyorsanız cmdlet'ini New-AzApiManagementApiRelease kullanabilirsiniz.

Düzeltme açıklamaları

Bir düzeltme oluşturduğunuzda, kendi izleme amaçlarınız için bir açıklama ayarlayabilirsiniz. Açıklamalar API kullanıcılarınıza görüntülenmez.

Bir düzeltmeyi geçerli olarak ayarladığınızda isteğe bağlı olarak bir genel değişiklik günlüğü notu da belirtebilirsiniz. Değişiklik günlüğü, API kullanıcılarınızın görüntülemesi için geliştirici portalına eklenir. PowerShell cmdlet'ini Update-AzApiManagementApiRelease kullanarak değişiklik günlüğü notunuzu değiştirebilirsiniz.

Dikkat

Bir API'nin geçerli olmayan bir düzeltmesini düzenliyorsanız, aşağıdaki özellikleri değiştiremezsiniz:

• İsim
• Türü
• Açıklama
• Abonelik gerekiyor
• API sürümü
• API sürümü açıklaması
• Yol
• Protokol

Bu özellikler yalnızca geçerli düzeltmede değiştirilebilir. Düzenlemeleriniz geçerli olmayan bir düzeltmede bu özelliklerden herhangi birini değiştirirse hata iletisi Can't change property for non-current revision görüntülenir.

Düzeltmeyi çevrimdışına alma

Düzeltme çevrimdışı duruma getirilebilir ve bu da düzeltmeye URL'si üzerinden erişmeye çalışsalar bile arayanlar tarafından erişilemez hale gelir. Azure portalını kullanarak bir düzeltmeyi çevrimdışı olarak işaretleyebilirsiniz.

Uyarı

Düzeltmeleri test için kullanmadığınızda çevrimdışı duruma getirmenizi öneririz.

Sürümler ve düzeltmeler

Sürümler ve düzeltmeler ayrı özelliklerdir. Her sürümde, sürüm kontrollü olmayan API gibi birden fazla revizyon yapılabilir. Sürümleri kullanmadan veya başka bir yolla düzeltmeleri kullanabilirsiniz. Normalde sürümler, API sürümlerini hataya neden olan değişikliklerle ayırmak için kullanılırken, düzeltmeler api'de küçük ve hataya neden olmayan değişiklikler için kullanılabilir.

Düzeltmenizde hataya neden olan değişiklikler varsa veya düzeltmenizi resmi olarak beta/test sürümüne dönüştürmek istiyorsanız, düzeltmeden bir sürüm oluşturabilirsiniz. Azure portalını kullanarak Düzeltmeler sekmesindeki düzeltme bağlam menüsünden 'Düzeltmeden Sürüm Oluştur'u seçin.