Api Management Service - Create Or Update

Bir API Management oluşturur veya günceller. Bu uzun süre çalışan bir işlemdir ve tamamlanması birkaç dakika sürebilir.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}?api-version=2020-06-01-preview

URI Parametreleri

Name In Required Type Description
resourceGroupName
path True
  • string

Kaynak grubunun adı.

serviceName
path True
  • string

API Management hizmetinin adı.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Aboneliğinizi benzersiz bir şekilde Microsoft Azure bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir bölümünü oluşturur.

api-version
query True
  • string

İstemci isteğiyle kullanılacak API'nin sürümü.

İstek Gövdesi

Name Required Type Description
location True
  • string

Kaynak konumu.

properties.publisherEmail True
  • string

Yayımcı e-postası.

properties.publisherName True
  • string

Yayımcı adı.

sku True

API Management hizmetinin SKU özellikleri.

identity

Api Management hizmetinin yönetilen hizmet kimliği.

properties.additionalLocations

API Management hizmetinin ek veri merkezi konumları.

properties.apiVersionConstraint

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

properties.certificates

API Management hizmetine yüklü olması gereken sertifikaların listesi. Yüklen desteklenen en fazla sertifika 10'dır.

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 bir hizmette TLS 1.0'ı devre dışı API Management kullanılabilir.
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.
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.
Ayar, Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 bir hizmette HTTP2 protokolünü etkinleştirmek API Management kullanılabilir.
PATCH işlemi sırasında bu özelliklerden herhangi biri belirtilmezse atlanmış özelliklerin değerleri varsayılan değerlerine sıfırlanır. Http2 dışındaki tüm ayarlar için varsayılan değer, hizmetin 1 Nisan True 2018'de veya 2018'den önce oluşturulmuşsa ve değilse False değeridir. Http2 ayarının varsayılan değeri: False .

Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]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 ayarlarını kullanarak sonraki şifrelemelerden herhangi birini devre dışı 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, bu true değerlere göredir. Not: Azure CloudService iç bileşenleri için gerekli olduğu için sonraki şifrelemeler devre dışı bırakılamaz: 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,TLS_RSA_WITH_AES_256_GCM_SHA384

properties.disableGateway
  • boolean

Özellik yalnızca birden çok konuma dağıtılmış 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

Ö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 uygulanmasını zorunlu kılın. Bu ayrıca ağ geçidinde ilkede sertifikanın kimliğini doğrulama olanağı sağlar.

properties.hostnameConfigurations

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

properties.notificationSenderEmail
  • string

Bildirim gönderilecek e-posta adresi.

properties.restore
  • boolean

Api Management Hizmeti daha önce yazılımdan silinmişse silmeyi geri edin. Bu bayrak belirtilirse ve True olarak ayarlanırsa diğer tüm özellikler yoksayılır.

properties.virtualNetworkConfiguration

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

properties.virtualNetworkType

Sanal ağ hizmetinin API Management gereken VPN türü. Hiçbiri (Varsayılan Değer), API Management hizmetinin herhangi bir Sanal Ağın parçası olmadığını, Dış ise API Management dağıtımının İnternet'e Yönelik Uç Noktasına sahip bir Sanal Ağ içinde ayar olduğu, İç ise API Management dağıtımının yalnızca intranete yönelik uç nokta olan bir Sanal Ağ içinde ayar olduğu anlamına gelir.

tags
  • object

Kaynak etiketleri.

zones
  • string[]

Kaynağın nereden olması gerektiğinin ek açıklamalarını alan kullanılabilirlik alanları listesi.

Yanıtlar

Name Type Description
200 OK

Hizmet başarıyla ayarlanmıştır.

201 Created

Oluşturulan

202 Accepted

Hizmet güncelleştirilken yapılandırma değişikliği kabul edildi.

Other Status Codes

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

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Örnekler

