Api Management Service - Backup

Membuat cadangan layanan API Management ke Akun Azure Storage yang diberikan. Ini adalah operasi yang berjalan lama dan bisa memakan waktu beberapa menit untuk diselesaikan.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backup?api-version=2021-08-01

Parameter URI

Name In Required Type Description
resourceGroupName
path True
  • string

Nama grup sumber daya.

serviceName
path True
  • string

Nama layanan API Management.

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

subscriptionId
path True
  • string

Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.

api-version
query True
  • string

Versi API yang akan digunakan dengan permintaan klien.

Isi Permintaan

Name Required Type Description
backupName True
  • string

Nama file cadangan yang akan dibuat/diambil.

containerName True
  • string

Nama kontainer blob (digunakan untuk menempatkan/mengambil cadangan).

storageAccount True
  • string

Nama akun penyimpanan Azure (digunakan untuk menempatkan/mengambil cadangan).

accessKey
  • string

Kunci akses akun penyimpanan. Diperlukan hanya jika accessType diatur ke AccessKey.

accessType

Jenis akses yang akan digunakan untuk akun penyimpanan.

clientId
  • string

ID Klien identitas terkelola yang ditetapkan pengguna. Diperlukan hanya jika accessType diatur ke UserAssignedManagedIdentity.

Respons

Name Type Description
200 OK

Berhasil mencadangkan layanan API Management ke akun penyimpanan.

202 Accepted

Diterima: Header lokasi berisi URL tempat status operasi yang berjalan lama dapat diperiksa.

Other Status Codes

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name Description
user_impersonation meniru akun pengguna Anda

Contoh

ApiManagementBackupWithAccessKey
ApiManagementBackupWithSystemManagedIdentity
ApiManagementBackupWithUserAssignedManagedIdentity

ApiManagementBackupWithAccessKey

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backup?api-version=2021-08-01

{
  "storageAccount": "teststorageaccount",
  "containerName": "backupContainer",
  "backupName": "apimService1backup_2017_03_19",
  "accessType": "AccessKey",
  "accessKey": "**************************************************"
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2021-08-01
{
  "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": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "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
  }
}

ApiManagementBackupWithSystemManagedIdentity

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backup?api-version=2021-08-01

{
  "storageAccount": "contosorpstorage",
  "containerName": "apim-backups",
  "backupName": "backup5",
  "accessType": "SystemAssignedManagedIdentity"
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2021-08-01
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "apimService1"
  },
  "location": "Central US EUAP",
  "etag": "AAAAAAAQM8o=",
  "properties": {
    "publisherEmail": "apimService1@corp.microsoft.com",
    "publisherName": "MS",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-04-23T16:26:47.8637967Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-centraluseuap-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,
        "certificateSource": "BuiltIn"
      }
    ],
    "publicIPAddresses": [
      "52.XXXX.160.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,
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv1"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "XXXXX-5fb4-4916-95d4-64b306f9d924",
    "tenantId": "XXXXX-86f1-XXXXX-91ab-2d7cd011db47",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": {
        "principalId": "XXXXX-a100-4478-XXXX-d65d98118ba0",
        "clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2"
      },
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": {
        "principalId": "XXXXX-9208-4128-af2d-a10d2af9b5a3",
        "clientId": "XXXX-6328-4db2-XXXX-ab0e3e7806cf"
      }
    }
  },
  "systemData": {
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-06-30T06:24:57.0008037Z"
  }
}

ApiManagementBackupWithUserAssignedManagedIdentity

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backup?api-version=2021-08-01

{
  "storageAccount": "contosorpstorage",
  "containerName": "apim-backups",
  "backupName": "backup5",
  "accessType": "UserAssignedManagedIdentity",
  "clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2"
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2021-08-01
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "apimService1"
  },
  "location": "Central US EUAP",
  "etag": "AAAAAAAQM8o=",
  "properties": {
    "publisherEmail": "apimService1@corp.microsoft.com",
    "publisherName": "MS",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-04-23T16:26:47.8637967Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-centraluseuap-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,
        "certificateSource": "BuiltIn"
      }
    ],
    "publicIPAddresses": [
      "52.XXXX.160.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,
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv1"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "XXXXX-5fb4-4916-95d4-64b306f9d924",
    "tenantId": "XXXXX-86f1-XXXXX-91ab-2d7cd011db47",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": {
        "principalId": "XXXXX-a100-4478-XXXX-d65d98118ba0",
        "clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2"
      },
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": {
        "principalId": "XXXXX-9208-4128-af2d-a10d2af9b5a3",
        "clientId": "XXXX-6328-4db2-XXXX-ab0e3e7806cf"
      }
    }
  },
  "systemData": {
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-06-30T06:24:57.0008037Z"
  }
}

