Workspace Api - Update

Hizmet:: API Management

API Sürümü:: 2024-05-01

Bir API Management hizmet örneğinde çalışma alanının belirtilen API'sini güncelleştirir.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}?api-version=2024-05-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	API düzeltme 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.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management hizmetinin adı.
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Çalışma alanı tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
If-Match	True	string	Varlığın ETag'i. ETag, GET isteğinin üst bilgi yanıtından geçerli varlık durumuyla eşleşmeli veya koşulsuz güncelleştirme için * olmalıdır.

İstek Gövdesi

Name	Tür	Description
properties.apiRevision	string minLength: 1 maxLength: 100	API'nin düzeltmesini açıklar. Değer sağlanmazsa, varsayılan düzeltme 1 oluşturulur
properties.apiRevisionDescription	string maxLength: 256	API Düzeltmesi'nin açıklaması.
properties.apiVersion	string maxLength: 100	API sürümlendiyse API'nin sürüm tanımlayıcısını gösterir
properties.apiVersionDescription	string maxLength: 256	API Sürümünün açıklaması.
properties.apiVersionSetId	string	İlgili ApiVersionSet için kaynak tanımlayıcısı.
properties.authenticationSettings	AuthenticationSettingsContract	Bu API'ye dahil edilen kimlik doğrulama ayarlarının koleksiyonu.
properties.contact	ApiContactInformation	API için iletişim bilgileri.
properties.description	string	API'nin açıklaması. HTML biçimlendirme etiketleri içerebilir.
properties.displayName	string minLength: 1 maxLength: 300	API adı.
properties.isCurrent	boolean	API düzeltmenin geçerli API düzeltmesi olup olmadığını gösterir.
properties.license	ApiLicenseInformation	API için lisans bilgileri.
properties.path	string minLength: 0 maxLength: 400	Bu API'yi ve API Management hizmet örneği içindeki tüm kaynak yollarını benzersiz olarak tanımlayan göreli URL. Bu API için genel bir URL oluşturmak üzere hizmet örneği oluşturma sırasında belirtilen API uç nokta temel URL'sine eklenir.
properties.protocols	Protocol[]	Bu API'deki işlemlerin çağrılabileceği protokolleri açıklar.
properties.serviceUrl	string minLength: 1 maxLength: 2000	Bu API'yi uygulayan arka uç hizmetinin mutlak URL'si.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	API'nin kullanılabilir hale getirildiği protokoller.
properties.subscriptionRequired	boolean	API'ye erişmek için bir API'nin mi yoksa Ürün aboneliğinin mi gerekli olduğunu belirtir.
properties.termsOfServiceUrl	string	API için Hizmet Koşulları'nın URL'si. URL biçiminde olmalıdır.
properties.type	ApiType	API türü.

Yanıtlar

Name	Tür	Description
200 OK	ApiContract	API başarıyla güncelleştirildi. Üst Bilgiler ETag: string
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Name

Tür

Description

200 OK

ApiContract

API başarıyla güncelleştirildi.

Üst Bilgiler

ETag: string

Other Status Codes

ErrorResponse

İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ApiManagementUpdateWorkspaceApi

Örnek isteği

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api?api-version=2024-05-01


{
  "properties": {
    "displayName": "Echo API New",
    "serviceUrl": "http://echoapi.cloudapp.net/api2",
    "path": "newecho"
  }
}

Örnek yanıt

Durum kodu:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api",
  "type": "Microsoft.ApiManagement/service/workspaces/pis",
  "name": "echo-api",
  "properties": {
    "displayName": "Echo API New",
    "apiRevision": "1",
    "serviceUrl": "http://echoapi.cloudapp.net/api2",
    "path": "newecho",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true,
    "isOnline": true
  }
}

Tanımlar

Name	Description
ApiContactInformation	API iletişim bilgileri
ApiContract	API ayrıntıları.
ApiLicenseInformation	API lisans bilgileri
ApiType	API türü.
ApiUpdateContract	API güncelleştirme sözleşmesi ayrıntıları.
ApiVersionSetContractDetails	API Sürüm Kümesi, ilgili BIR DIZI API Sürümü için ortak yapılandırmayı içerir
AuthenticationSettingsContract	API Kimlik Doğrulama Ayarları.
bearerTokenSendingMethods	Sunucuya belirteç gönderme.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
OAuth2AuthenticationSettingsContract	API OAuth2 Kimlik Doğrulaması ayarları ayrıntıları.
OpenIdAuthenticationSettingsContract	API OAuth2 Kimlik Doğrulaması ayarları ayrıntıları.
Protocol	Bu API'deki işlemlerin çağrılabileceği protokolleri açıklar.
SubscriptionKeyParameterNamesContract	Abonelik anahtarı parametre adları ayrıntıları.
versioningScheme	API Sürüm tanımlayıcısının HTTP isteğinde nerede bulunacağını belirleyen bir değer.