ApiManagementCreateMultiRegionServiceWithCustomHostname
ApiManagementCreateService
ApiManagementCreateServiceHavingMsi
ApiManagementCreateServiceInZones
ApiManagementCreateServiceWithCustomHostnameKeyVault
ApiManagementCreateServiceWithSystemCertificates
ApiManagementCreateServiceWithUserAssignedIdentity
ApiManagementUndelete

ApiManagementCreateMultiRegionServiceWithCustomHostname

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2020-06-01-preview
{
  "properties": {
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "encodedCertificate": "****** Base 64 Encoded Certificate ************",
        "certificatePassword": "Password",
        "defaultSslBinding": true
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "encodedCertificate": "****** Base 64 Encoded Certificate ************",
        "certificatePassword": "Password"
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "encodedCertificate": "****** Base 64 Encoded Certificate ************",
        "certificatePassword": "Password"
      }
    ],
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "additionalLocations": [
      {
        "location": "East US",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "disableGateway": true
      }
    ],
    "virtualNetworkType": "None",
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "location": "West US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/bXVsdGlob3N0bmFtZW11bHRpcmVnaW9uc2VydmljZV9BY3RfZjFiOTZhMjc=?api-version=2020-06-01-preview
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "West US",
  "etag": "AAAAAAACXoo=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2019-12-18T08:04:26.9492661Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false
      },
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      }
    ],
    "additionalLocations": [
      {
        "location": "East US",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "disableGateway": true
      }
    ],
    "virtualNetworkType": "None",
    "disableGateway": false,
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "West US",
  "etag": "AAAAAAACXok=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-18T06:26:20.3348609Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-westus-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
      },
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      }
    ],
    "publicIPAddresses": [
      "13.91.32.113"
    ],
    "additionalLocations": [
      {
        "location": "East US",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "publicIPAddresses": [
          "23.101.138.153"
        ],
        "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net",
        "disableGateway": true
      }
    ],
    "customProperties": {
      "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.Ciphers.TripleDes168": "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": "None",
    "disableGateway": false,
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}
location: https://management.azure.com/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/bXVsdGlob3N0bmFtZW11bHRpcmVnaW9uc2VydmljZV9BY3RfZjFiOTZhMjc=?api-version=2020-06-01-preview

