Aracılığıyla paylaş


Api Management Service - Update

Mevcut bir API Management hizmetini güncelleştirir.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
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.

api-version
query True

string

minLength: 1

Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name Tür Description
identity

ApiManagementServiceIdentity

Api Management hizmetinin yönetilen hizmet kimliği.

properties.additionalLocations

AdditionalLocation[]

API Management hizmetinin ek veri merkezi konumları.

properties.apiVersionConstraint

ApiVersionConstraint

API Management hizmeti için Denetim Düzlemi API'leri sürüm kısıtlaması.

properties.certificates

CertificateConfiguration[]

API Management hizmetinde yüklenmesi gereken Sertifikaların listesi. Yüklenebilen desteklenen en fazla sertifika 10'dur.

properties.configurationApi

ConfigurationApi

API Management hizmetinin yapılandırma API yapılandırması.

properties.customProperties

object

API Management hizmetinin özel özellikleri.
Ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 tüm TLS(1.0, 1.1 ve 1.2) için şifreleme TLS_RSA_WITH_3DES_EDE_CBC_SHA devre dışı bırakır.
Ayar Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 yalnızca TLS 1.1'i devre dışı bırakmak için kullanılabilir.
Ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10, API Management hizmetinde TLS 1.0'ı devre dışı bırakmak için kullanılabilir.
Ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11, arka uçlarla yapılan iletişimlerde yalnızca TLS 1.1'i devre dışı bırakmak için kullanılabilir.
Ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10, arka uçlarla yapılan iletişimlerde TLS 1.0'ı devre dışı bırakmak için kullanılabilir.
Ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2, BIR API Management hizmetinde HTTP2 protokollerini etkinleştirmek için kullanılabilir.
PATCH işleminde bu özelliklerden herhangi birini belirtmemek atlanmış özelliklerin değerlerini varsayılan değerlerine sıfırlar. Http2 dışındaki tüm ayarlar için, hizmet 1 Nisan 2018 tarihinde veya öncesinde oluşturulduysa ve True değilse varsayılan değer False. Http2 ayarının varsayılan değeri False.

Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]ayarlarını kullanarak aşağıdaki şifrelerden herhangi birini devre dışı bırakabilirsiniz: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Örneğin, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Varsayılan değer onlar için true.
Not: İç platform bileşenleri için gerekli olduğundan aşağıdaki şifreler devre dışı bırakılamaz: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256

properties.developerPortalStatus

developerPortalStatus

Bu API Management hizmetindeki geliştirici portalının durumu.

properties.disableGateway

boolean

Özellik yalnızca birden çok konuma dağıtılan bir Api Management hizmeti için geçerlidir. Bu, ana bölgede ağ geçidini devre dışı bırakmak için kullanılabilir.

properties.enableClientCertificate

boolean

Özellik yalnızca Tüketim SKU Hizmeti için kullanılacaktır. Bu, ağ geçidine yapılan her istekte bir istemci sertifikasının sunulmasını zorlar. Bu, ağ geçidindeki ilkede sertifikanın kimliğini doğrulama olanağı da sağlar.

properties.hostnameConfigurations

HostnameConfiguration[]

API Management hizmetinin özel ana bilgisayar adı yapılandırması.

properties.legacyPortalStatus

LegacyPortalStatus

API Management hizmetindeki eski portalın durumu.

properties.natGatewayState

NatGatewayState

Özellik, bu API Management hizmeti için NAT Gateway'i etkinleştirmek için kullanılabilir.

properties.notificationSenderEmail

string

maxLength: 100

Bildirimin gönderileceği e-posta adresi.

properties.privateEndpointConnections

RemotePrivateEndpointConnectionWrapper[]

Bu hizmetin Özel Uç Nokta Bağlantılarının listesi.

properties.publicIpAddressId

string

Bölgede Sanal Ağ ile dağıtılan hizmetle ilişkilendirilecek Genel Standart SKU IP V4 tabanlı IP adresi. Yalnızca Sanal Ağda dağıtılan Geliştirici ve Premium SKU için desteklenir.

properties.publicNetworkAccess

PublicNetworkAccess

Bu API Management hizmeti için genel uç nokta erişimine izin verilip verilmeyeceği. Değer isteğe bağlıdır, ancak geçirilirse 'Etkin' veya 'Devre Dışı' olmalıdır. 'Devre dışı' ise özel uç noktalar özel erişim yöntemidir. Varsayılan değer 'Etkin'

properties.publisherEmail

string

maxLength: 100

Yayımcı e-postası.

properties.publisherName

string

maxLength: 100

Yayımcı adı.

properties.restore

boolean

Daha önce geçici olarak silinmişse Api Management Hizmeti'nin geri alma işlemini kaldırın. Bu bayrak belirtilirse ve True olarak ayarlanırsa diğer tüm özellikler yoksayılır.

properties.virtualNetworkConfiguration

VirtualNetworkConfiguration

API Management hizmetinin sanal ağ yapılandırması.

properties.virtualNetworkType

VirtualNetworkType

API Management hizmetinin yapılandırılması gereken VPN türü. Hiçbiri (Varsayılan Değer), API Management hizmetinin herhangi bir Sanal Ağın parçası olmadığı anlamına gelir; Dış, API Management dağıtımının İnternet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı ve İç, API Management dağıtımının yalnızca Intranet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı anlamına gelir.

sku

ApiManagementServiceSkuProperties

API Management hizmetinin SKU özellikleri.

tags

object

Kaynak etiketleri.

zones

string[]