ApiContactInformation

Object

API iletişim bilgileri

Name	Tür	Description
email	string	İlgili kişinin/kuruluşun e-posta adresi. E-posta adresi biçiminde olmalıdır
name	string	İlgili kişinin/kuruluşun tanımlayıcı adı
url	string	kişi bilgilerine işaret eden URL. URL biçiminde olmalıdır

ApiContract

Object

API ayrıntıları.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Örn - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Kaynağın adı
properties.apiRevision	string minLength: 1 maxLength: 100	API'nin düzeltmesini açıklar. Değer sağlanmazsa, varsayılan düzeltme 1 oluşturulur
properties.apiRevisionDescription	string maxLength: 256	API Düzeltmesi'nin açıklaması.
properties.apiVersion	string maxLength: 100	API sürümlendiyse API'nin sürüm tanımlayıcısını gösterir
properties.apiVersionDescription	string maxLength: 256	API Sürümünün açıklaması.
properties.apiVersionSet	ApiVersionSetContractDetails	Sürüm kümesi ayrıntıları
properties.apiVersionSetId	string	İlgili ApiVersionSet için kaynak tanımlayıcısı.
properties.authenticationSettings	AuthenticationSettingsContract	Bu API'ye dahil edilen kimlik doğrulama ayarlarının koleksiyonu.
properties.contact	ApiContactInformation	API için iletişim bilgileri.
properties.description	string	API'nin açıklaması. HTML biçimlendirme etiketleri içerebilir.
properties.displayName	string minLength: 1 maxLength: 300	API adı. 1 ile 300 karakter uzunluğunda olmalıdır.
properties.isCurrent	boolean	API düzeltmenin geçerli API düzeltmesi olup olmadığını gösterir.
properties.isOnline	boolean	API düzeltmesine ağ geçidi üzerinden erişilip erişilmediğini gösterir.
properties.license	ApiLicenseInformation	API için lisans bilgileri.
properties.path	string minLength: 0 maxLength: 400	Bu API'yi ve API Management hizmet örneği içindeki tüm kaynak yollarını benzersiz olarak tanımlayan göreli URL. Bu API için genel bir URL oluşturmak üzere hizmet örneği oluşturma sırasında belirtilen API uç nokta temel URL'sine eklenir.
properties.protocols	Protocol[]	Bu API'deki işlemlerin çağrılabileceği protokolleri açıklar.
properties.provisioningState	string	Sağlama durumu
properties.serviceUrl	string minLength: 0 maxLength: 2000	Bu API'yi uygulayan arka uç hizmetinin mutlak URL'si. 2000 karakterden uzun olamaz.
properties.sourceApiId	string	Kaynak API'nin API tanımlayıcısı.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	API'nin kullanılabilir hale getirildiği protokoller.
properties.subscriptionRequired	boolean	API'ye erişmek için bir API'nin mi yoksa Ürün aboneliğinin mi gerekli olduğunu belirtir.
properties.termsOfServiceUrl	string	API için Hizmet Koşulları'nın URL'si. URL biçiminde olmalıdır.
properties.type	ApiType	API türü.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

Object

API lisans bilgileri

Name	Tür	Description
name	string	API için kullanılan lisans adı
url	string	API için kullanılan lisansın URL'si. URL biçiminde olmalıdır

ApiType

Listeleme

API türü.

Değer	Description
http
soap
websocket
graphql
odata
grpc

ApiUpdateContract

Object

API güncelleştirme sözleşmesi ayrıntıları.

Name	Tür	Description
properties.apiRevision	string minLength: 1 maxLength: 100	API'nin düzeltmesini açıklar. Değer sağlanmazsa, varsayılan düzeltme 1 oluşturulur
properties.apiRevisionDescription	string maxLength: 256	API Düzeltmesi'nin açıklaması.
properties.apiVersion	string maxLength: 100	API sürümlendiyse API'nin sürüm tanımlayıcısını gösterir
properties.apiVersionDescription	string maxLength: 256	API Sürümünün açıklaması.
properties.apiVersionSetId	string	İlgili ApiVersionSet için kaynak tanımlayıcısı.
properties.authenticationSettings	AuthenticationSettingsContract	Bu API'ye dahil edilen kimlik doğrulama ayarlarının koleksiyonu.
properties.contact	ApiContactInformation	API için iletişim bilgileri.
properties.description	string	API'nin açıklaması. HTML biçimlendirme etiketleri içerebilir.
properties.displayName	string minLength: 1 maxLength: 300	API adı.
properties.isCurrent	boolean	API düzeltmenin geçerli API düzeltmesi olup olmadığını gösterir.
properties.isOnline	boolean	API düzeltmesine ağ geçidi üzerinden erişilip erişilmediğini gösterir.
properties.license	ApiLicenseInformation	API için lisans bilgileri.
properties.path	string minLength: 0 maxLength: 400	Bu API'yi ve API Management hizmet örneği içindeki tüm kaynak yollarını benzersiz olarak tanımlayan göreli URL. Bu API için genel bir URL oluşturmak üzere hizmet örneği oluşturma sırasında belirtilen API uç nokta temel URL'sine eklenir.
properties.protocols	Protocol[]	Bu API'deki işlemlerin çağrılabileceği protokolleri açıklar.
properties.serviceUrl	string minLength: 1 maxLength: 2000	Bu API'yi uygulayan arka uç hizmetinin mutlak URL'si.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	API'nin kullanılabilir hale getirildiği protokoller.
properties.subscriptionRequired	boolean	API'ye erişmek için bir API'nin mi yoksa Ürün aboneliğinin mi gerekli olduğunu belirtir.
properties.termsOfServiceUrl	string	API için Hizmet Koşulları'nın URL'si. URL biçiminde olmalıdır.
properties.type	ApiType	API türü.

