Portal Config - Create Or Update

Hizmet:: API Management

API Sürümü:: 2024-05-01

Geliştirici portalı yapılandırmasını oluşturun veya güncelleştirin.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
portalConfigId	path	True	string minLength: 1 maxLength: 80	Portal yapılandırma tanımlayıcısı.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management hizmetinin adı.
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
If-Match	True	string	Varlığın ETag'i. ETag, GET isteğinin üst bilgi yanıtından geçerli varlık durumuyla eşleşmeli veya koşulsuz güncelleştirme için * olmalıdır.

İstek Gövdesi

Name	Tür	Description
properties.cors	PortalConfigCorsProperties	Geliştirici portalı Çıkış Noktaları Arası Kaynak Paylaşımı (CORS) ayarları.
properties.csp	PortalConfigCspProperties	Geliştirici portalı İçerik Güvenliği İlkesi (CSP) ayarları.
properties.delegation	PortalConfigDelegationProperties	Geliştirici portalı temsilci ayarları.
properties.enableBasicAuth	boolean	Temel kimlik doğrulama yöntemini etkinleştirin veya devre dışı bırakın.
properties.signin	Signin
properties.signup	Signup

Yanıtlar

Name	Tür	Description
200 OK	PortalConfigContract	İşlem başarıyla tamamlandı.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

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

Örnekler

ApiManagementCreatePortalConfig

Örnek isteği

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"
      ]
    }
  }
}

Örnek yanıt

Durum kodu:: 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"
      ]
    }
  }
}

Tanımlar

Name	Description
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
PortalConfigContract	Geliştirici portalı yapılandırma sözleşmesi.
PortalConfigCorsProperties	Geliştirici portalı Çıkış Noktaları Arası Kaynak Paylaşımı (CORS) ayarları.
PortalConfigCspProperties	Geliştirici portalı İçerik Güvenliği İlkesi (CSP) ayarları.
PortalConfigDelegationProperties
PortalConfigTermsOfServiceProperties	Hizmet sözleşmesi özellikleri koşulları.
PortalSettingsCspMode	Geliştirici portalı İçerik Güvenliği İlkesi'nin (CSP) modu.
Signin
Signup

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

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

ErrorDetail

Object

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Object

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

PortalConfigContract

Object

Geliştirici portalı yapılandırma sözleşmesi.

Name	Tür	Default value	Description
id	string		Kaynağın tam kaynak kimliği. Örn - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Kaynağın adı
properties.cors	PortalConfigCorsProperties		Geliştirici portalı Çıkış Noktaları Arası Kaynak Paylaşımı (CORS) ayarları.
properties.csp	PortalConfigCspProperties		Geliştirici portalı İçerik Güvenliği İlkesi (CSP) ayarları.
properties.delegation	PortalConfigDelegationProperties		Geliştirici portalı temsilci ayarları.
properties.enableBasicAuth	boolean	True	Temel kimlik doğrulama yöntemini etkinleştirin veya devre dışı bırakın.
properties.signin	Signin
properties.signup	Signup
type	string		Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

PortalConfigCorsProperties

Object

Geliştirici portalı Çıkış Noktaları Arası Kaynak Paylaşımı (CORS) ayarları.

Name	Tür	Description
allowedOrigins	string[]	İzin verilen kaynaklar, örneğin `https://trusted.com`.

PortalConfigCspProperties

Object

Geliştirici portalı İçerik Güvenliği İlkesi (CSP) ayarları.

Name	Tür	Default value	Description
allowedSources	string[]		İzin verilen kaynaklar, örneğin `*.trusted.com`, `trusted.com`, `https://`.
mode	PortalSettingsCspMode	disabled	Geliştirici portalı İçerik Güvenliği İlkesi'nin (CSP) modu.
reportUri	string[]		Tarayıcı tarafından CSP ihlallerini bildirmek için kullanılan URL'ler.

PortalConfigDelegationProperties

Object

Name	Tür	Default value	Description
delegateRegistration	boolean	False	Kullanıcı kaydı için temsilci seçmeyi etkinleştirin veya devre dışı bırakın.
delegateSubscription	boolean	False	Ürün abonelikleri için temsilci seçmeyi etkinleştirin veya devre dışı bırakın.
delegationUrl	string		Temsilci uç noktası URL'si.
validationKey	string		İsteklerin Azure API Management hizmetinden kaynaklanmasını sağlamak için base64 kodlu doğrulama anahtarı.

PortalConfigTermsOfServiceProperties

Object

Hizmet sözleşmesi özellikleri koşulları.

Name	Tür	Default value	Description
requireConsent	boolean	False	Kullanıcıdan hizmet koşullarına onay isteyin.
text	string		Hizmet koşulları metni.

PortalSettingsCspMode

Listeleme

Geliştirici portalı İçerik Güvenliği İlkesi'nin (CSP) modu.

Değer	Description
enabled	Tarayıcı izin verilen kaynaklarla eşleşmeyen istekleri engeller.
disabled	Tarayıcı çıkış noktası kısıtlamalarını uygulamaz.
reportOnly	Tarayıcı izin verilen kaynaklarla eşleşmeyen istekleri engellemeden bildirir.

Object

Name	Tür	Default value	Description
require	boolean	False	Anonim kullanıcıları oturum açma sayfasına yönlendirin.

Object

Name	Tür	Description
termsOfService	PortalConfigTermsOfServiceProperties	Hizmet ayarları koşulları.

Aracılığıyla paylaş

Portal Config - Create Or Update

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

ApiManagementCreatePortalConfig

Örnek isteği

Örnek yanıt

Tanımlar

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PortalConfigContract

PortalConfigCorsProperties

PortalConfigCspProperties

PortalConfigDelegationProperties

PortalConfigTermsOfServiceProperties

PortalSettingsCspMode

Signin

Signup