Servicio Microsoft.ApiManagement/portalconfigs 2022-04-01-preview
Artículo 01/16/2024
1 colaborador
Comentarios
En este artículo
Definición de recursos de Bicep
El tipo de recurso service/portalconfigs se puede implementar con operaciones que tienen como destino:
Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios .
Para crear un recurso Microsoft.ApiManagement/service/portalconfigs, agregue el siguiente bicep a la plantilla.
resource symbolicname 'Microsoft.ApiManagement/service/portalconfigs@2022-04-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'
}
}
}
}
Valores de propiedad
service/portalconfigs
Nombre
Descripción
Value
name
El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en Bicep .
string (obligatorio)
primario
En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario. Para más información, consulte Recurso secundario fuera del recurso primario .
Nombre simbólico del recurso de tipo: servicio
properties
Propiedades del contrato de configuración del portal para desarrolladores.
PortalConfigProperties
PortalConfigProperties
PortalConfigCorsProperties
Nombre
Descripción
Valor
allowedOrigins
Orígenes permitidos, por ejemplo, https://trusted.com
.
string[]
PortalConfigCspProperties
Nombre
Descripción
Valor
allowedSources
Orígenes permitidos, por ejemplo *.trusted.com
, , trusted.com
, https://
.
string[]
mode
Modo de la directiva de seguridad de contenido (CSP) del portal para desarrolladores.
'disabled' "habilitado" 'reportOnly'
reportUri
Las direcciones URL usadas por el explorador para notificar infracciones de CSP.
string[]
PortalConfigDelegationProperties
Nombre
Descripción
Valor
delegateRegistration
Habilite o deshabilite la delegación para el registro de usuarios.
bool
delegateSubscription
Habilite o deshabilite la delegación para las suscripciones de productos.
bool
delegationUrl
Dirección URL del punto de conexión de delegación.
string
validationKey
Una clave de validación codificada en base64 para garantizar que las solicitudes se originen en el servicio Azure API Management.
string
PortalConfigPropertiesSignin
Nombre
Descripción
Valor
require
Redirija a los usuarios anónimos a la página de inicio de sesión.
bool
PortalConfigPropertiesSignup
PortalConfigTermsOfServiceProperties
Nombre
Descripción
Valor
requireConsent
Pida al usuario que dé su consentimiento a los términos de servicio.
bool
text
Texto de los términos del servicio.
string
Definición de recursos de plantilla de ARM
El tipo de recurso service/portalconfigs se puede implementar con operaciones que tienen como destino:
Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios .
Para crear un recurso Microsoft.ApiManagement/service/portalconfigs, agregue el siguiente json a la plantilla.
{
"type": "Microsoft.ApiManagement/service/portalconfigs",
"apiVersion": "2022-04-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"
}
}
}
}
Valores de propiedad
service/portalconfigs
Nombre
Descripción
Value
type
Tipo de recurso
"Microsoft.ApiManagement/service/portalconfigs"
apiVersion
La versión de la API de recursos
"2022-04-01-preview"
name
El nombre del recurso Consulte cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json .
string (obligatorio)
properties
Propiedades del contrato de configuración del portal para desarrolladores.
PortalConfigProperties
PortalConfigProperties
PortalConfigCorsProperties
Nombre
Descripción
Valor
allowedOrigins
Orígenes permitidos, por ejemplo, https://trusted.com
.
string[]
PortalConfigCspProperties
Nombre
Descripción
Valor
allowedSources
Orígenes permitidos, por ejemplo *.trusted.com
, , trusted.com
, https://
.
string[]
mode
Modo de la directiva de seguridad de contenido (CSP) del portal para desarrolladores.
'disabled' "habilitado" 'reportOnly'
reportUri
Las direcciones URL usadas por el explorador para notificar infracciones de CSP.
string[]
PortalConfigDelegationProperties
Nombre
Descripción
Valor
delegateRegistration
Habilite o deshabilite la delegación para el registro de usuarios.
bool
delegateSubscription
Habilite o deshabilite la delegación para las suscripciones de productos.
bool
delegationUrl
Dirección URL del punto de conexión de delegación.
string
validationKey
Una clave de validación codificada en base64 para garantizar que las solicitudes se originen en el servicio Azure API Management.
string
PortalConfigPropertiesSignin
Nombre
Descripción
Valor
require
Redirija a los usuarios anónimos a la página de inicio de sesión.
bool
PortalConfigPropertiesSignup
PortalConfigTermsOfServiceProperties
Nombre
Descripción
Valor
requireConsent
Pida al usuario que dé su consentimiento a los términos de servicio.
bool
text
Texto de los términos del servicio.
string
El tipo de recurso service/portalconfigs se puede implementar con operaciones que tienen como destino:
Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios .
Para crear un recurso Microsoft.ApiManagement/service/portalconfigs, agregue el siguiente terraform a la plantilla.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/portalconfigs@2022-04-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"
}
}
}
})
}
Valores de propiedad
service/portalconfigs
Nombre
Descripción
Value
type
Tipo de recurso
"Microsoft.ApiManagement/service/portalconfigs@2022-04-01-preview"
name
El nombre del recurso
string (obligatorio)
parent_id
Identificador del recurso que es el elemento primario de este recurso.
Identificador del recurso de tipo: servicio
properties
Propiedades del contrato de configuración del portal para desarrolladores.
PortalConfigProperties
PortalConfigProperties
PortalConfigCorsProperties
Nombre
Descripción
Valor
allowedOrigins
Orígenes permitidos, por ejemplo, https://trusted.com
.
string[]
PortalConfigCspProperties
Nombre
Descripción
Valor
allowedSources
Orígenes permitidos, por ejemplo *.trusted.com
, , trusted.com
, https://
.
string[]
mode
Modo de la directiva de seguridad de contenido (CSP) del portal para desarrolladores.
"disabled" "enabled" "reportOnly"
reportUri
Las direcciones URL usadas por el explorador para notificar infracciones de CSP.
string[]
PortalConfigDelegationProperties
Nombre
Descripción
Valor
delegateRegistration
Habilite o deshabilite la delegación para el registro de usuarios.
bool
delegateSubscription
Habilite o deshabilite la delegación para las suscripciones de productos.
bool
delegationUrl
Dirección URL del punto de conexión de delegación.
string
validationKey
Una clave de validación codificada en base64 para asegurarse de que las solicitudes se originan en el servicio Azure API Management.
string
PortalConfigPropertiesSignin
Nombre
Descripción
Valor
require
Redirigir usuarios anónimos a la página de inicio de sesión.
bool
PortalConfigPropertiesSignup
PortalConfigTermsOfServiceProperties
Nombre
Descripción
Valor
requireConsent
Pida al usuario que dé su consentimiento a los términos de servicio.
bool
text
Términos de texto del servicio.
string