Kaynağın nereden gelmesi gerektiğini belirten kullanılabilirlik alanlarının listesi.

Yanıtlar

Name Tür Description
200 OK

ApiManagementServiceResource

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

202 Accepted

Hizmet güncelleştirme isteği Kabul Edildi oldu.

Üst Bilgiler

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

ApiManagementUpdateServiceDisableTls10
ApiManagementUpdateServicePublisherDetails
ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

ApiManagementUpdateServiceDisableTls10

Örnek isteği

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

{
  "properties": {
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false"
    }
  }
}

Örnek yanıt

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "sasolank",
    "UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3",
    "Reserved": "",
    "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT",
    "Pool": "Manual",
    "TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT"
  },
  "location": "West US",
  "etag": "AAAAAAAYRPs=",
  "properties": {
    "publisherEmail": "admin@live.com",
    "publisherName": "Contoso",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2017-06-29T17:50:42.3191122Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [],
    "publicIPAddresses": [
      "40.86.176.232"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False"
    },
    "virtualNetworkType": "None"
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  }
}

ApiManagementUpdateServicePublisherDetails

Örnek isteği

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

{
  "properties": {
    "publisherEmail": "foobar@live.com",
    "publisherName": "Contoso Vnext"
  }
}

Örnek yanıt

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "sasolank",
    "UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3",
    "Reserved": "",
    "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT",
    "Pool": "Manual",
    "TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT"
  },
  "location": "West US",
  "etag": "AAAAAAAYRPs=",
  "properties": {
    "publisherEmail": "foobar@live.com",
    "publisherName": "Contoso Vnext",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2017-06-29T17:50:42.3191122Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [],
    "publicIPAddresses": [
      "40.86.176.232"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False"
    },
    "virtualNetworkType": "None"
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  }
}

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

Örnek isteği

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

{
  "properties": {
    "additionalLocations": [
      {
        "location": "Australia East",
        "sku": {
          "name": "Premium",
          "capacity": 3
        },
        "zones": [
          "1",
          "2",
          "3"
        ],
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"
        },
        "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip"
      }
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"
    },
    "virtualNetworkType": "External",
    "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east"
  },
  "sku": {
    "name": "Premium",
    "capacity": 3
  },
  "zones": [
    "1",
    "2",
    "3"
  ]
}

Örnek yanıt

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "location": "Japan East",
  "etag": "AAAAAAAWBIU=",
  "properties": {
    "publisherEmail": "contoso@microsoft.com",
    "publisherName": "apimPublisher",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2021-04-08T23:41:35.6447381Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-japaneast-01.regional.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false,
        "certificateSource": "BuiltIn"
      },
      {
        "type": "Proxy",
        "hostName": "mycustomdomain.int-azure-api.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2022-06-09T23:59:59+00:00",
          "thumbprint": "2994B5FFB8F76B3C687D324A8DEE0432C1ED18CD",
          "subject": "CN=mycustomdomain.int-azure-api.net"
        },
        "defaultSslBinding": true,
        "certificateSource": "Managed"
      }
    ],
    "publicIPAddresses": [
      "20.78.248.217"
    ],
    "additionalLocations": [
      {
        "location": "Australia East",
        "sku": {
          "name": "Premium",
          "capacity": 3
        },
        "zones": [
          "1",
          "2",
          "3"
        ],
        "publicIPAddresses": [
          "20.213.1.35"
        ],
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"
        },
        "gatewayRegionalUrl": "https://apimService1-australiaeast-01.regional.azure-api.net",
        "disableGateway": false,
        "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip",
        "platformVersion": "stv2"
      }
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"
    },
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false"
    },
    "virtualNetworkType": "Internal",
    "disableGateway": false,
    "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east",
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv2"
  },
  "sku": {
    "name": "Premium",
    "capacity": 3
  },
  "zones": [
    "1",
    "2",
    "3"
  ],
  "systemData": {
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-01-21T20:04:21.6108974Z"
  }
}

Tanımlar

Name Description
AdditionalLocation

Ek API Management kaynak konumunun açıklaması.

ApiManagementServiceIdentity

Api Management hizmet kaynağının kimlik özellikleri.

ApiManagementServiceResource

Liste veya Yanıt al'da tek bir API Management hizmet kaynağı.

ApiManagementServiceSkuProperties

API Management hizmeti kaynak SKU özellikleri.

ApiManagementServiceUpdateParameters

Güncelleştirme Api Management Hizmeti'ne sağlanan parametre.

ApimIdentityType

Kaynak için kullanılan kimlik türü. 'SystemAssigned, UserAssigned' türü hem örtük olarak oluşturulmuş bir kimliği hem de kullanıcı tarafından atanan bir kimlik kümesini içerir. 'Hiçbiri' türü hizmetten tüm kimlikleri kaldırır.

ApiVersionConstraint

API Management hizmeti için Denetim Düzlemi API'leri sürüm kısıtlaması.

ArmIdWrapper

ARM kaynak kimliği için sarmalayıcı

CertificateConfiguration

Güvenilir olmayan ara ve kök sertifikalardan oluşan sertifika yapılandırması.

CertificateInformation

SSL sertifika bilgileri.

CertificateSource

Sertifika Kaynağı.

CertificateStatus

Sertifika Durumu.

ConfigurationApi

API Management hizmetinin Yapılandırma API'sine ilişkin bilgiler.

createdByType

Kaynağı oluşturan kimliğin türü.

developerPortalStatus

Bu API Management hizmetindeki geliştirici portalının durumu.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