Definisi

AccessType

Jenis akses yang akan digunakan untuk akun penyimpanan.

AdditionalLocation

Deskripsi lokasi sumber daya API Management tambahan.

ApiManagementServiceBackupRestoreParameters

Parameter yang disediakan ke Pencadangan/Pemulihan operasi layanan API Management.

ApiManagementServiceIdentity

Properti identitas sumber daya layanan Api Management.

ApiManagementServiceResource

Satu sumber daya layanan API Management dalam Daftar atau Dapatkan respons.

ApiManagementServiceSkuProperties

API Management properti SKU sumber daya layanan.

ApimIdentityType

Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned, UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus identitas apa pun dari layanan.

ApiVersionConstraint

Batasan versi Control Plane Apis untuk layanan API Management.

ArmIdWrapper

Pembungkus untuk id sumber daya ARM

CertificateConfiguration

Konfigurasi sertifikat yang terdiri dari perantara dan sertifikat akar yang tidak tepercaya.

CertificateInformation

Informasi sertifikat SSL.

CertificateSource

Sumber Sertifikat.

CertificateStatus

Status Sertifikat.

createdByType

Jenis identitas yang membuat sumber daya.

ErrorFieldContract

Kontrak Bidang Kesalahan.

ErrorResponse

Respons Kesalahan.

HostnameConfiguration

Konfigurasi nama host kustom.

HostnameType

Jenis nama host.

PlatformVersion

Versi Platform Komputasi yang menjalankan layanan.

PrivateEndpointServiceConnectionStatus

Status koneksi titik akhir privat.

PrivateLinkServiceConnectionState

Kumpulan informasi tentang status koneksi antara konsumen layanan dan penyedia.

PublicNetworkAccess

Apakah akses titik akhir publik diizinkan atau tidak untuk layanan API Management ini. Nilai bersifat opsional tetapi jika diteruskan, harus 'Diaktifkan' atau 'Dinonaktifkan'. Jika 'Dinonaktifkan', titik akhir privat adalah metode akses eksklusif. Nilai defaultnya adalah 'Diaktifkan'

RemotePrivateEndpointConnectionWrapper

Sumber daya Koneksi Titik Akhir Privat Jarak Jauh.

SkuType

Nama Sku.

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

UserIdentityProperties
VirtualNetworkConfiguration

Konfigurasi jaringan virtual tempat layanan API Management disebarkan.

VirtualNetworkType

Jenis VPN tempat layanan API Management perlu dikonfigurasi. Tidak Ada (Nilai Default) berarti layanan API Management bukan bagian dari Virtual Network apa pun, Eksternal berarti penyebaran API Management disiapkan di dalam Virtual Network memiliki Titik Akhir Yang Menghadap Internet, dan Internal berarti bahwa API Management penyebaran disiapkan di dalam Virtual Network hanya memiliki Titik Akhir Yang Menghadap Intranet.

AccessType

Jenis akses yang akan digunakan untuk akun penyimpanan.

Name Type Description
AccessKey
  • string

Gunakan kunci akses.

SystemAssignedManagedIdentity
  • string

Gunakan identitas terkelola yang ditetapkan sistem.

UserAssignedManagedIdentity
  • string

Gunakan identitas terkelola yang ditetapkan pengguna.

AdditionalLocation

Deskripsi lokasi sumber daya API Management tambahan.

Name Type Default Value Description
disableGateway
  • boolean
False

Properti hanya berlaku untuk layanan Api Management yang disebarkan di beberapa lokasi. Ini dapat digunakan untuk menonaktifkan gateway di lokasi tambahan ini.

gatewayRegionalUrl
  • string

URL gateway layanan API Management di Wilayah.

location
  • string

Nama lokasi wilayah tambahan di antara wilayah pusat Data Azure.

platformVersion

Versi Platform Komputasi yang menjalankan layanan.

privateIPAddresses
  • string[]

Alamat IP Privat Static Load Balanced dari layanan API Management yang disebarkan di Virtual Network Internal di lokasi tambahan tertentu. Hanya tersedia untuk SKU Dasar, Standar, Premium, dan Terisolasi.