ApiManagementCreateService

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2020-06-01-preview
{
  "properties": {
    "publisherEmail": "foo@contoso.com",
    "publisherName": "foo"
  },
  "sku": {
    "name": "Developer",
    "capacity": 1
  },
  "location": "South Central US",
  "tags": {
    "Name": "Contoso",
    "Test": "User"
  }
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2020-06-01-preview
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Name": "Contoso",
    "Test": "User"
  },
  "location": "South Central US",
  "etag": "AAAAAAAp3P0=",
  "properties": {
    "publisherEmail": "foo@contoso.com",
    "publisherName": "foo",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2019-12-18T06:10:56.0327105Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true
      }
    ],
    "virtualNetworkType": "None",
    "disableGateway": false,
    "apiVersionConstraint": {}
  },
  "sku": {
    "name": "Developer",
    "capacity": 1
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Name": "Contoso",
    "Test": "User"
  },
  "location": "South Central US",
  "etag": "AAAAAAAp3T4=",
  "properties": {
    "publisherEmail": "foo@contoso.com",
    "publisherName": "foo",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-18T06:10:56.0327105Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-southcentralus-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": true
      }
    ],
    "publicIPAddresses": [
      "23.102.171.124"
    ],
    "customProperties": {
      "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.Ciphers.TripleDes168": "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": "None",
    "disableGateway": false,
    "apiVersionConstraint": {}
  },
  "sku": {
    "name": "Developer",
    "capacity": 1
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/c2RrdGVzdGFwaW0xNTkxX0FjdF9jZTkyMmNmOQ==?api-version=2020-06-01-preview

ApiManagementCreateServiceHavingMsi

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2020-06-01-preview
{
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk"
  },
  "sku": {
    "name": "Consumption",
    "capacity": 0
  },
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "West US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2020-06-01-preview
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "West US",
  "etag": "AAAAAAAAWiE=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2019-04-11T16:29:29.9711098Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true
      }
    ],
    "virtualNetworkType": "None"
  },
  "sku": {
    "name": "Consumption",
    "capacity": 0
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "dfb9a757-df69-4966-a8d0-711a9cd8ffb4",
    "tenantId": "XXXXXX-86f1-41af-91ab-2d7cd011db47"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "West US",
  "etag": "AAAAAAAAWiU=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-04-11T16:29:29.9711098Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true
      }
    ],
    "virtualNetworkType": "None",
    "enableClientCertificate": false
  },
  "sku": {
    "name": "Consumption",
    "capacity": 0
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "dfb9a757-df69-4966-a8d0-711a9cd8ffb4",
    "tenantId": "XXXXXX-86f1-41af-91ab-2d7cd011db47"
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2020-06-01-preview

ApiManagementCreateServiceInZones

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2020-06-01-preview
{
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "zones": [
    "1",
    "2"
  ],
  "location": "North europe",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2020-06-01-preview
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "North Europe",
  "etag": "AAAAAAAiXto=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2020-07-28T23:18:14.6562474Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true
      }
    ],
    "virtualNetworkType": "None",
    "disableGateway": false
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "zones": [
    "1",
    "2"
  ]
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "North Europe",
  "etag": "AAAAAAAiXvE=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-07-28T23:18:14.6562474Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-northeurope-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": true
      }
    ],
    "publicIPAddresses": [
      "20.54.34.66"
    ],
    "customProperties": {
      "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.Ciphers.TripleDes168": "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": "None",
    "disableGateway": false
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "zones": [
    "1",
    "2"
  ]
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2020-06-01-preview

ApiManagementCreateServiceWithCustomHostnameKeyVault

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2020-06-01-preview
{
  "properties": {
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468",
        "defaultSslBinding": true
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468"
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468"
      }
    ],
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "virtualNetworkType": "None",
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
    }
  },
  "location": "North Europe",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/bXVsdGlob3N0bmFtZW11bHRpcmVnaW9uc2VydmljZV9BY3RfZjFiOTZhMjc=?api-version=2020-06-01-preview
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "North Europe",
  "etag": "AAAAAAAigi8=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2020-09-13T22:30:20.7759747Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false
      },
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2037-01-01T07:00:00+00:00",
          "thumbprint": "EA276907917CB5XXXXXXXXXXX690",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true,
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468"
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2037-01-01T07:00:00+00:00",
          "thumbprint": "EA276907917CB5XXXXXXXXXXX690",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false,
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468"
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2037-01-01T07:00:00+00:00",
          "thumbprint": "EA276907917CB5XXXXXXXXXXX690",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false,
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468"
      }
    ],
    "virtualNetworkType": "None",
    "disableGateway": false,
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
    }
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "North Europe",
  "etag": "AAAAAAAigjU=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-09-13T22:30:20.7759747Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-northeurope-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
      },
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2037-01-01T07:00:00+00:00",
          "thumbprint": "EA276907917CB5XXXXXXXXXXX690",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true,
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468"
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2037-01-01T07:00:00+00:00",
          "thumbprint": "EA276907917CB5XXXXXXXXXXX690",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false,
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468"
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2037-01-01T07:00:00+00:00",
          "thumbprint": "EA276907917CB5XXXXXXXXXXX690",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false,
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468"
      }
    ],
    "publicIPAddresses": [
      "40.112.74.192"
    ],
    "customProperties": {
      "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.Ciphers.TripleDes168": "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": "None",
    "disableGateway": false,
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "UserAssigned",
    "tenantId": "f686d426-8d16-xxxx-xxxx-ab578e110ccd",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "principalId": "15e769b2-xxxx-xxxx-xxxx-3fd9a923ac3a",
        "clientId": "329419bc-adec-4dce-9568-25a6d486e468"
      }
    }
  }
}
location: https://management.azure.com/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/bXVsdGlob3N0bmFtZW11bHRpcmVnaW9uc2VydmljZV9BY3RfZjFiOTZhMjc=?api-version=2020-06-01-preview