ErrorDetail

Hata ayrıntısı.

ErrorResponse

Hata yanıtı

HostnameConfiguration

Özel konak adı yapılandırması.

HostnameType

Ana bilgisayar adı türü.

LegacyApiState

API Management hizmetinde eski Yapılandırma API'sinin (v1) kullanıma açılıp sunulmayacağının göstergesi. Değer isteğe bağlıdır ancak 'Etkin' veya 'Devre Dışı' olmalıdır. 'Devre dışı' ise, şirket içinde barındırılan ağ geçitleri için eski Yapılandırma API'si (v1) kullanılamaz. Varsayılan değer 'Etkin'

LegacyPortalStatus

API Management hizmetindeki eski portalın durumu.

NatGatewayState

Özellik, bu API Management hizmeti için NAT Gateway'i etkinleştirmek için kullanılabilir.

PlatformVersion

Hizmeti çalıştıran İşlem Platformu Sürümü.

PrivateEndpointServiceConnectionStatus

Özel uç nokta bağlantı durumu.

PrivateLinkServiceConnectionState

Hizmet tüketicisi ile sağlayıcı arasındaki bağlantının durumu hakkında bilgi koleksiyonu.

PublicNetworkAccess

Bu API Management hizmeti için genel uç nokta erişimine izin verilip verilmeyeceği. Değer isteğe bağlıdır, ancak geçirilirse 'Etkin' veya 'Devre Dışı' olmalıdır. 'Devre dışı' ise özel uç noktalar özel erişim yöntemidir. Varsayılan değer 'Etkin'

RemotePrivateEndpointConnectionWrapper

Uzak Özel Uç Nokta Bağlantı kaynağı.

SkuType

Sku'nun adı.

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

UserIdentityProperties
VirtualNetworkConfiguration

API Management hizmetinin dağıtıldığı bir sanal ağın yapılandırması.

VirtualNetworkType

API Management hizmetinin yapılandırılması gereken VPN türü. Hiçbiri (Varsayılan Değer), API Management hizmetinin herhangi bir Sanal Ağın parçası olmadığı anlamına gelir; Dış, API Management dağıtımının İnternet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı ve İç, API Management dağıtımının yalnızca Intranet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı anlamına gelir.

AdditionalLocation

Ek API Management kaynak konumunun açıklaması.

Name Tür Default value Description
disableGateway

boolean

False

Özellik yalnızca birden çok konuma dağıtılan bir Api Management hizmeti için geçerlidir. Bu, ağ geçidini bu ek konumda devre dışı bırakmak için kullanılabilir.

gatewayRegionalUrl

string

Bölgedeki API Management hizmetinin ağ geçidi URL'si.

location

string

Azure Veri merkezi bölgeleri arasındaki ek bölgenin konum adı.

natGatewayState

NatGatewayState

Disabled

Özellik, bu API Management hizmeti için NAT Gateway'i etkinleştirmek için kullanılabilir.

outboundPublicIPAddresses

string[]

NAT Ağ Geçidi dağıtılan hizmetiyle ilişkili giden genel IPV4 adresi ön ekleri. Yalnızca stv2 platformunda Premium SKU için kullanılabilir.

platformVersion

PlatformVersion

Hizmeti çalıştıran İşlem Platformu Sürümü.

privateIPAddresses

string[]

Belirli bir ek konumdaki bir İç Sanal Ağa dağıtılan API Management hizmetinin Özel Statik Yük Dengeli IP adresleri. Yalnızca Temel, Standart, Premium ve Yalıtılmış SKU için kullanılabilir.

publicIPAddresses

string[]

Ek konumda API Management hizmetinin Genel Statik Yük Dengeli IP adresleri. Yalnızca Temel, Standart, Premium ve Yalıtılmış SKU için kullanılabilir.

publicIpAddressId

string

Genel Standart SKU IP V4 tabanlı IP adresi, konumda Sanal Ağ tarafından dağıtılan hizmetle ilişkilendirilecek. Yalnızca Sanal Ağ'da dağıtılan Premium SKU için desteklenir.

sku

ApiManagementServiceSkuProperties

API Management hizmetinin SKU özellikleri.

virtualNetworkConfiguration

VirtualNetworkConfiguration

Konum için sanal ağ yapılandırması.

zones

string[]

Kaynağın nereden gelmesi gerektiğini belirten kullanılabilirlik alanlarının listesi.

ApiManagementServiceIdentity

Api Management hizmet kaynağının kimlik özellikleri.

Name Tür Description
principalId

string (uuid)

Kimliğin asıl kimliği.

tenantId

string (uuid)

Kimliğin istemci kiracı kimliği.

type

ApimIdentityType

Kaynak için kullanılan kimlik türü. 'SystemAssigned, UserAssigned' türü hem örtük olarak oluşturulmuş bir kimliği hem de kullanıcı tarafından atanan bir kimlik kümesini içerir. 'Hiçbiri' türü hizmetten tüm kimlikleri kaldırır.

userAssignedIdentities

<string,  UserIdentityProperties>

Kaynakla ilişkili kullanıcı kimliklerinin listesi. Kullanıcı kimliği sözlüğü anahtar başvuruları şu biçimde ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ApiManagementServiceResource

Liste veya Yanıt al'da tek bir API Management hizmet kaynağı.

Name Tür Default value Description
etag

string

Kaynağın ETag'i.

id

string

Kaynak Kimliği.

identity

ApiManagementServiceIdentity

Api Management hizmetinin yönetilen hizmet kimliği.

