Api Management Service - Refresh Hostnames

Hizmet:: API Management

API Sürümü:: 2025-03-01-preview

Api Management hizmetinde KeyVault'tan gizli olarak yapılandırılan Özel Host Adlarına bağlı SSL sertifikasını zorla yenileyin.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/refreshHostnames?api-version=2025-03-01-preview

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 minLength: 1	Hedef aboneliğin kimliği.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	ApiManagementServiceResource	Azure işlemi başarıyla tamamlandı.
202 Accepted		Kaynak işlemi kabul edildi. Üst Bilgiler Retry-After: integer location: string
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Name

Tür

Description

200 OK

ApiManagementServiceResource

Azure işlemi başarıyla tamamlandı.

202 Accepted

Kaynak işlemi kabul edildi.

Üst Bilgiler

Retry-After: integer
location: string

Other Status Codes

ErrorResponse

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

ApiManagementServiceRefreshKeyVaultHostnames

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/refreshHostnames?api-version=2025-03-01-preview

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_service_refresh_key_vault_hostnames.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.api_management_service.begin_refresh_hostnames(
        resource_group_name="rg1",
        service_name="apimService1",
    ).result()
    print(response)


# x-ms-original-file: 2025-03-01-preview/ApiManagementServiceRefreshKeyVaultHostnames.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Örnek yanıt

Durum kodu:: 200

{
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "etag": "AAAAAAK5GpM=",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "b413456e-a9c8-4242-9754-0a01c061bd41",
    "tenantId": "b413456e-a9c8-4242-9754-0a01c061bd41"
  },
  "location": "West Europe",
  "properties": {
    "additionalLocations": [
      {
        "disableGateway": false,
        "gatewayRegionalUrl": "https://apimService1-northeurope-01.regional.azure-api.net",
        "location": "North Europe",
        "outboundPublicIPAddresses": [
          "4.xxx.40.176"
        ],
        "platformVersion": "stv2",
        "publicIPAddresses": [
          "4.xxx.40.176"
        ],
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimVnet/subnets/default2"
        }
      }
    ],
    "createdAtUtc": "2016-04-12T00:20:15.6018952Z",
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True"
    },
    "developerPortalStatus": "Enabled",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "disableGateway": false,
    "gatewayRegionalUrl": "https://apimService1-westeurope-01.regional.azure-api.net",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "certificateSource": "BuiltIn",
        "defaultSslBinding": false,
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false
      },
      {
        "type": "Proxy",
        "certificate": {
          "expiry": "2025-12-18T11:11:47+00:00",
          "subject": "CN=*.msitesting.net",
          "thumbprint": "9833D531D7A45XXXXXXXXXXXX8BD392E0BD3F"
        },
        "certificateSource": "KeyVault",
        "defaultSslBinding": true,
        "hostName": "proxy.msitesting.net",
        "keyVaultId": "https://apim-msi-keyvault.vault.azure.net/secrets/sslcertificate",
        "negotiateClientCertificate": false
      }
    ],
    "legacyPortalStatus": "Disabled",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "natGatewayState": "Disabled",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "outboundPublicIPAddresses": [
      "57.xxx.61.xx"
    ],
    "platformVersion": "stv2.1",
    "provisioningState": "Succeeded",
    "publicIPAddresses": [
      "XX.153.XX.94"
    ],
    "publicNetworkAccess": "Enabled",
    "publisherEmail": "autorest@contoso.com",
    "publisherName": "Microsoft",
    "releaseChannel": "Default",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1/subnets/default"
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "systemData": {
    "lastModifiedAt": "2024-06-14T17:33:34.8195595Z",
    "lastModifiedBy": "autorest@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {}
}

Durum kodu:: 202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2025-03-01-preview

Tanımlar