ApiManagementCreateServiceWithSystemCertificates

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2020-06-01-preview
{
  "properties": {
    "certificates": [
      {
        "encodedCertificate": "*******Base64 encoded Certificate******************",
        "certificatePassword": "Password",
        "storeName": "CertificateAuthority"
      }
    ],
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk"
  },
  "sku": {
    "name": "Basic",
    "capacity": 1
  },
  "location": "Central US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/bXVsdGlob3N0bmFtZW11bHRpcmVnaW9uc2VydmljZV9BY3RfZjFiOTZhMjc=?api-version=2020-06-01-preview
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "Central US",
  "etag": "AAAAAAAp3TM=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2019-12-18T06:33:28.0906918Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true
      }
    ],
    "virtualNetworkType": "None",
    "certificates": [
      {
        "storeName": "CertificateAuthority",
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989652CABCF585ACBFCB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        }
      }
    ],
    "disableGateway": false,
    "apiVersionConstraint": {}
  },
  "sku": {
    "name": "Basic",
    "capacity": 1
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "Central US",
  "etag": "AAAAAAAp3UM=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-18T06:33:28.0906918Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-centralus-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": true
      }
    ],
    "publicIPAddresses": [
      "40.113.223.117"
    ],
    "customProperties": {
      "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.Ciphers.TripleDes168": "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": "None",
    "certificates": [
      {
        "storeName": "CertificateAuthority",
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989652CABCF585ACBFCB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        }
      }
    ],
    "disableGateway": false,
    "apiVersionConstraint": {}
  },
  "sku": {
    "name": "Basic",
    "capacity": 1
  }
}
location: https://management.azure.com/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/bXVsdGlob3N0bmFtZW11bHRpcmVnaW9uc2VydmljZV9BY3RfZjFiOTZhMjc=?api-version=2020-06-01-preview

ApiManagementCreateServiceWithUserAssignedIdentity

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2020-06-01-preview
{
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk"
  },
  "sku": {
    "name": "Consumption",
    "capacity": 0
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {}
    }
  },
  "location": "West US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2020-06-01-preview
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "West US",
  "etag": "AAAAAAAFzyQ=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2020-03-12T01:05:33.4573398Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true
      }
    ],
    "virtualNetworkType": "None"
  },
  "sku": {
    "name": "Consumption",
    "capacity": 0
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {}
    }
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "West US",
  "etag": "AAAAAAAFzyk=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-03-12T01:05:33.4573398Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true
      }
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "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": "None",
    "disableGateway": false
  },
  "sku": {
    "name": "Consumption",
    "capacity": 0
  },
  "identity": {
    "type": "UserAssigned",
    "tenantId": "XXXXX-86f1-41af-XXXX-2d7cd011db47",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {
        "principalId": "XXXXX-6e62-4649-9f54-a119fc1ba85e",
        "clientId": "5a2c6b8e-0905-XXXX-a772-993c9418137f"
      }
    }
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2020-06-01-preview