location

string

Kaynak konumu.

name

string

Kaynak adı.

properties.additionalLocations

AdditionalLocation[]

API Management hizmetinin ek veri merkezi konumları.

properties.apiVersionConstraint

ApiVersionConstraint

API Management hizmeti için Denetim Düzlemi API'leri sürüm kısıtlaması.

properties.certificates

CertificateConfiguration[]

API Management hizmetinde yüklenmesi gereken Sertifikaların listesi. Yüklenebilen desteklenen en fazla sertifika 10'dur.

properties.configurationApi

ConfigurationApi

API Management hizmetinin yapılandırma API yapılandırması.

properties.createdAtUtc

string (date-time)

API Management hizmetinin oluşturma UTC tarihi. Tarih şu biçime uygundur: ISO 8601 standardı tarafından belirtilen yyyy-MM-ddTHH:mm:ssZ.

properties.customProperties

object

API Management hizmetinin özel özellikleri.
Ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 tüm TLS(1.0, 1.1 ve 1.2) için şifreleme TLS_RSA_WITH_3DES_EDE_CBC_SHA devre dışı bırakır.
Ayar Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 yalnızca TLS 1.1'i devre dışı bırakmak için kullanılabilir.
Ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10, API Management hizmetinde TLS 1.0'ı devre dışı bırakmak için kullanılabilir.
Ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11, arka uçlarla yapılan iletişimlerde yalnızca TLS 1.1'i devre dışı bırakmak için kullanılabilir.
Ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10, arka uçlarla yapılan iletişimlerde TLS 1.0'ı devre dışı bırakmak için kullanılabilir.
Ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2, BIR API Management hizmetinde HTTP2 protokollerini etkinleştirmek için kullanılabilir.
PATCH işleminde bu özelliklerden herhangi birini belirtmemek atlanmış özelliklerin değerlerini varsayılan değerlerine sıfırlar. Http2 dışındaki tüm ayarlar için, hizmet 1 Nisan 2018 tarihinde veya öncesinde oluşturulduysa ve True değilse varsayılan değer False. Http2 ayarının varsayılan değeri False.

Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]ayarlarını kullanarak aşağıdaki şifrelerden herhangi birini devre dışı bırakabilirsiniz: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Örneğin, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Varsayılan değer onlar için true.
Not: İç platform bileşenleri için gerekli olduğundan aşağıdaki şifreler devre dışı bırakılamaz: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256

properties.developerPortalStatus

developerPortalStatus

Enabled

Bu API Management hizmetindeki geliştirici portalının durumu.

properties.developerPortalUrl

string

API Management hizmetinin DEveloper Portal uç nokta URL'si.

properties.disableGateway

boolean

False

Özellik yalnızca birden çok konuma dağıtılan bir Api Management hizmeti için geçerlidir. Bu, ana bölgede ağ geçidini devre dışı bırakmak için kullanılabilir.

properties.enableClientCertificate

boolean

False

Özellik yalnızca Tüketim SKU Hizmeti için kullanılacaktır. Bu, ağ geçidine yapılan her istekte bir istemci sertifikasının sunulmasını zorlar. Bu, ağ geçidindeki ilkede sertifikanın kimliğini doğrulama olanağı da sağlar.

properties.gatewayRegionalUrl

string

Varsayılan Bölgedeki API Management hizmetinin ağ geçidi URL'si.

properties.gatewayUrl

string

API Management hizmetinin ağ geçidi URL'si.

properties.hostnameConfigurations

HostnameConfiguration[]

API Management hizmetinin özel ana bilgisayar adı yapılandırması.

properties.legacyPortalStatus

LegacyPortalStatus

Enabled

API Management hizmetindeki eski portalın durumu.

properties.managementApiUrl

string

API Management hizmetinin Yönetim API'si uç nokta URL'si.

properties.natGatewayState

NatGatewayState

Disabled

Özellik, bu API Management hizmeti için NAT Gateway'i etkinleştirmek için kullanılabilir.

properties.notificationSenderEmail

string

maxLength: 100

Bildirimin gönderileceği e-posta adresi.

properties.outboundPublicIPAddresses

string[]

NAT Ağ Geçidi dağıtılan hizmetiyle ilişkili giden genel IPV4 adresi ön ekleri. Yalnızca stv2 platformunda Premium SKU için kullanılabilir.

properties.platformVersion

PlatformVersion

Hizmeti bu konumda çalıştıran İşlem Platformu Sürümü.

properties.portalUrl

string

Yayımcı portalı uç noktası API Management hizmetinin Url'si.

properties.privateEndpointConnections

RemotePrivateEndpointConnectionWrapper[]

Bu hizmetin Özel Uç Nokta Bağlantılarının listesi.

properties.privateIPAddresses

string[]

Bir İç Sanal Ağa dağıtılan Birincil bölgedeki API Management hizmetinin Özel Statik Yük Dengeli IP adresleri. Yalnızca Temel, Standart, Premium ve Yalıtılmış SKU için kullanılabilir.

properties.provisioningState

string

API Management hizmetinin aşağıdakilerden biri olabilecek geçerli sağlama durumu: Oluşturuldu/Etkinleştirildi/Başarılı/Güncelleştirildi/Başarısız/Durduruldu/Sonlandırılıyor/SonlandırmaKiled/Silindi.

properties.publicIPAddresses

string[]

Birincil bölgedeki API Management hizmetinin Genel Statik Yük Dengeli IP adresleri. Yalnızca Temel, Standart, Premium ve Yalıtılmış SKU için kullanılabilir.