Name	Description
AdditionalLocation	Ek bir 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.
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üvenilmeyen ara ürünler ve kök sertifikalardan oluşan sertifika yapılandırması.
CertificateConfigurationStoreName	System.Security.Cryptography.x509certificates.StoreName sertifika deposu konumu. Yalnızca Kök ve CertificateAuthority geçerli konumlardır.
CertificateInformation	SSL sertifika bilgileri.
CertificateSource	Sertifika Kaynağı.
CertificateStatus	Sertifika Durumu.
ConfigurationApi	API Management hizmetinin Yapılandırma API'si ile ilgili 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 ana bilgisayar adı yapılandırması.
HostnameType	Ana bilgisayar adı türü.
LegacyApiState	Eski Yapılandırma API'sinin (v1) API Management hizmetinde kullanıma sunulması gerekip gerekmediğini gösterme. Değer isteğe bağlıdır ancak 'Etkin' veya 'Devre Dışı' olmalıdır. 'Devre Dışı' ise, eski Yapılandırma API'si (v1) şirket içinde barındırılan ağ geçitleri için kullanılamaz. Varsayılan değer 'Etkin'
LegacyPortalStatus	API Management hizmetindeki eski portalın durumu.
NatGatewayState	Özellik, bu API Management hizmeti için NAT Ağ Geçidi'ni 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 verilmediğ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'
ReleaseChannel	Bu API Management hizmetinin Yayın Kanalı.
RemotePrivateEndpointConnectionWrapper	Uzak Özel Uç Nokta Bağlantısı 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 ağ geçidinin yapılandırılması gereken VPN türü.

AdditionalLocation

Nesne

Ek bir 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, bu ek konumdaki ağ geçidini 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 Ağ Geçidi'ni 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[]		Özel Statik Yük Dengelemeli: API Management hizmetinin belirli bir ek konumdaki bir İç Sanal Ağ'da dağıtılan IP adresleri. Yalnızca Temel, Standart, Premium ve Yalıtılmış SKU için kullanılabilir.
publicIPAddresses	string[]		Genel Statik Yük Dengeli Ek konumdaki API Management hizmetinin IP adresleri. Yalnızca Temel, Standart, Premium ve Yalıtılmış SKU için kullanılabilir.
publicIpAddressId	string		Konumda dağıtılan Sanal Ağ hizmetiyle ilişkilendirilecek Genel Standart SKU IP V4 tabanlı IP adresi. 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

Nesne

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

