Microsoft.ApiManagement service/portalconfigs
- más reciente
- 2023-09-01-preview
- 2022-08-01
Definición de recursos de Bicep
El tipo de recurso service/portalconfigs se puede implementar con operaciones que tienen como destino:
- grupos de recursos: consulte comandos de implementación de grupos de recursos
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de recurso
Para crear un recurso Microsoft.ApiManagement/service/portalconfigs, agregue el siguiente bicep a la plantilla.
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'
}
}
}
}
Valores de propiedad
service/portalconfigs
| Nombre | Descripción | Valor |
|---|---|---|
| nombre | El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en Bicep. |
string (obligatorio) |
| padre | 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 obtener más información, consulte recurso secundario fuera del recurso primario. |
Nombre simbólico del recurso de tipo: de servicio de |
| Propiedades | Propiedades del contrato de configuración del portal para desarrolladores. | PortalConfigProperties |
PortalConfigProperties
| Nombre | Descripción | Valor |
|---|---|---|
| cors | La configuración del uso compartido de recursos entre orígenes (CORS) del portal para desarrolladores. | PortalConfigCorsProperties |
| Csp | Configuración de la directiva de seguridad de contenido (CSP) del portal para desarrolladores. | portalConfigCspProperties |
| delegación | Configuración de delegación del portal para desarrolladores. | PortalConfigDelegationProperties |
| enableBasicAuth | Habilite o deshabilite el método de autenticación básico. | Bool |
| signin | PortalConfigPropertiesSignin | |
| suscripción | PortalConfigPropertiesSignup |
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[] |
| modo | 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 producto. | Bool |
| delegationUrl | Dirección URL del punto de conexión de delegación. | cuerda |
| validationKey | Clave de validación codificada en base64 para asegurarse de que las solicitudes se originan en el servicio Azure API Management. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
PortalConfigPropertiesSignin
| Nombre | Descripción | Valor |
|---|---|---|
| requerir | Redirigir usuarios anónimos a la página de inicio de sesión. | Bool |
PortalConfigPropertiesSignup
| Nombre | Descripción | Valor |
|---|---|---|
| termsOfService | Términos de configuración del servicio. | PortalConfigTermsOfServiceProperties |
PortalConfigTermsOfServiceProperties
| Nombre | Descripción | Valor |
|---|---|---|
| requireConsent | Pida al usuario que dé su consentimiento a los términos de servicio. | Bool |
| Mensaje de texto | Un texto de términos de servicio. | cuerda |
Definición de recursos de plantilla de ARM
El tipo de recurso service/portalconfigs se puede implementar con operaciones que tienen como destino:
- grupos de recursos: consulte comandos de implementación de grupos de recursos
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de recurso
Para crear un recurso Microsoft.ApiManagement/service/portalconfigs, agregue el siguiente JSON a la plantilla.
{
"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"
}
}
}
}
Valores de propiedad
service/portalconfigs
| Nombre | Descripción | Valor |
|---|---|---|
| tipo | El tipo de recurso | "Microsoft.ApiManagement/service/portalconfigs" |
| apiVersion | La versión de la API de recursos | '2023-09-01-preview' |
| nombre | El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json. |
string (obligatorio) |
| Propiedades | Propiedades del contrato de configuración del portal para desarrolladores. | PortalConfigProperties |
PortalConfigProperties
| Nombre | Descripción | Valor |
|---|---|---|
| cors | La configuración del uso compartido de recursos entre orígenes (CORS) del portal para desarrolladores. | PortalConfigCorsProperties |
| Csp | Configuración de la directiva de seguridad de contenido (CSP) del portal para desarrolladores. | portalConfigCspProperties |
| delegación | Configuración de delegación del portal para desarrolladores. | PortalConfigDelegationProperties |
| enableBasicAuth | Habilite o deshabilite el método de autenticación básico. | Bool |
| signin | PortalConfigPropertiesSignin | |
| suscripción | PortalConfigPropertiesSignup |
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[] |
| modo | 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 producto. | Bool |
| delegationUrl | Dirección URL del punto de conexión de delegación. | cuerda |
| validationKey | Clave de validación codificada en base64 para asegurarse de que las solicitudes se originan en el servicio Azure API Management. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
PortalConfigPropertiesSignin
| Nombre | Descripción | Valor |
|---|---|---|
| requerir | Redirigir usuarios anónimos a la página de inicio de sesión. | Bool |
PortalConfigPropertiesSignup
| Nombre | Descripción | Valor |
|---|---|---|
| termsOfService | Términos de configuración del servicio. | PortalConfigTermsOfServiceProperties |
PortalConfigTermsOfServiceProperties
| Nombre | Descripción | Valor |
|---|---|---|
| requireConsent | Pida al usuario que dé su consentimiento a los términos de servicio. | Bool |
| Mensaje de texto | Un texto de términos de servicio. | cuerda |
Definición de recursos de Terraform (proveedor AzAPI)
El tipo de recurso service/portalconfigs se puede implementar con operaciones que tienen como destino:
- grupos de recursos de
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de recurso
Para crear un recurso Microsoft.ApiManagement/service/portalconfigs, agregue el siguiente terraform a la plantilla.
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"
}
}
}
})
}
Valores de propiedad
service/portalconfigs
| Nombre | Descripción | Valor |
|---|---|---|
| tipo | El tipo de recurso | "Microsoft.ApiManagement/service/portalconfigs@2023-09-01-preview" |
| nombre | El nombre del recurso | string (obligatorio) |
| parent_id | Identificador del recurso que es el elemento primario de este recurso. | Identificador del recurso de tipo: de servicio de |
| Propiedades | Propiedades del contrato de configuración del portal para desarrolladores. | PortalConfigProperties |
PortalConfigProperties
| Nombre | Descripción | Valor |
|---|---|---|
| cors | La configuración del uso compartido de recursos entre orígenes (CORS) del portal para desarrolladores. | PortalConfigCorsProperties |
| Csp | Configuración de la directiva de seguridad de contenido (CSP) del portal para desarrolladores. | portalConfigCspProperties |
| delegación | Configuración de delegación del portal para desarrolladores. | PortalConfigDelegationProperties |
| enableBasicAuth | Habilite o deshabilite el método de autenticación básico. | Bool |
| signin | PortalConfigPropertiesSignin | |
| suscripción | PortalConfigPropertiesSignup |
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[] |
| modo | Modo de la directiva de seguridad de contenido (CSP) del portal para desarrolladores. | "deshabilitado" "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 producto. | Bool |
| delegationUrl | Dirección URL del punto de conexión de delegación. | cuerda |
| validationKey | Clave de validación codificada en base64 para asegurarse de que las solicitudes se originan en el servicio Azure API Management. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
PortalConfigPropertiesSignin
| Nombre | Descripción | Valor |
|---|---|---|
| requerir | Redirigir usuarios anónimos a la página de inicio de sesión. | Bool |
PortalConfigPropertiesSignup
| Nombre | Descripción | Valor |
|---|---|---|
| termsOfService | Términos de configuración del servicio. | PortalConfigTermsOfServiceProperties |
PortalConfigTermsOfServiceProperties
| Nombre | Descripción | Valor |
|---|---|---|
| requireConsent | Pida al usuario que dé su consentimiento a los términos de servicio. | Bool |
| Mensaje de texto | Un texto de términos de servicio. | cuerda |