properties.publicIpAddressId

string

Bölgede Sanal Ağ ile dağıtılan hizmetle ilişkilendirilecek Genel Standart SKU IP V4 tabanlı IP adresi. Yalnızca Sanal Ağda dağıtılan Geliştirici ve Premium SKU için desteklenir.

properties.publicNetworkAccess

PublicNetworkAccess

Bu API Management hizmeti için genel uç nokta erişimine izin verilip verilmeyeceği. Değer isteğe bağlıdır, ancak geçirilirse 'Etkin' veya 'Devre Dışı' olmalıdır. 'Devre dışı' ise özel uç noktalar özel erişim yöntemidir. Varsayılan değer 'Etkin'

properties.publisherEmail

string

maxLength: 100

Yayımcı e-postası.

properties.publisherName

string

maxLength: 100

Yayımcı adı.

properties.restore

boolean

False

Daha önce geçici olarak silinmişse Api Management Hizmeti'nin geri alma işlemini kaldırın. Bu bayrak belirtilirse ve True olarak ayarlanırsa diğer tüm özellikler yoksayılır.

properties.scmUrl

string

API Management hizmetinin SCM uç nokta URL'si.

properties.targetProvisioningState

string

Hizmette başlatılan uzun süre çalışan işlem tarafından hedeflenen API Management hizmetinin sağlama durumu.

properties.virtualNetworkConfiguration

VirtualNetworkConfiguration

API Management hizmetinin sanal ağ yapılandırması.

properties.virtualNetworkType

VirtualNetworkType

None

API Management hizmetinin yapılandırılması gereken VPN türü. Hiçbiri (Varsayılan Değer), API Management hizmetinin herhangi bir Sanal Ağın parçası olmadığı anlamına gelir; Dış, API Management dağıtımının İnternet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı ve İç, API Management dağıtımının yalnızca Intranet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı anlamına gelir.

sku

ApiManagementServiceSkuProperties

API Management hizmetinin SKU özellikleri.

systemData

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

tags

object

Kaynak etiketleri.

type

string

API Management kaynağının kaynak türü Microsoft.ApiManagement olarak ayarlanır.

zones

string[]

Kaynağın nereden gelmesi gerektiğini belirten kullanılabilirlik alanlarının listesi.

ApiManagementServiceSkuProperties

API Management hizmeti kaynak SKU özellikleri.

Name Tür Description
capacity

integer (int32)

SKU'nun kapasitesi (SKU'nun dağıtılan birim sayısı). Tüketim SKU'su kapasitesi 0 olarak belirtilmelidir.

name

SkuType

Sku'nun adı.

ApiManagementServiceUpdateParameters

Güncelleştirme Api Management Hizmeti'ne sağlanan parametre.

Name Tür Default value Description
etag

string

Kaynağın ETag'i.

id

string

Kaynak Kimliği.

identity

ApiManagementServiceIdentity

Api Management hizmetinin yönetilen hizmet kimliği.

name

string

Kaynak adı.

properties.additionalLocations

AdditionalLocation[]

API Management hizmetinin ek veri merkezi konumları.

properties.apiVersionConstraint

ApiVersionConstraint

API Management hizmeti için Denetim Düzlemi API'leri sürüm kısıtlaması.

properties.certificates

CertificateConfiguration[]

API Management hizmetinde yüklenmesi gereken Sertifikaların listesi. Yüklenebilen desteklenen en fazla sertifika 10'dur.

properties.configurationApi

ConfigurationApi

API Management hizmetinin yapılandırma API yapılandırması.

properties.createdAtUtc

string (date-time)

API Management hizmetinin oluşturma UTC tarihi. Tarih şu biçime uygundur: ISO 8601 standardı tarafından belirtilen yyyy-MM-ddTHH:mm:ssZ.

properties.customProperties

object

API Management hizmetinin özel özellikleri.
Ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 tüm TLS(1.0, 1.1 ve 1.2) için şifreleme TLS_RSA_WITH_3DES_EDE_CBC_SHA devre dışı bırakır.
Ayar Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 yalnızca TLS 1.1'i devre dışı bırakmak için kullanılabilir.
Ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10, API Management hizmetinde TLS 1.0'ı devre dışı bırakmak için kullanılabilir.
Ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11, arka uçlarla yapılan iletişimlerde yalnızca TLS 1.1'i devre dışı bırakmak için kullanılabilir.
Ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10, arka uçlarla yapılan iletişimlerde TLS 1.0'ı devre dışı bırakmak için kullanılabilir.
Ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2, BIR API Management hizmetinde HTTP2 protokollerini etkinleştirmek için kullanılabilir.
PATCH işleminde bu özelliklerden herhangi birini belirtmemek atlanmış özelliklerin değerlerini varsayılan değerlerine sıfırlar. Http2 dışındaki tüm ayarlar için, hizmet 1 Nisan 2018 tarihinde veya öncesinde oluşturulduysa ve True değilse varsayılan değer False. Http2 ayarının varsayılan değeri False.

Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]ayarlarını kullanarak aşağıdaki şifrelerden herhangi birini devre dışı bırakabilirsiniz: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Örneğin, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Varsayılan değer onlar için true.
Not: İç platform bileşenleri için gerekli olduğundan aşağıdaki şifreler devre dışı bırakılamaz: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256

properties.developerPortalStatus

developerPortalStatus

Enabled

Bu API Management hizmetindeki geliştirici portalının durumu.

properties.developerPortalUrl

string