ApiVersionSetContractDetails

Object

API Sürüm Kümesi, ilgili BIR DIZI API Sürümü için ortak yapılandırmayı içerir

Name	Tür	Description
description	string	API Sürüm Kümesi açıklaması.
id	string	Mevcut API Sürüm Kümesi tanımlayıcısı. Yeni bir Sürüm Kümesi oluşturmak için bu değeri atla.
name	string	API Sürüm Kümesinin görünen Adı.
versionHeaderName	string	VersioningScheme `header`olarak ayarlandıysa API Sürümünü gösteren HTTP üst bilgi parametresinin adı.
versionQueryName	string	VersioningScheme `query`olarak ayarlandıysa API Sürümünü gösteren sorgu parametresinin adı.
versioningScheme	versioningScheme	API Sürüm tanımlayıcısının HTTP isteğinde nerede bulunacağını belirleyen bir değer.

AuthenticationSettingsContract

Object

API Kimlik Doğrulama Ayarları.

Name	Tür	Description
oAuth2	OAuth2AuthenticationSettingsContract	OAuth2 Kimlik Doğrulama ayarları
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Bu API'ye dahil edilen OAuth2 kimlik doğrulama ayarlarının koleksiyonu.
openid	OpenIdAuthenticationSettingsContract	OpenID Connect Kimlik Doğrulama Ayarları
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Bu API'ye dahil edilen Open ID Connect kimlik doğrulama ayarlarının koleksiyonu.

bearerTokenSendingMethods

Listeleme

Sunucuya belirteç gönderme.

Değer	Description
authorizationHeader	Erişim belirteci, Taşıyıcı şeması kullanılarak Yetkilendirme üst bilgisinde iletilir
query	Erişim belirteci sorgu parametresi olarak iletilir.

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Object

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Object

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

OAuth2AuthenticationSettingsContract

Object

API OAuth2 Kimlik Doğrulaması ayarları ayrıntıları.

Name	Tür	Description
authorizationServerId	string	OAuth yetkilendirme sunucusu tanımlayıcısı.
scope	string	işlem kapsamı.

OpenIdAuthenticationSettingsContract

Object

API OAuth2 Kimlik Doğrulaması ayarları ayrıntıları.

Name	Tür	Description
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Sunucuya belirteç gönderme.
openidProviderId	string	OAuth yetkilendirme sunucusu tanımlayıcısı.

Protocol

Listeleme

Bu API'deki işlemlerin çağrılabileceği protokolleri açıklar.

Değer	Description
http
https
ws
wss

SubscriptionKeyParameterNamesContract

Object

Abonelik anahtarı parametre adları ayrıntıları.

Name	Tür	Description
header	string	Abonelik anahtarı üst bilgi adı.
query	string	Abonelik anahtarı sorgu dizesi parametre adı.

versioningScheme

Listeleme

API Sürüm tanımlayıcısının HTTP isteğinde nerede bulunacağını belirleyen bir değer.

Değer	Description
Segment	API Sürümü bir yol kesiminde geçirilir.
Query	API Sürümü bir sorgu parametresinde geçirilir.
Header	API Sürümü bir HTTP üst bilgisinde geçirilir.

Aracılığıyla paylaş

Workspace Api - Update

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

ApiManagementUpdateWorkspaceApi

Örnek isteği

Örnek yanıt

Tanımlar

ApiContactInformation

ApiContract

ApiLicenseInformation

ApiType

ApiUpdateContract

ApiVersionSetContractDetails

AuthenticationSettingsContract

bearerTokenSendingMethods

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

Protocol

SubscriptionKeyParameterNamesContract

versioningScheme