publicIPAddresses
  • string[]

Alamat IP Load Balanced Statis Publik dari layanan API Management di lokasi tambahan. Hanya tersedia untuk SKU Dasar, Standar, Premium, dan Terisolasi.

publicIpAddressId
  • string

Alamat IP berbasis IP V4 SKU Standar Publik yang akan dikaitkan dengan layanan yang Virtual Network disebarkan di lokasi tersebut. Didukung hanya untuk SKU Premium yang disebarkan di Virtual Network.

sku

Properti SKU dari layanan API Management.

virtualNetworkConfiguration

Konfigurasi jaringan virtual untuk lokasi tersebut.

zones
  • string[]

Daftar zona ketersediaan yang menunjukkan dari mana sumber daya perlu berasal.

ApiManagementServiceBackupRestoreParameters

Parameter yang disediakan ke Pencadangan/Pemulihan operasi layanan API Management.

Name Type Default Value Description
accessKey
  • string

Kunci akses akun penyimpanan. Diperlukan hanya jika accessType diatur ke AccessKey.

accessType AccessKey

Jenis akses yang akan digunakan untuk akun penyimpanan.

backupName
  • string

Nama file cadangan yang akan dibuat/diambil.

clientId
  • string

ID Klien identitas terkelola yang ditetapkan pengguna. Diperlukan hanya jika accessType diatur ke UserAssignedManagedIdentity.

containerName
  • string

Nama kontainer blob (digunakan untuk menempatkan/mengambil cadangan).

storageAccount
  • string

Nama akun penyimpanan Azure (digunakan untuk menempatkan/mengambil cadangan).

ApiManagementServiceIdentity

Properti identitas sumber daya layanan Api Management.

Name Type Description
principalId
  • string

Id utama identitas.

tenantId
  • string

Id penyewa klien identitas.

type

Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned, UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus identitas apa pun dari layanan.

userAssignedIdentities

Daftar identitas pengguna yang terkait dengan sumber daya. Referensi kunci kamus identitas pengguna akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ApiManagementServiceResource

Satu sumber daya layanan API Management dalam Daftar atau Dapatkan respons.

Name Type Default Value Description
etag
  • string

ETag sumber daya.

id
  • string

ID Sumber Daya.

identity

Identitas layanan terkelola dari layanan Api Management.

location
  • string

Lokasi sumber daya.

name
  • string

Nama sumber daya.

properties.additionalLocations

Lokasi pusat data tambahan dari layanan API Management.

properties.apiVersionConstraint

Batasan versi Control Plane Apis untuk layanan API Management.

properties.certificates

Daftar Sertifikat yang perlu diinstal di layanan API Management. Sertifikat maksimum yang didukung yang dapat diinstal adalah 10.

properties.createdAtUtc
  • string

Tanggal UTC pembuatan layanan API Management. Tanggal sesuai dengan format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601.

properties.customProperties
  • object

Properti kustom layanan API Management.
Pengaturan Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 akan menonaktifkan TLS_RSA_WITH_3DES_EDE_CBC_SHA sandi untuk semua TLS(1.0, 1.1 dan 1.2).
Pengaturan Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 dapat digunakan untuk menonaktifkan hanya TLS 1.1.
Pengaturan Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 dapat digunakan untuk menonaktifkan TLS 1.0 pada layanan API Management.
Pengaturan Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 dapat digunakan untuk menonaktifkan hanya TLS 1.1 untuk komunikasi dengan backend.
Pengaturan Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 dapat digunakan untuk menonaktifkan TLS 1.0 untuk komunikasi dengan backend.
Pengaturan Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 dapat digunakan untuk mengaktifkan protokol HTTP2 pada layanan API Management.
Tidak menentukan salah satu properti ini pada operasi PATCH akan mengatur ulang nilai properti yang dihilangkan ke defaultnya. Untuk semua pengaturan kecuali Http2, nilai defaultnya adalah True jika layanan dibuat pada atau sebelum 1 April 2018 dan False sebaliknya. Nilai default pengaturan Http2 adalah False.

Anda dapat menonaktifkan salah satu cipher berikutnya dengan menggunakan pengaturan 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. Misalnya, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Nilai defaultnya adalah true untuk nilai tersebut. Catatan: cipher berikutnya tidak dapat dinonaktifkan karena diperlukan oleh komponen internal Azure CloudService: 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