API Management hizmetinin DEveloper Portal uç nokta URL'si.

properties.disableGateway

boolean

False

Özellik yalnızca birden çok konuma dağıtılan bir Api Management hizmeti için geçerlidir. Bu, ana bölgede ağ geçidini devre dışı bırakmak için kullanılabilir.

properties.enableClientCertificate

boolean

False

Özellik yalnızca Tüketim SKU Hizmeti için kullanılacaktır. Bu, ağ geçidine yapılan her istekte bir istemci sertifikasının sunulmasını zorlar. Bu, ağ geçidindeki ilkede sertifikanın kimliğini doğrulama olanağı da sağlar.

properties.gatewayRegionalUrl

string

Varsayılan Bölgedeki API Management hizmetinin ağ geçidi URL'si.

properties.gatewayUrl

string

API Management hizmetinin ağ geçidi URL'si.

properties.hostnameConfigurations

HostnameConfiguration[]

API Management hizmetinin özel ana bilgisayar adı yapılandırması.

properties.legacyPortalStatus

LegacyPortalStatus

Enabled

API Management hizmetindeki eski portalın durumu.

properties.managementApiUrl

string

API Management hizmetinin Yönetim API'si uç nokta URL'si.

properties.natGatewayState

NatGatewayState

Disabled

Özellik, bu API Management hizmeti için NAT Gateway'i etkinleştirmek için kullanılabilir.

properties.notificationSenderEmail

string

maxLength: 100

Bildirimin gönderileceği e-posta adresi.

properties.outboundPublicIPAddresses

string[]

NAT Ağ Geçidi dağıtılan hizmetiyle ilişkili giden genel IPV4 adresi ön ekleri. Yalnızca stv2 platformunda Premium SKU için kullanılabilir.

properties.platformVersion

PlatformVersion

Hizmeti bu konumda çalıştıran İşlem Platformu Sürümü.

properties.portalUrl

string

Yayımcı portalı uç noktası API Management hizmetinin Url'si.

properties.privateEndpointConnections

RemotePrivateEndpointConnectionWrapper[]

Bu hizmetin Özel Uç Nokta Bağlantılarının listesi.

properties.privateIPAddresses

string[]

Bir İç Sanal Ağa dağıtılan Birincil bölgedeki API Management hizmetinin Özel Statik Yük Dengeli IP adresleri. Yalnızca Temel, Standart, Premium ve Yalıtılmış SKU için kullanılabilir.

properties.provisioningState

string

API Management hizmetinin aşağıdakilerden biri olabilecek geçerli sağlama durumu: Oluşturuldu/Etkinleştirildi/Başarılı/Güncelleştirildi/Başarısız/Durduruldu/Sonlandırılıyor/SonlandırmaKiled/Silindi.

properties.publicIPAddresses

string[]

Birincil bölgedeki API Management hizmetinin Genel Statik Yük Dengeli IP adresleri. Yalnızca Temel, Standart, Premium ve Yalıtılmış SKU için kullanılabilir.

properties.publicIpAddressId

string

Bölgede Sanal Ağ ile dağıtılan hizmetle ilişkilendirilecek Genel Standart SKU IP V4 tabanlı IP adresi. Yalnızca Sanal Ağda dağıtılan Geliştirici ve Premium SKU için desteklenir.

properties.publicNetworkAccess

PublicNetworkAccess

Bu API Management hizmeti için genel uç nokta erişimine izin verilip verilmeyeceği. Değer isteğe bağlıdır, ancak geçirilirse 'Etkin' veya 'Devre Dışı' olmalıdır. 'Devre dışı' ise özel uç noktalar özel erişim yöntemidir. Varsayılan değer 'Etkin'

properties.publisherEmail

string

maxLength: 100

Yayımcı e-postası.

properties.publisherName

string

maxLength: 100

Yayımcı adı.

properties.restore

boolean

False

Daha önce geçici olarak silinmişse Api Management Hizmeti'nin geri alma işlemini kaldırın. Bu bayrak belirtilirse ve True olarak ayarlanırsa diğer tüm özellikler yoksayılır.

properties.scmUrl

string

API Management hizmetinin SCM uç nokta URL'si.

properties.targetProvisioningState

string

Hizmette başlatılan uzun süre çalışan işlem tarafından hedeflenen API Management hizmetinin sağlama durumu.

properties.virtualNetworkConfiguration

VirtualNetworkConfiguration

API Management hizmetinin sanal ağ yapılandırması.

properties.virtualNetworkType

VirtualNetworkType

None

API Management hizmetinin yapılandırılması gereken VPN türü. Hiçbiri (Varsayılan Değer), API Management hizmetinin herhangi bir Sanal Ağın parçası olmadığı anlamına gelir; Dış, API Management dağıtımının İnternet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı ve İç, API Management dağıtımının yalnızca Intranet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı anlamına gelir.

sku

ApiManagementServiceSkuProperties

API Management hizmetinin SKU özellikleri.

tags

object

Kaynak etiketleri.

type

string

API Management kaynağının kaynak türü Microsoft.ApiManagement olarak ayarlanır.

zones

string[]

Kaynağın nereden gelmesi gerektiğini belirten kullanılabilirlik alanlarının listesi.

ApimIdentityType

Kaynak için kullanılan kimlik türü. 'SystemAssigned, UserAssigned' türü hem örtük olarak oluşturulmuş bir kimliği hem de kullanıcı tarafından atanan bir kimlik kümesini içerir. 'Hiçbiri' türü hizmetten tüm kimlikleri kaldırır.

