Microsoft.ApiManagement hizmeti/portal yapılandırmaları
- Makale
-
-
Bicep kaynak tanımı
Service/portalconfigs kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
- kaynak grupları - Bkz. kaynak grubu dağıtım komutları
Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.
Microsoft.ApiManagement/service/portalconfigs kaynağı oluşturmak için, şablonunuza aşağıdaki Bicep'i ekleyin.
resource symbolicname 'Microsoft.ApiManagement/service/portalconfigs@2023-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
cors: {
allowedOrigins: [
'string'
]
}
csp: {
allowedSources: [
'string'
]
mode: 'string'
reportUri: [
'string'
]
}
delegation: {
delegateRegistration: bool
delegateSubscription: bool
delegationUrl: 'string'
validationKey: 'string'
}
enableBasicAuth: bool
signin: {
require: bool
}
signup: {
termsOfService: {
requireConsent: bool
text: 'string'
}
}
}
}
Özellik değerleri
service/portalconfigs
Ad |
Açıklama |
Değer |
ad |
Kaynak adı
Bicep'nde alt kaynaklar için adları ve türleri ayarlamayı öğrenin. |
dize (gerekli) |
ebeveyn |
Bicep'te bir alt kaynak için üst kaynak belirtebilirsiniz. Bu özelliği yalnızca alt kaynak üst kaynağın dışında bildirildiğinde eklemeniz gerekir.
Daha fazla bilgi için bkz. Alt kaynaküst kaynak dışında. |
Kaynak türü için sembolik ad: hizmet |
Özellikler |
Geliştirici portalı yapılandırma sözleşmesi özellikleri. |
PortalConfigProperties |
PortalConfigProperties
PortalConfigCorsProperties
Ad |
Açıklama |
Değer |
allowedOrigins |
İzin verilen kaynaklar, örneğin https://trusted.com . |
string[] |
PortalConfigCspProperties
Ad |
Açıklama |
Değer |
allowedSources |
İzin verilen kaynaklar, örneğin *.trusted.com , trusted.com , https:// . |
string[] |
mod |
Geliştirici portalı İçerik Güvenliği İlkesi'nin (CSP) modu. |
'devre dışı' 'etkin' 'reportOnly' |
reportUri |
Tarayıcı tarafından CSP ihlallerini bildirmek için kullanılan URL'ler. |
string[] |
PortalConfigDelegationProperties
Ad |
Açıklama |
Değer |
delegateRegistration |
Kullanıcı kaydı için temsilci seçmeyi etkinleştirin veya devre dışı bırakın. |
Bool |
delegateSubscription |
Ürün abonelikleri için temsilci seçmeyi etkinleştirin veya devre dışı bırakın. |
Bool |
delegationUrl |
Temsilci uç noktası URL'si. |
dizgi |
validationKey |
İsteklerin Azure API Management hizmetinden kaynaklanmasını sağlamak için base64 kodlu doğrulama anahtarı. |
dizgi
Kısıtlama -ları: Hassas değer. Güvenli parametre olarak geçirin.
|
PortalConfigPropertiesSignin
Ad |
Açıklama |
Değer |
istemek |
Anonim kullanıcıları oturum açma sayfasına yönlendirin. |
Bool |
PortalConfigPropertiesSignup
PortalConfigTermsOfServiceProperties
Ad |
Açıklama |
Değer |
requireConsent |
Kullanıcıdan hizmet koşullarına onay isteyin. |
Bool |
Metin |
Hizmet koşulları metni. |
dizgi |
ARM şablonu kaynak tanımı
Service/portalconfigs kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
- kaynak grupları - Bkz. kaynak grubu dağıtım komutları
Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.
Microsoft.ApiManagement/service/portalconfigs kaynağı oluşturmak için şablonunuza aşağıdaki JSON'u ekleyin.
{
"type": "Microsoft.ApiManagement/service/portalconfigs",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"cors": {
"allowedOrigins": [ "string" ]
},
"csp": {
"allowedSources": [ "string" ],
"mode": "string",
"reportUri": [ "string" ]
},
"delegation": {
"delegateRegistration": "bool",
"delegateSubscription": "bool",
"delegationUrl": "string",
"validationKey": "string"
},
"enableBasicAuth": "bool",
"signin": {
"require": "bool"
},
"signup": {
"termsOfService": {
"requireConsent": "bool",
"text": "string"
}
}
}
}
Özellik değerleri
service/portalconfigs
Ad |
Açıklama |
Değer |
tür |
Kaynak türü |
'Microsoft.ApiManagement/service/portalconfigs' |
apiVersion |
Kaynak API'sinin sürümü |
'2023-09-01-preview' |
ad |
Kaynak adı
JSON ARM şablonlarında alt kaynakların adlarını ve türlerini ayarlamayı öğrenin. |
dize (gerekli) |
Özellikler |
Geliştirici portalı yapılandırma sözleşmesi özellikleri. |
PortalConfigProperties |
PortalConfigProperties
PortalConfigCorsProperties
Ad |
Açıklama |
Değer |
allowedOrigins |
İzin verilen kaynaklar, örneğin https://trusted.com . |
string[] |
PortalConfigCspProperties
Ad |
Açıklama |
Değer |
allowedSources |
İzin verilen kaynaklar, örneğin *.trusted.com , trusted.com , https:// . |
string[] |
mod |
Geliştirici portalı İçerik Güvenliği İlkesi'nin (CSP) modu. |
'devre dışı' 'etkin' 'reportOnly' |
reportUri |
Tarayıcı tarafından CSP ihlallerini bildirmek için kullanılan URL'ler. |
string[] |
PortalConfigDelegationProperties
Ad |
Açıklama |
Değer |
delegateRegistration |
Kullanıcı kaydı için temsilci seçmeyi etkinleştirin veya devre dışı bırakın. |
Bool |
delegateSubscription |
Ürün abonelikleri için temsilci seçmeyi etkinleştirin veya devre dışı bırakın. |
Bool |
delegationUrl |
Temsilci uç noktası URL'si. |
dizgi |
validationKey |
İsteklerin Azure API Management hizmetinden kaynaklanmasını sağlamak için base64 kodlu doğrulama anahtarı. |
dizgi
Kısıtlama -ları: Hassas değer. Güvenli parametre olarak geçirin.
|
PortalConfigPropertiesSignin
Ad |
Açıklama |
Değer |
istemek |
Anonim kullanıcıları oturum açma sayfasına yönlendirin. |
Bool |
PortalConfigPropertiesSignup
PortalConfigTermsOfServiceProperties
Ad |
Açıklama |
Değer |
requireConsent |
Kullanıcıdan hizmet koşullarına onay isteyin. |
Bool |
Metin |
Hizmet koşulları metni. |
dizgi |
Service/portalconfigs kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.
Microsoft.ApiManagement/service/portalconfigs kaynağı oluşturmak için şablonunuza aşağıdaki Terraform'u ekleyin.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/portalconfigs@2023-09-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
cors = {
allowedOrigins = [
"string"
]
}
csp = {
allowedSources = [
"string"
]
mode = "string"
reportUri = [
"string"
]
}
delegation = {
delegateRegistration = bool
delegateSubscription = bool
delegationUrl = "string"
validationKey = "string"
}
enableBasicAuth = bool
signin = {
require = bool
}
signup = {
termsOfService = {
requireConsent = bool
text = "string"
}
}
}
})
}
Özellik değerleri
service/portalconfigs
Ad |
Açıklama |
Değer |
tür |
Kaynak türü |
"Microsoft.ApiManagement/service/portalconfigs@2023-09-01-preview" |
ad |
Kaynak adı |
dize (gerekli) |
parent_id |
Bu kaynağın üst öğesi olan kaynağın kimliği. |
Kaynak türü için kimlik: hizmet |
Özellikler |
Geliştirici portalı yapılandırma sözleşmesi özellikleri. |
PortalConfigProperties |
PortalConfigProperties
PortalConfigCorsProperties
Ad |
Açıklama |
Değer |
allowedOrigins |
İzin verilen kaynaklar, örneğin https://trusted.com . |
string[] |
PortalConfigCspProperties
Ad |
Açıklama |
Değer |
allowedSources |
İzin verilen kaynaklar, örneğin *.trusted.com , trusted.com , https:// . |
string[] |
mod |
Geliştirici portalı İçerik Güvenliği İlkesi'nin (CSP) modu. |
"devre dışı" "etkin" "reportOnly" |
reportUri |
Tarayıcı tarafından CSP ihlallerini bildirmek için kullanılan URL'ler. |
string[] |
PortalConfigDelegationProperties
Ad |
Açıklama |
Değer |
delegateRegistration |
Kullanıcı kaydı için temsilci seçmeyi etkinleştirin veya devre dışı bırakın. |
Bool |
delegateSubscription |
Ürün abonelikleri için temsilci seçmeyi etkinleştirin veya devre dışı bırakın. |
Bool |
delegationUrl |
Temsilci uç noktası URL'si. |
dizgi |
validationKey |
İsteklerin Azure API Management hizmetinden kaynaklanmasını sağlamak için base64 kodlu doğrulama anahtarı. |
dizgi
Kısıtlama -ları: Hassas değer. Güvenli parametre olarak geçirin.
|
PortalConfigPropertiesSignin
Ad |
Açıklama |
Değer |
istemek |
Anonim kullanıcıları oturum açma sayfasına yönlendirin. |
Bool |
PortalConfigPropertiesSignup
PortalConfigTermsOfServiceProperties
Ad |
Açıklama |
Değer |
requireConsent |
Kullanıcıdan hizmet koşullarına onay isteyin. |
Bool |
Metin |
Hizmet koşulları metni. |
dizgi |