URL titik akhir Portal DEveloper dari layanan API Management.

properties.disableGateway
  • boolean
False

Properti hanya berlaku untuk layanan Api Management yang disebarkan di beberapa lokasi. Ini dapat digunakan untuk menonaktifkan gateway di wilayah master.

properties.enableClientCertificate
  • boolean
False

Properti hanya dimaksudkan untuk digunakan untuk Layanan SKU Konsumsi. Ini memberlakukan sertifikat klien untuk disajikan pada setiap permintaan ke gateway. Ini juga memungkinkan kemampuan untuk mengautentikasi sertifikat dalam kebijakan di gateway.

properties.gatewayRegionalUrl
  • string

URL gateway layanan API Management di Wilayah Default.

properties.gatewayUrl
  • string

URL gateway layanan API Management.

properties.hostnameConfigurations

Konfigurasi nama host kustom layanan API Management.

properties.managementApiUrl
  • string

URL titik akhir API Manajemen dari layanan API Management.

properties.notificationSenderEmail
  • string

Alamat email tempat pemberitahuan akan dikirim.

properties.platformVersion

Versi Platform Komputasi yang menjalankan layanan di lokasi ini.

properties.portalUrl
  • string

Publisher Url titik akhir portal layanan API Management.

properties.privateEndpointConnections

Daftar Koneksi Titik Akhir Privat layanan ini.

properties.privateIPAddresses
  • string[]

Alamat IP Privat Static Load Balanced dari layanan API Management di wilayah Primer yang disebarkan dalam Virtual Network Internal. Hanya tersedia untuk SKU Dasar, Standar, Premium, dan Terisolasi.

properties.provisioningState
  • string

Status penyediaan layanan API Management saat ini yang dapat menjadi salah satu hal berikut: Dibuat/Diaktifkan/Berhasil/Diperbarui/Gagal/Dihentikan/Mengakhiri/TerminasiFailed/Dihapus.

properties.publicIPAddresses
  • string[]

Alamat IP Load Balanced Statis Publik dari layanan API Management di wilayah Utama. Hanya tersedia untuk SKU Dasar, Standar, Premium, dan Terisolasi.

properties.publicIpAddressId
  • string

Alamat IP berbasis IP V4 SKU Standar Publik yang akan dikaitkan dengan Virtual Network layanan yang disebarkan di wilayah tersebut. Hanya didukung untuk Pengembang dan SKU Premium yang disebarkan di Virtual Network.

properties.publicNetworkAccess

Apakah akses titik akhir publik diizinkan atau tidak untuk layanan API Management ini. Nilai bersifat opsional tetapi jika diteruskan, harus 'Diaktifkan' atau 'Dinonaktifkan'. Jika 'Dinonaktifkan', titik akhir privat adalah metode akses eksklusif. Nilai defaultnya adalah 'Diaktifkan'

properties.publisherEmail
  • string

Publisher email.

properties.publisherName
  • string

Publisher nama.

properties.restore
  • boolean
False

Batalkan penghapusan Layanan Api Management jika sebelumnya dihapus sementara. Jika bendera ini ditentukan dan diatur ke True, semua properti lainnya akan diabaikan.

properties.scmUrl
  • string

URL titik akhir SCM dari layanan API Management.

properties.targetProvisioningState
  • string

Status penyediaan layanan API Management, yang ditargetkan oleh operasi jangka panjang yang dimulai pada layanan.

properties.virtualNetworkConfiguration

Konfigurasi jaringan virtual layanan API Management.

properties.virtualNetworkType None

Jenis VPN tempat layanan API Management perlu dikonfigurasi. Tidak Ada (Nilai Default) berarti layanan API Management bukan bagian dari Virtual Network apa pun, Eksternal berarti penyebaran API Management disiapkan di dalam Virtual Network memiliki Titik Akhir Yang Menghadap Internet, dan Internal berarti bahwa API Management penyebaran disiapkan di dalam Virtual Network hanya memiliki Titik Akhir Yang Menghadap Intranet.

sku

Properti SKU dari layanan API Management.

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

tags
  • object

Tag sumber daya.

type
  • string

Jenis sumber daya untuk sumber daya API Management diatur ke Microsoft.ApiManagement.

zones
  • string[]

Daftar zona ketersediaan yang menunjukkan dari mana sumber daya perlu berasal.

ApiManagementServiceSkuProperties

API Management properti SKU sumber daya layanan.

Name Type Description
capacity
  • integer