Değer Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

ApiVersionConstraint

API Management hizmeti için Denetim Düzlemi API'leri sürüm kısıtlaması.

Name Tür Description
minApiVersion

string

Api Management hizmetine yapılan denetim düzlemi API çağrılarını bu değere eşit veya bundan daha yeni bir sürümle sınırlayın.

ArmIdWrapper

ARM kaynak kimliği için sarmalayıcı

Name Tür Description
id

string

CertificateConfiguration

Güvenilir olmayan ara ve kök sertifikalardan oluşan sertifika yapılandırması.

Name Tür Description
certificate

CertificateInformation

Sertifika bilgileri.

certificatePassword

string

Sertifika Parolası.

encodedCertificate

string

Base64 Kodlanmış sertifika.

storeName enum:
  • CertificateAuthority
  • Root

System.Security.Cryptography.x509certificates.StoreName sertifika deposu konumu. Yalnızca Kök ve CertificateAuthority geçerli konumlardır.

CertificateInformation

SSL sertifika bilgileri.

Name Tür Description
expiry

string (date-time)

Sertifikanın son kullanma tarihi. Tarih şu biçime uygundur: ISO 8601 standardı tarafından belirtilen yyyy-MM-ddTHH:mm:ssZ.

subject

string

Sertifikanın konusu.

thumbprint

string

Sertifikanın parmak izi.

CertificateSource

Sertifika Kaynağı.

Değer Description
Managed
KeyVault
Custom
BuiltIn

CertificateStatus

Sertifika Durumu.

Değer Description
Completed
Failed
InProgress

ConfigurationApi

API Management hizmetinin Yapılandırma API'sine ilişkin bilgiler.

Name Tür Default value Description
legacyApi

LegacyApiState

Enabled

API Management hizmetinde eski Yapılandırma API'sinin (v1) kullanıma açılıp sunulmayacağının göstergesi. Değer isteğe bağlıdır ancak 'Etkin' veya 'Devre Dışı' olmalıdır. 'Devre dışı' ise, şirket içinde barındırılan ağ geçitleri için eski Yapılandırma API'si (v1) kullanılamaz. Varsayılan değer 'Etkin'

createdByType

Kaynağı oluşturan kimliğin türü.

Değer Description
User
Application
ManagedIdentity
Key

developerPortalStatus

Bu API Management hizmetindeki geliştirici portalının durumu.

Değer Description
Enabled

Geliştirici Portalı hizmet için etkinleştirildi.

Disabled

Geliştirici Portalı hizmet için devre dışı bırakıldı.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name Tür Description
info

object

Ek bilgiler.

type

string

Ek bilgi türü.

ErrorDetail

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

Hata yanıtı

Name Tür Description
error

ErrorDetail

Hata nesnesi.

HostnameConfiguration

Özel konak adı yapılandırması.

Name Tür Default value Description
certificate

CertificateInformation

Sertifika bilgileri.

certificatePassword

string

Sertifika Parolası.

certificateSource

CertificateSource

Sertifika Kaynağı.

certificateStatus

CertificateStatus

Sertifika Durumu.

defaultSslBinding

boolean

False

Bu Konak adıyla ilişkili sertifikayı Varsayılan SSL Sertifikası olarak ayarlamak için true değerini belirtin. bir istemci SNI üst bilgisini göndermezse, bu sorgulanacak sertifika olacaktır. Özelliği, bir hizmetin birden çok özel ana bilgisayar adı etkinleştirilmişse ve varsayılan ssl sertifikasına karar vermesi gerekiyorsa kullanışlıdır. Ayar yalnızca ağ geçidi Ana Bilgisayar Adı Türüne uygulanır.

encodedCertificate

string

Base64 Kodlanmış sertifika.

hostName

string

Api Management hizmetinde yapılandırılan ana bilgisayar adı.

identityClientId

string

Azure AD tarafından oluşturulan ve SSL sertifikasını içeren keyVault anahtarına GET erişimi olan Sistem veya Kullanıcı Tarafından Atanan Yönetilen kimlik clientId değeri.

keyVaultId

string

Ssl Sertifikasını içeren KeyVault Gizli Dizisi url'si. Sürüm içeren mutlak Url sağlanırsa ssl sertifikasının otomatik olarak güncelleştirilmesi çalışmaz. Bunun için Api Management hizmetinin aka.ms/apimmsi ile yapılandırılması gerekir. Gizli dizi application/x-pkcs12 türünde olmalıdır

negotiateClientCertificate

boolean

False

Ana bilgisayar adında istemci sertifikası üzerinde her zaman anlaşmak için true değerini belirtin. Varsayılan Değer false'tur.

type

HostnameType

Ana bilgisayar adı türü.

HostnameType

Ana bilgisayar adı türü.

Değer Description
Proxy
Portal
Management
Scm
DeveloperPortal
ConfigurationApi

LegacyApiState

API Management hizmetinde eski Yapılandırma API'sinin (v1) kullanıma açılıp sunulmayacağının göstergesi. Değer isteğe bağlıdır ancak 'Etkin' veya 'Devre Dışı' olmalıdır. 'Devre dışı' ise, şirket içinde barındırılan ağ geçitleri için eski Yapılandırma API'si (v1) kullanılamaz. Varsayılan değer 'Etkin'

Değer Description
Enabled

Eski Yapılandırma API'si (v1) hizmet için etkinleştirilir ve şirket içinde barındırılan ağ geçitleri buna bağlanabilir.