ApiManagementUndelete

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2020-06-01-preview
{
  "properties": {
    "publisherEmail": "foo@contoso.com",
    "publisherName": "foo",
    "restore": true
  },
  "sku": {
    "name": "Developer",
    "capacity": 1
  },
  "location": "South Central US"
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2020-06-01-preview
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "location": "South Central US",
  "etag": "AAAAAAAp3P0=",
  "properties": {
    "publisherEmail": "foo@contoso.com",
    "publisherName": "foo",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2019-12-18T06:10:56.0327105Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true
      }
    ],
    "virtualNetworkType": "None",
    "disableGateway": false,
    "apiVersionConstraint": {}
  },
  "sku": {
    "name": "Developer",
    "capacity": 1
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "location": "South Central US",
  "etag": "AAAAAAAp3T4=",
  "properties": {
    "publisherEmail": "foo@contoso.com",
    "publisherName": "foo",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-18T06:10:56.0327105Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-southcentralus-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": true
      }
    ],
    "publicIPAddresses": [
      "23.102.171.124"
    ],
    "customProperties": {
      "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.Ciphers.TripleDes168": "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": "None",
    "disableGateway": false,
    "apiVersionConstraint": {}
  },
  "sku": {
    "name": "Developer",
    "capacity": 1
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/c2RrdGVzdGFwaW0xNTkxX0FjdF9jZTkyMmNmOQ==?api-version=2020-06-01-preview

Tanımlar

AdditionalLocation

Ek bir kaynak API Management açıklaması.

ApiManagementServiceIdentity

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

ApiManagementServiceResource

Liste veya API Management'daki tek bir hizmet kaynağı.

ApiManagementServiceSkuProperties

API Management kaynağı SKU özellikleri.

ApimIdentityType

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

ApiVersionConstraint

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

CertificateConfiguration

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

CertificateInformation

SSL sertifikası bilgileri.

ErrorFieldContract

Hata Alanı sözleşmesi.

ErrorResponse

Hata Yanıtı.

HostnameConfiguration

Özel ana bilgisayar adı yapılandırması.

HostnameType

Konak adı türü.

SkuType

Sku'nun adı.

UserIdentityProperties
VirtualNetworkConfiguration

Sanal ağ hizmetinin dağıtılacağı API Management yapılandırması.

VirtualNetworkType

Sanal ağ hizmetinin API Management gereken VPN türü. Hiçbiri (Varsayılan Değer), API Management hizmetinin herhangi bir Sanal Ağın parçası olmadığını, Dış ise API Management dağıtımının İnternet'e Yönelik Uç Noktasına sahip bir Sanal Ağ içinde ayar olduğu, İç ise API Management dağıtımının yalnızca intranete yönelik uç nokta olan bir Sanal Ağ içinde ayar olduğu anlamına gelir.

AdditionalLocation

Ek bir kaynak API Management açıklaması.

Name Type Description
disableGateway
  • boolean

Özellik yalnızca birden çok konuma dağıtılmış 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ölge'de API Management ağ geçidi URL'si.

location
  • string

Azure Veri Merkezi bölgeleri arasında ek bölgenin konum adı.

privateIPAddresses
  • string[]

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

publicIPAddresses
  • string[]

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

sku

API Management hizmetinin SKU özellikleri.

virtualNetworkConfiguration

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

zones
  • string[]

Kaynağın nereden olması gerektiğinin ek açıklamalarını alan kullanılabilirlik alanları listesi.

ApiManagementServiceIdentity

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

Name Type Description
principalId
  • string

Kimliğin asıl kimliği.

tenantId
  • string

Kimliğin istemci kiracı kimliği.

type

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

userAssignedIdentities

Kaynakla ilişkili kullanıcı kimliklerinin listesi. Kullanıcı kimliği sözlüğü anahtar başvuruları ŞU formda ARM kaynak kimlikleri olur: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ApiManagementServiceResource

Liste veya API Management'daki tek bir hizmet kaynağı.

Name Type Description
etag
  • string

Kaynağın ETag'i.

id
  • string

Kaynak Kimliği.

identity

Api Management hizmetinin yönetilen hizmet kimliği.

location
  • string

Kaynak konumu.

name
  • string

Kaynak adı.

properties.additionalLocations

API Management hizmetinin ek veri merkezi konumları.

properties.apiVersionConstraint

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

properties.certificates

API Management hizmetine yüklü olması gereken sertifikaların listesi. Yüklen desteklenen en fazla sertifika 10'dır.

properties.createdAtUtc
  • string

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

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 bir hizmette TLS 1.0'ı devre dışı API Management kullanılabilir.
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.
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.
Ayar, Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 bir hizmette HTTP2 protokolünü etkinleştirmek API Management kullanılabilir.
PATCH işlemi sırasında bu özelliklerden herhangi biri belirtilmezse atlanmış özelliklerin değerleri varsayılan değerlerine sıfırlanır. Http2 dışındaki tüm ayarlar için varsayılan değer, hizmetin 1 Nisan True 2018'de veya 2018'den önce oluşturulmuşsa ve değilse False değeridir. Http2 ayarının varsayılan değeri: False .

Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]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 ayarlarını kullanarak sonraki şifrelemelerden herhangi birini devre dışı 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, bu true değerlere göredir. Not: Azure CloudService iç bileşenleri için gerekli olduğu için sonraki şifrelemeler devre dışı bırakılamaz: 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,TLS_RSA_WITH_AES_256_GCM_SHA384