Kapasitas SKU (jumlah unit SKU yang disebarkan). Untuk kapasitas SKU Konsumsi harus ditentukan sebagai 0.

name

Nama Sku.

ApimIdentityType

Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned, UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus identitas apa pun dari layanan.

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

ApiVersionConstraint

Batasan versi Control Plane Apis untuk layanan API Management.

Name Type Description
minApiVersion
  • string

Batasi panggilan API sarana kontrol ke layanan API Management dengan versi yang sama dengan atau lebih baru dari nilai ini.

ArmIdWrapper

Pembungkus untuk id sumber daya ARM

Name Type Description
id
  • string

CertificateConfiguration

Konfigurasi sertifikat yang terdiri dari perantara dan sertifikat akar yang tidak tepercaya.

Name Type Description
certificate

Informasi sertifikat.

certificatePassword
  • string

Kata Sandi Sertifikat.

encodedCertificate
  • string

Sertifikat Yang Dikodekan Base64.

storeName enum:
  • CertificateAuthority
  • Root

Lokasi penyimpanan sertifikat System.Security.Cryptography.x509certificates.StoreName. Hanya Root dan CertificateAuthority yang merupakan lokasi yang valid.

CertificateInformation

Informasi sertifikat SSL.

Name Type Description
expiry
  • string

Tanggal kedaluwarsa sertifikat. Tanggal sesuai dengan format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601.

subject
  • string

Subjek sertifikat.

thumbprint
  • string

Thumbprint sertifikat.

CertificateSource

Sumber Sertifikat.

Name Type Description
BuiltIn
  • string
Custom
  • string
KeyVault
  • string
Managed
  • string

CertificateStatus

Status Sertifikat.

Name Type Description
Completed
  • string
Failed
  • string
InProgress
  • string

createdByType

Jenis identitas yang membuat sumber daya.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorFieldContract

Kontrak Bidang Kesalahan.

Name Type Description
code
  • string

Kode kesalahan tingkat properti.

message
  • string

Representasi kesalahan tingkat properti yang dapat dibaca manusia.

target
  • string

Nama properti.

ErrorResponse

Respons Kesalahan.

Name Type Description
error.code
  • string

Kode kesalahan yang ditentukan layanan. Kode ini berfungsi sebagai sub-status untuk kode kesalahan HTTP yang ditentukan dalam respons.

error.details

Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi.

error.message
  • string

Representasi kesalahan yang dapat dibaca manusia.

HostnameConfiguration

Konfigurasi nama host kustom.

Name Type Default Value Description
certificate

Informasi sertifikat.

certificatePassword
  • string

Kata Sandi Sertifikat.

certificateSource

Sumber Sertifikat.

certificateStatus

Status Sertifikat.

defaultSslBinding
  • boolean
False

Tentukan true untuk menyiapkan sertifikat yang terkait dengan Nama Host ini sebagai Sertifikat SSL Default. Jika klien tidak mengirim header SNI, maka ini akan menjadi sertifikat yang akan ditantang. Properti berguna jika layanan mengaktifkan beberapa nama host kustom dan perlu memutuskan sertifikat ssl default. Pengaturan hanya diterapkan ke Jenis Nama Host Proksi.

encodedCertificate
  • string

Sertifikat Yang Dikodekan Base64.

hostName
  • string

Nama host untuk dikonfigurasi pada layanan Api Management.

identityClientId
  • string

ClientId identitas Terkelola yang Ditetapkan Sistem atau Pengguna seperti yang dihasilkan oleh Azure AD, yang memiliki akses GET ke keyVault yang berisi sertifikat SSL.

keyVaultId
  • string

Url ke Rahasia KeyVault yang berisi Sertifikat Ssl. Jika Url absolut yang berisi versi disediakan, pembaruan otomatis sertifikat ssl tidak akan berfungsi. Ini mengharuskan layanan Api Management dikonfigurasi dengan aka.ms/apimmsi. Rahasianya harus berjenis application/x-pkcs12

negotiateClientCertificate
  • boolean
False

Tentukan true untuk selalu menegosiasikan sertifikat klien pada nama host. Nilai Default adalah false.

type

Jenis nama host.

HostnameType

Jenis nama host.

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

PlatformVersion

Versi Platform Komputasi yang menjalankan layanan.

Name Type Description
mtv1
  • string

Platform yang menjalankan layanan pada platform Multi Tenant V1.

stv1
  • string