Disabled

Eski Yapılandırma API'si (v1) hizmet için devre dışı bırakıldı ve şirket içinde barındırılan ağ geçitleri buna bağlanamıyor.

LegacyPortalStatus

API Management hizmetindeki eski portalın durumu.

Değer Description
Enabled

Eski Portal hizmet için etkinleştirildi.

Disabled

Eski Portal hizmet için devre dışı bırakıldı.

NatGatewayState

Özellik, bu API Management hizmeti için NAT Gateway'i etkinleştirmek için kullanılabilir.

Değer Description
Enabled

Nat Gateway hizmet için etkinleştirildi.

Disabled

Nat Gateway hizmet için devre dışı bırakıldı.

PlatformVersion

Hizmeti çalıştıran İşlem Platformu Sürümü.

Değer Description
undetermined

İşlem platformu dağıtılmadığından platform sürümü belirlenemiyor.

stv1

Hizmeti Tek Kiracılı V1 platformunda çalıştıran platform.

stv2

Hizmeti Tek Kiracılı V2 platformunda çalıştıran platform.

mtv1

Hizmeti Çok Kiracılı V1 platformunda çalıştıran platform.

stv2.1

Hizmeti yeni Donanımda Tek Kiracılı V2 platformunda çalıştıran platform.

PrivateEndpointServiceConnectionStatus

Özel uç nokta bağlantı durumu.

Değer Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Hizmet tüketicisi ile sağlayıcı arasındaki bağlantının durumu hakkında bilgi koleksiyonu.

Name Tür Description
actionsRequired

string

Hizmet sağlayıcısındaki değişikliklerin tüketicide herhangi bir güncelleştirme gerektirip gerektirmediğini belirten bir ileti.

description

string

Bağlantının onaylanması/reddedilmesinin nedeni.

status

PrivateEndpointServiceConnectionStatus

Bağlantının hizmet sahibi tarafından Onaylanıp Reddedildiğini/Kaldırıldığını gösterir.

PublicNetworkAccess

Bu API Management hizmeti için genel uç nokta erişimine izin verilip verilmeyeceği. Değer isteğe bağlıdır, ancak geçirilirse 'Etkin' veya 'Devre Dışı' olmalıdır. 'Devre dışı' ise özel uç noktalar özel erişim yöntemidir. Varsayılan değer 'Etkin'

Değer Description
Enabled
Disabled

RemotePrivateEndpointConnectionWrapper

Uzak Özel Uç Nokta Bağlantı kaynağı.

Name Tür Description
id

string

Özel Uç Nokta bağlantı kaynak kimliği

name

string

Özel Uç Nokta Bağlantı Adı

properties.groupIds

string[]

Tüm Grup kimlikleri.

properties.privateEndpoint

ArmIdWrapper

Özel uç noktanın kaynağı.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Hizmet tüketicisi ile sağlayıcı arasındaki bağlantının durumu hakkında bilgi koleksiyonu.

properties.provisioningState

string

Özel uç nokta bağlantı kaynağının sağlama durumu.

type

string

Özel Uç Nokta Bağlantı Kaynak Türü

SkuType

Sku'nun adı.

Değer Description
Developer

Api Management Geliştirici SKU'su.

Standard

Api Management'ın Standart SKU'su.

Premium

Api Management Premium SKU'su.

Basic

Api Management'ın temel SKU'su.

Consumption

Api Management tüketim SKU'su.

Isolated

Api Management'ın yalıtılmış SKU'su.

BasicV2

Api Management'ın BasicV2 SKU'su.

StandardV2

Api Management StandardV2 SKU'su.

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name Tür Description
createdAt

string (date-time)

Kaynak oluşturma (UTC) zaman damgası.

createdBy

string

Kaynağı oluşturan kimlik.

createdByType

createdByType

Kaynağı oluşturan kimliğin türü.

lastModifiedAt

string (date-time)

Kaynağın son değişikliğinin zaman damgası (UTC)

lastModifiedBy

string

Kaynağı en son değiştiren kimlik.

lastModifiedByType

createdByType

Kaynağı en son değiştiren kimlik türü.

UserIdentityProperties

Name Tür Description
clientId

string

Kullanıcı tarafından atanan kimliğin istemci kimliği.

principalId

string

Kullanıcı tarafından atanan kimliğin asıl kimliği.

VirtualNetworkConfiguration

API Management hizmetinin dağıtıldığı bir sanal ağın yapılandırması.

Name Tür Description
subnetResourceId

string

pattern: ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$

API Management hizmetinin dağıtılacağı sanal ağdaki bir alt ağın tam kaynak kimliği.

subnetname

string

Alt ağın adı.

vnetid

string

Sanal ağ kimliği. Bu genellikle bir GUID'dir. Varsayılan olarak null GUID bekleyebilirsiniz.

VirtualNetworkType

API Management hizmetinin yapılandırılması gereken VPN türü. Hiçbiri (Varsayılan Değer), API Management hizmetinin herhangi bir Sanal Ağın parçası olmadığı anlamına gelir; Dış, API Management dağıtımının İnternet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı ve İç, API Management dağıtımının yalnızca Intranet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı anlamına gelir.

Değer Description
None

Hizmet herhangi bir Sanal Ağın parçası değildir.

External

Hizmet Sanal Ağ'ın bir parçasıdır ve İnternet'ten erişilebilir.

Internal

Hizmet Sanal Ağ'ın bir parçasıdır ve yalnızca sanal ağ içinden erişilebilir.