Portal Config - Create Or Update

Layanan:: API Management

Versi API:: 2024-05-01

Membuat atau memperbarui konfigurasi portal pengembang.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
portalConfigId	path	True	string minLength: 1 maxLength: 80	Pengidentifikasi konfigurasi portal.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nama layanan API Management.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus UUID.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
If-Match	True	string	ETag Entitas. ETag harus cocok dengan status entitas saat ini dari respons header permintaan GET atau harus * untuk pembaruan tanpa syarat.

Isi Permintaan

Nama	Jenis	Deskripsi
properties.cors	PortalConfigCorsProperties	Pengaturan Berbagi Sumber Daya Lintas Asal (CORS) portal pengembang.
properties.csp	PortalConfigCspProperties	Pengaturan Kebijakan Keamanan Konten (CSP) portal pengembang.
properties.delegation	PortalConfigDelegationProperties	Pengaturan delegasi portal pengembang.
properties.enableBasicAuth	boolean	Mengaktifkan atau menonaktifkan metode autentikasi Dasar.
properties.signin	Signin
properties.signup	Signup

Respons

Nama	Jenis	Deskripsi
200 OK	PortalConfigContract	Operasi berhasil diselesaikan.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

ApiManagementCreatePortalConfig

Permintaan sampel

HTTP

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


{
  "properties": {
    "enableBasicAuth": true,
    "signin": {
      "require": false
    },
    "signup": {
      "termsOfService": {
        "text": "I agree to the service terms and conditions.",
        "requireConsent": false
      }
    },
    "delegation": {
      "delegateRegistration": false,
      "delegateSubscription": false,
      "delegationUrl": null,
      "validationKey": null
    },
    "csp": {
      "mode": "reportOnly",
      "reportUri": [
        "https://report.contoso.com"
      ],
      "allowedSources": [
        "*.contoso.com"
      ]
    },
    "cors": {
      "allowedOrigins": [
        "https://contoso.com"
      ]
    }
  }
}

Respon sampel

Kode status:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default",
  "type": "Microsoft.ApiManagement/service/portalconfigs",
  "name": "default",
  "properties": {
    "enableBasicAuth": true,
    "signin": {
      "require": false
    },
    "signup": {
      "termsOfService": {
        "text": "I agree to the service terms and conditions.",
        "requireConsent": false
      }
    },
    "delegation": {
      "delegateRegistration": false,
      "delegateSubscription": false,
      "delegationUrl": null,
      "validationKey": null
    },
    "csp": {
      "mode": "reportOnly",
      "reportUri": [
        "https://report.contoso.com"
      ],
      "allowedSources": [
        "*.contoso.com"
      ]
    },
    "cors": {
      "allowedOrigins": [
        "https://contoso.com"
      ]
    }
  }
}

Definisi

Nama	Deskripsi
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
PortalConfigContract	Kontrak konfigurasi portal pengembang.
PortalConfigCorsProperties	Pengaturan Berbagi Sumber Daya Lintas Asal (CORS) portal pengembang.
PortalConfigCspProperties	Pengaturan Kebijakan Keamanan Konten (CSP) portal pengembang.
PortalConfigDelegationProperties
PortalConfigTermsOfServiceProperties	Ketentuan properti kontrak layanan.
PortalSettingsCspMode	Mode Portal pengembang Kebijakan Keamanan Konten (CSP).
Signin
Signup

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

PortalConfigContract

Objek

Kontrak konfigurasi portal pengembang.

Nama	Jenis	Nilai default	Deskripsi
id	string		ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Nama sumber daya
properties.cors	PortalConfigCorsProperties		Pengaturan Berbagi Sumber Daya Lintas Asal (CORS) portal pengembang.
properties.csp	PortalConfigCspProperties		Pengaturan Kebijakan Keamanan Konten (CSP) portal pengembang.
properties.delegation	PortalConfigDelegationProperties		Pengaturan delegasi portal pengembang.
properties.enableBasicAuth	boolean	True	Mengaktifkan atau menonaktifkan metode autentikasi Dasar.
properties.signin	Signin
properties.signup	Signup
type	string		Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

PortalConfigCorsProperties

Objek

Pengaturan Berbagi Sumber Daya Lintas Asal (CORS) portal pengembang.

Nama	Jenis	Deskripsi
allowedOrigins	string[]	Asal yang diizinkan, misalnya `https://trusted.com`.

PortalConfigCspProperties

Objek

Pengaturan Kebijakan Keamanan Konten (CSP) portal pengembang.

Nama	Jenis	Nilai default	Deskripsi
allowedSources	string[]		Sumber yang diizinkan, misalnya `*.trusted.com`, `trusted.com`, `https://`.
mode	PortalSettingsCspMode	disabled	Mode Portal pengembang Kebijakan Keamanan Konten (CSP).
reportUri	string[]		URL yang digunakan oleh browser untuk melaporkan pelanggaran CSP.

PortalConfigDelegationProperties

Objek

Nama	Jenis	Nilai default	Deskripsi
delegateRegistration	boolean	False	Mengaktifkan atau menonaktifkan delegasi untuk pendaftaran pengguna.
delegateSubscription	boolean	False	Mengaktifkan atau menonaktifkan delegasi untuk langganan produk.
delegationUrl	string		URL titik akhir delegasi.
validationKey	string		Kunci validasi yang dikodekan base64 untuk memastikan permintaan berasal dari layanan Azure API Management.

PortalConfigTermsOfServiceProperties

Objek

Ketentuan properti kontrak layanan.

Nama	Jenis	Nilai default	Deskripsi
requireConsent	boolean	False	Minta pengguna untuk menyetujui ketentuan layanan.
text	string		Ketentuan teks layanan.

PortalSettingsCspMode

Enumeration

Mode Portal pengembang Kebijakan Keamanan Konten (CSP).

Nilai	Deskripsi
enabled	Browser akan memblokir permintaan yang tidak cocok dengan asal yang diizinkan.
disabled	Browser tidak akan menerapkan pembatasan asal.
reportOnly	Browser akan melaporkan permintaan yang tidak cocok dengan asal yang diizinkan tanpa memblokirnya.

Objek

Nama	Jenis	Nilai default	Deskripsi
require	boolean	False	Alihkan pengguna anonim ke halaman masuk.

Objek

Nama	Jenis	Deskripsi
termsOfService	PortalConfigTermsOfServiceProperties	Ketentuan pengaturan layanan.

Bagikan melalui

Portal Config - Create Or Update

Parameter URI

Header Permintaan

Isi Permintaan

Respons

Keamanan

azure_auth

Cakupan

Contoh

ApiManagementCreatePortalConfig

Permintaan sampel

Respon sampel

Definisi

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PortalConfigContract

PortalConfigCorsProperties

PortalConfigCspProperties

PortalConfigDelegationProperties

PortalConfigTermsOfServiceProperties

PortalSettingsCspMode

Signin

Signup