Platform yang menjalankan layanan pada platform Penyewa Tunggal V1.

stv2
  • string

Platform yang menjalankan layanan pada platform Penyewa Tunggal V2.

undetermined
  • string

Versi platform tidak dapat ditentukan, karena platform komputasi tidak disebarkan.

PrivateEndpointServiceConnectionStatus

Status koneksi titik akhir privat.

Name Type Description
Approved
  • string
Pending
  • string
Rejected
  • string

PrivateLinkServiceConnectionState

Kumpulan informasi tentang status koneksi antara konsumen layanan dan penyedia.

Name Type Description
actionsRequired
  • string

Pesan yang menunjukkan apakah perubahan pada penyedia layanan memerlukan pembaruan pada konsumen.

description
  • string

Alasan persetujuan/penolakan koneksi.

status

Menunjukkan apakah koneksi telah Disetujui/Ditolak/Dihapus oleh pemilik layanan.

PublicNetworkAccess

Apakah akses titik akhir publik diizinkan atau tidak untuk layanan API Management ini. Nilai bersifat opsional tetapi jika diteruskan, harus 'Diaktifkan' atau 'Dinonaktifkan'. Jika 'Dinonaktifkan', titik akhir privat adalah metode akses eksklusif. Nilai defaultnya adalah 'Diaktifkan'

Name Type Description
Disabled
  • string
Enabled
  • string

RemotePrivateEndpointConnectionWrapper

Sumber daya Koneksi Titik Akhir Privat Jarak Jauh.

Name Type Description
id
  • string

Id sumber daya koneksi Titik Akhir Privat

name
  • string

Nama Koneksi Titik Akhir Privat

properties.groupIds
  • string[]

Semua id Grup.

properties.privateEndpoint

Sumber daya titik akhir privat.

properties.privateLinkServiceConnectionState

Kumpulan informasi tentang status koneksi antara konsumen layanan dan penyedia.

properties.provisioningState
  • string

Status penyediaan sumber daya koneksi titik akhir privat.

type
  • string

Jenis Sumber Daya Koneksi Titik Akhir Privat

SkuType

Nama Sku.

Name Type Description
Basic
  • string

SKU Dasar Api Management.

Consumption
  • string

Konsumsi SKU Api Management.

Developer
  • string

SKU Pengembang Api Management.

Isolated
  • string

SKU Api Management yang terisolasi.

Premium
  • string

Premium SKU Api Management.

Standard
  • string

SKU Standar Api Management.

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Name Type Description
createdAt
  • string

Tanda waktu pembuatan sumber daya (UTC).

createdBy
  • string

Identitas yang membuat sumber daya.

createdByType

Jenis identitas yang membuat sumber daya.

lastModifiedAt
  • string

Tanda waktu modifikasi terakhir sumber daya (UTC)

lastModifiedBy
  • string

Identitas yang terakhir mengubah sumber daya.

lastModifiedByType

Jenis identitas yang terakhir mengubah sumber daya.

UserIdentityProperties

Name Type Description
clientId
  • string

Id klien identitas yang ditetapkan pengguna.

principalId
  • string

Id utama identitas yang ditetapkan pengguna.

VirtualNetworkConfiguration

Konfigurasi jaringan virtual tempat layanan API Management disebarkan.

Name Type Description
subnetResourceId
  • string

ID sumber daya lengkap subnet di jaringan virtual untuk menyebarkan layanan API Management.

subnetname
  • string

Nama subnetnya.

vnetid
  • string

ID jaringan virtual. Ini biasanya GUID. Mengharapkan GUID null secara default.

VirtualNetworkType

Jenis VPN tempat layanan API Management perlu dikonfigurasi. Tidak Ada (Nilai Default) berarti layanan API Management bukan bagian dari Virtual Network apa pun, Eksternal berarti penyebaran API Management disiapkan di dalam Virtual Network memiliki Titik Akhir Yang Menghadap Internet, dan Internal berarti bahwa API Management penyebaran disiapkan di dalam Virtual Network hanya memiliki Titik Akhir Yang Menghadap Intranet.

Name Type Description
External
  • string

Layanan ini adalah bagian dari Virtual Network dan dapat diakses dari Internet.

Internal
  • string

Layanan ini adalah bagian dari Virtual Network dan hanya dapat diakses dari dalam jaringan virtual.

None
  • string

Layanan ini bukan bagian dari Virtual Network apa pun.