properties.developerPortalUrl
  • string

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

properties.disableGateway
  • boolean

Özellik yalnızca birden çok konuma dağıtılmış 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

Ö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 uygulanmasını zorunlu kılın. Bu ayrıca ağ geçidinde ilkede sertifikanın kimliğini doğrulama olanağı sağlar.

properties.gatewayRegionalUrl
  • string

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

properties.gatewayUrl
  • string

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

properties.hostnameConfigurations

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

properties.managementApiUrl
  • string

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

properties.notificationSenderEmail
  • string

Bildirim gönderilecek e-posta adresi.

properties.portalUrl
  • string

API Management hizmetinin yayımcı portalı uç API Management URL'si.

properties.privateIPAddresses
  • string[]

Bir İç Sanal Ağa dağıtılan Birincil bölgede 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 geçerli sağlama durumu: Oluşturuldu/Etkinleştirildi/Başarılı/Güncelleştirildi/Başarısız/Durduruldu/Sonlandırma/SonlandırmaFailed/Silindi.

properties.publicIPAddresses
  • string[]

Birincil bölgedeki hizmet için genel statik API Management IP adresleri. Yalnızca Temel, Standart, Premium ve Yalıtılmış SKU için kullanılabilir.

properties.publisherEmail
  • string

Yayımcı e-postası.

properties.publisherName
  • string

Yayımcı adı.

properties.restore
  • boolean

Api Management Hizmeti daha önce yazılımdan silinmişse silmeyi geri edin. Bu bayrak belirtilirse ve True olarak ayarlanırsa diğer tüm özellikler yoksayılır.

properties.scmUrl
  • string

API Management hizmetinin SCM uç API Management URL'si.

properties.targetProvisioningState
  • string

Hizmette uzun süre API Management tarafından hedeflenen hizmet sağlama durumu.

properties.virtualNetworkConfiguration

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

properties.virtualNetworkType

Sanal ağ hizmetinin API Management gereken VPN türü. Hiçbiri (Varsayılan Değer), API Management hizmetinin herhangi bir Sanal Ağın parçası olmadığını, Dış ise API Management dağıtımının İnternet'e Yönelik Uç Noktasına sahip bir Sanal Ağ içinde ayar olduğu, İç ise API Management dağıtımının yalnızca intranete yönelik uç nokta olan bir Sanal Ağ içinde ayar olduğu anlamına gelir.

sku

API Management hizmetinin SKU özellikleri.

tags
  • object

Kaynak etiketleri.

type
  • string

Kaynak türü API Management Microsoft.ApiManagement olarak ayarlanır.

zones
  • string[]

Kaynağın nereden olması gerektiğinin ek açıklamalarını alan kullanılabilirlik alanları listesi.

ApiManagementServiceSkuProperties

API Management kaynağı SKU özellikleri.

Name Type Description
capacity
  • integer

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

name

Sku'nun adı.

ApimIdentityType

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

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

ApiVersionConstraint

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

Name Type Description
minApiVersion
  • string

Denetim düzlemi API çağrılarını bu API Management veya daha yeni bir sürüme sahip bir hizmetle sınırla.