Nesne

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		Kaynağın tam kaynak kimliği. Örn - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ApiManagementServiceIdentity		Api Management hizmetinin yönetilen hizmet kimliği.
location	string		Kaynağın bulunduğu coğrafi konum
name	string		Kaynağın 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		Yapılandırma: API Management hizmetinin API yapılandırması.
properties.createdAtUtc	string (date-time)		API Management hizmetinin oluşturulma UTC tarihi. Tarih aşağıdaki formata uygundur: `yyyy-MM-ddTHH:mm:ssZ` ISO 8601 standardında belirtildiği gibi.
properties.customProperties	object		API Management hizmetinin özel özellikleri. Bu ayar `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` , tüm TLS (1.0, 1.1 ve 1.2) için şifre 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` , bir API Management hizmetinde TLS 1.0'ı devre dışı bırakmak için kullanılabilir. Bu ayar `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` , arka uçlarla iletişim için yalnızca TLS 1.1'i devre dışı bırakmak için kullanılabilir. Bu ayar `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` , arka uçlarla iletişimler için TLS 1.0'ı devre dışı bırakmak için kullanılabilir. Bu ayar `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` , bir API Management hizmetinde HTTP2 protokolünü etkinleştirmek için kullanılabilir. PATCH işleminde bu özelliklerden herhangi birinin belirtilmemesi, atlanan özelliklerin değerlerini varsayılan değerlerine sıfırlar. Http2 dışındaki tüm ayarlar için varsayılan değer, hizmetin 1 Nisan 2018'de `True` veya öncesinde oluşturulup oluşturulmadığıdır`False`. Http2 ayarının varsayılan değeri 'dir `False`. Ayarları `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`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 `true` onlar içindir. Not: Aşağıdaki şifreler, dahili platform bileşenleri için gerekli olduklarından 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		DEveloper Portalı API Management hizmetinin 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ölgedeki 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ç noktası URL'si.
properties.natGatewayState	NatGatewayState	Disabled	Özellik, bu API Management hizmeti için NAT Ağ Geçidi'ni 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[]		Özel Statik Yük Dengelemeli: Bir İç Sanal Ağ'da dağıtılan Birincil bölgedeki API Management hizmetinin IP adresleri. Yalnızca Temel, Standart, Premium ve Yalıtılmış SKU için kullanılabilir.
properties.provisioningState	string		API Management hizmetinin geçerli sağlama durumu şunlardan biri olabilir: Oluşturuldu/Etkinleştiriliyor/Başarılı/Güncelleniyor/Başarısız/Durduruldu/Sonlandırılıyor/Sonlandırıldı/Sonlandırıldı/Silindi.
properties.publicIPAddresses	string[]		Genel Statik Yük Dengeli Birincil bölgedeki API Management hizmetinin IP adresleri. Yalnızca Temel, Standart, Premium ve Yalıtılmış SKU için kullanılabilir.
properties.publicIpAddressId	string		Bölgede dağıtılan Sanal Ağ hizmetiyle 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 verilmediğ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.releaseChannel	ReleaseChannel		Bu API Management hizmetinin Yayın Kanalı.
properties.restore	boolean	False	Daha önce geçici olarak silinmişse Api Management Hizmeti'nin silinmesini geri alın. Bu bayrak belirtilir ve Doğru 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.
properties.zoneRedundant	boolean	False	StandardV2 ve PremiumV2 oluştururken Bölge Yedek Gereksinimi. Bu bayrak Doğru olarak ayarlanmışsa, Zone yedekli bir APIM hizmeti döndürür veya altındaki bileşen bölge yedekli olamazsa isteği başarısız olur.
sku	ApiManagementServiceSkuProperties		API Management hizmetinin SKU özellikleri.
systemData	systemData		createdBy ve modifiedBy bilgilerini içeren Azure Resource Manager meta verileri.
tags	object		Kaynak etiketleri.
type	string		Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"
zones	string[]		Kullanılabilirlik alanları.

ApiManagementServiceSkuProperties

Nesne

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 için SKU kapasitesi 0 olarak belirtilmelidir.
name	SkuType	Sku'nun adı.

ApimIdentityType

Numaralandırma

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

Nesne

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

Name	Tür	Description
minApiVersion	string	Denetim düzlemi API çağrılarını bu değere eşit veya bu değerden daha yeni bir sürüme sahip API Management hizmetiyle sınırlayın.

ArmIdWrapper

Nesne

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

Name	Tür	Description
id	string

CertificateConfiguration

Nesne

Güvenilmeyen ara ürünler 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	CertificateConfigurationStoreName	System.Security.Cryptography.x509certificates.StoreName sertifika deposu konumu. Yalnızca Kök ve CertificateAuthority geçerli konumlardır.

CertificateConfigurationStoreName

Numaralandırma

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

Değer	Description
CertificateAuthority
Root

CertificateInformation

Nesne

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

Numaralandırma

Sertifika Kaynağı.

Değer	Description
Managed
KeyVault
Custom
BuiltIn

CertificateStatus

Numaralandırma

Sertifika Durumu.

Değer	Description
Completed
Failed
InProgress

ConfigurationApi

Nesne

API Management hizmetinin Yapılandırma API'si ile ilgili bilgiler.

Name	Tür	Default value	Description
legacyApi	LegacyApiState	Enabled	Eski Yapılandırma API'sinin (v1) API Management hizmetinde kullanıma sunulması gerekip gerekmediğini gösterme. Değer isteğe bağlıdır ancak 'Etkin' veya 'Devre Dışı' olmalıdır. 'Devre Dışı' ise, eski Yapılandırma API'si (v1) şirket içinde barındırılan ağ geçitleri için kullanılamaz. Varsayılan değer 'Etkin'

createdByType

Numaralandırma

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

Değer	Description
User
Application
ManagedIdentity
Key

DeveloperPortalStatus

Numaralandırma

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

Değer	Description
Enabled	Hizmet için Geliştirici Portalı etkinleştirildi.
Disabled	Hizmet için Geliştirici Portalı devre dışı bırakıldı.

ErrorAdditionalInfo

Nesne

Kaynak yönetimi hatası ek bilgileri.

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

ErrorDetail

Nesne

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

Nesne

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

HostnameConfiguration

Nesne

Özel ana bilgisayar 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. Bu 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		SSL sertifikasını içeren keyVault'a GET erişimi olan Azure AD tarafından oluşturulan Sistem veya Kullanıcı Tarafından Atanan Yönetilen kimlik clientId.
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

Numaralandırma

Ana bilgisayar adı türü.

Değer	Description
Proxy
Portal
Management
Scm
DeveloperPortal
ConfigurationApi

LegacyApiState

Numaralandırma

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

Değer	Description
Enabled	Hizmet için Eski Yapılandırma API'si (v1) 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ılmıştır ve şirket içinde barındırılan ağ geçitleri buna bağlanamaz.

LegacyPortalStatus

Numaralandırma

API Management hizmetindeki eski portalın durumu.

Değer	Description
Enabled	Hizmet için Eski Portal etkinleştirildi.
Disabled	Eski Portal hizmet için devre dışı bırakıldı.

NatGatewayState

Numaralandırma

Özellik, bu API Management hizmeti için NAT Ağ Geçidi'ni etkinleştirmek için kullanılabilir.

Değer	Description
Enabled	Hizmet için Nat Ağ Geçidi etkinleştirildi.
Disabled	Nat Ağ Geçidi hizmet için devre dışı bırakıldı.

PlatformVersion

Numaralandırma

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

Değer	Description
undetermined	İşlem platformu dağıtılmadığı için 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 Multi Tenant V1 platformunda çalıştıran platform.
stv2.1	Hizmeti daha yeni Donanımda Tek Kiracılı V2 platformunda çalıştıran platform.

PrivateEndpointServiceConnectionStatus

Numaralandırma

Özel uç nokta bağlantı durumu.

Değer	Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Nesne

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

Numaralandırma

Bu API Management hizmeti için genel uç nokta erişimine izin verilip verilmediğ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

ReleaseChannel

Numaralandırma

Bu API Management hizmetinin Yayın Kanalı.

Değer	Description
Preview	Hizmetin Önizleme Kanalı.
Default	Hizmetin Varsayılan Kanalı.
Stable	Hizmetin Kararlı Kanalı.

RemotePrivateEndpointConnectionWrapper

Nesne

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

Name	Tür	Description
id	string	Özel Uç Nokta bağlantı kaynağı 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ısı Kaynak Türü

SkuType

Numaralandırma

Sku'nun adı.

Değer	Description
Developer	Api Management'ın geliştirici SKU'su.
Standard	Api Management'ın standart SKU'su.
Premium	Api Management'ın premium SKU'su.
Basic	Api Management'ın temel SKU'su.
Consumption	Api Management'ın tüketim SKU'su.
Isolated	Api Management'ın yalıtılmış SKU'su.
BasicV2	Api Management'ın BasicV2 SKU'su.
StandardV2	Api Management'ın StandardV2 SKU'su.
PremiumV2	API Yönetimi PremiumV2 SKU.

systemData

Nesne

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

Nesne

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

Nesne

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 boş bir GUID bekleyin.

VirtualNetworkType

Numaralandırma

API Management ağ geçidinin yapılandırılması gereken VPN türü.

Değer	Description
None	API Management ağ geçidi herhangi bir Sanal Ağın parçası değildir.
External	API Management ağ geçidi, Sanal Ağ'ın bir parçasıdır ve İnternet'ten erişilebilir.
Internal	API Management ağ geçidi, Sanal Ağ'ın bir parçasıdır ve yalnızca sanal ağ içinden erişilebilir.

Aracılığıyla paylaş

Api Management Service - Refresh Hostnames

URI Parametreleri

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

ApiManagementServiceRefreshKeyVaultHostnames

Örnek isteği

Örnek yanıt

Tanımlar

AdditionalLocation

ApiManagementServiceIdentity

ApiManagementServiceResource

ApiManagementServiceSkuProperties

ApimIdentityType

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateConfigurationStoreName

CertificateInformation

CertificateSource

CertificateStatus

ConfigurationApi

createdByType

DeveloperPortalStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HostnameConfiguration

HostnameType

LegacyApiState

LegacyPortalStatus

NatGatewayState

PlatformVersion

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

PublicNetworkAccess

ReleaseChannel

RemotePrivateEndpointConnectionWrapper

SkuType

systemData

UserIdentityProperties

VirtualNetworkConfiguration

VirtualNetworkType