CertificateConfiguration

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

Name Type Description
certificate

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 sertifikası bilgileri.

Name Type Description
expiry
  • string

Sertifikanın sona erme tarihi. Tarih, yyyy-MM-ddTHH:mm:ssZ ISO 8601 standardı tarafından belirtilen biçimdedir.

subject
  • string

Sertifikanın konusu.

thumbprint
  • string

Sertifikanın parmak izi.

ErrorFieldContract

Hata Alanı sözleşmesi.

Name Type Description
code
  • string

Özellik düzeyi hata kodu.

message
  • string

Özellik düzeyi hatanın insan tarafından okunabilir gösterimi.

target
  • string

Özellik adı.

ErrorResponse

Hata Yanıtı.

Name Type Description
error.code
  • string

Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum olarak görev alır.

error.details

Doğrulama hatası durumunda istekte göndermekte olan geçersiz alanların listesi.

error.message
  • string

Hatanın insanlar tarafından okunabilir temsili.

HostnameConfiguration

Özel ana bilgisayar adı yapılandırması.

Name Type Description
certificate

Sertifika bilgileri.

certificatePassword
  • string

Sertifika Parolası.

defaultSslBinding
  • boolean

Bu Ana Bilgisayar Adı ile ilişkili sertifikayı Varsayılan SSL Sertifikası olarak ayarlaması için true belirtin. bir istemci SNI üst bilgisi gönderenin, bu, zorlanır sertifika olur. özelliği, bir hizmette birden çok özel ana bilgisayar adı etkinse ve varsayılan ssl sertifikasına karar vermesi gerekirse yararlıdır. Ayar yalnızca Proxy Ana Bilgisayar Adı Türü'ne uygulanır.

encodedCertificate
  • string

Base64 Kodlanmış sertifika.

hostName
  • string

Api Management hizmeti üzerinde 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 Anahtarının URL'si. Sürümü içeren mutlak URL sağlanırsa ssl sertifikasının otomatik olarak güncelleştirililene kadar çalışmaz. Bunun için Api Management hizmetinin aka.ms/apimmsi. Gizli dosya application/x-pkcs12 türünde olmalı

negotiateClientCertificate
  • boolean

Konak adı üzerinde her zaman istemci sertifikası anlaşması yapmak için true belirtin. Varsayılan Değer false'tır.

type

Konak adı türü.

HostnameType

Konak adı türü.

Name Type Description
DeveloperPortal
  • string
Management
  • string
Portal
  • string
Proxy
  • string
Scm
  • string

SkuType

Sku'nun adı.

Name Type Description
Basic
  • string

Api Management'ın temel SKU'su.

Consumption
  • string

Api Management'ın Tüketim SKU'su.

Developer
  • string

Api Management Geliştirici SKU'su.

Isolated
  • string

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

Premium
  • string

Api Management'ın Premium SKU'su.

Standard
  • string

Api Management'ın Standart SKU'su.

UserIdentityProperties

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

Sanal ağ hizmetinin dağıtılacağı API Management yapılandırması.

Name Type Description
subnetResourceId
  • string

Sanal ağı dağıtmak için sanal ağ içinde bir alt ağın tam API Management kimliği.

subnetname
  • string

Alt ağın adı.

vnetid
  • string

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

VirtualNetworkType

Sanal ağ hizmetinin API Management gereken VPN türü. Hiçbiri (Varsayılan Değer), API Management hizmetinin herhangi bir Sanal Ağın parçası olmadığını, Dış ise API Management dağıtımının İnternet'e Yönelik Uç Noktasına sahip bir Sanal Ağ içinde ayar olduğu, İç ise API Management dağıtımının yalnızca intranete yönelik uç nokta olan bir Sanal Ağ içinde ayar olduğu anlamına gelir.

Name Type Description
External
  • string

Hizmet Sanal Ağın bir parçası ve İnternet üzerinden erişilebilir.

Internal
  • string

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

None
  • string

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