Servicio Microsoft.ApiManagement/portalsettings 2024-05-01
- más reciente
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
Definición de recursos de Bicep
El tipo de recurso service/portalsettings 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/portalsettings, agregue el siguiente bicep a la plantilla.
resource symbolicname 'Microsoft.ApiManagement/service/portalsettings@2024-05-01' = {
name: 'string'
// For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}
objetos microsoft.apimanagement/service/portalsettings
Establezca el nombre propiedad para especificar el tipo de objeto.
Para inicio de sesión, use:
{
name: 'signin'
properties: {
enabled: bool
}
}
Para registro, use:
{
name: 'signup'
properties: {
enabled: bool
termsOfService: {
consentRequired: bool
enabled: bool
text: 'string'
}
}
}
Para delegación, use:
{
name: 'delegation'
properties: {
subscriptions: {
enabled: bool
}
url: 'string'
userRegistration: {
enabled: bool
}
validationKey: 'string'
}
}
Valores de propiedad
microsoft.apimanagement/service/portalsettings
| Nombre | Descripción | Valor |
|---|---|---|
| nombre | Establezca en "signin" para el tipo Microsoft.ApiManagement/service/portalsettings. Establezca en "signup" para el tipo Microsoft.ApiManagement/service/portalsettings. Establezca en "delegación" para el tipo Microsoft.ApiManagement/service/portalsettings. | 'delegación' 'signin' 'signup' (obligatorio) |
Microsoft.ApiManagement/service/portalsettings
| Nombre | Descripción | Valor |
|---|---|---|
| nombre | El nombre del recurso | 'signin' (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 de inicio de sesión. | PortalSigninSettingProperties |
Microsoft.ApiManagement/service/portalsettings
| Nombre | Descripción | Valor |
|---|---|---|
| nombre | El nombre del recurso | 'signup' (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 de registro. | PortalSignupSettingsProperties |
Microsoft.ApiManagement/service/portalsettings
| Nombre | Descripción | Valor |
|---|---|---|
| nombre | El nombre del recurso | 'delegación' (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 de delegación. | PortalDelegationSettingsProperties |
PortalDelegationSettingsProperties
| Nombre | Descripción | Valor |
|---|---|---|
| Suscripciones | Configuración de delegación de suscripciones. | subscriptionsDelegationSettingsProperties |
| URL | Dirección URL de delegación. | cuerda |
| userRegistration | Configuración de delegación de registro de usuarios. | registrationDelegationSettingsProperties |
| validationKey | Clave de validación codificada en base64 para validar que una solicitud procede de Azure API Management. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
PortalSigninSettingProperties
| Nombre | Descripción | Valor |
|---|---|---|
| Habilitado | Redirigir usuarios anónimos a la página de Sign-In. | Bool |
PortalSignupSettingsProperties
| Nombre | Descripción | Valor |
|---|---|---|
| Habilitado | Permitir que los usuarios se registren en un portal para desarrolladores. | Bool |
| termsOfService | Términos de las propiedades del contrato de servicio. | TermsOfServiceProperties |
RegistrationDelegationSettingsProperties
| Nombre | Descripción | Valor |
|---|---|---|
| Habilitado | Habilite o deshabilite la delegación para el registro de usuarios. | Bool |
SubscriptionsDelegationSettingsProperties
| Nombre | Descripción | Valor |
|---|---|---|
| Habilitado | Habilite o deshabilite la delegación para las suscripciones. | Bool |
TermsOfServiceProperties
| Nombre | Descripción | Valor |
|---|---|---|
| consentRequired | Pida al usuario que dé su consentimiento a los términos de servicio. | Bool |
| Habilitado | Mostrar términos de servicio durante un proceso de registro. | 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/portalsettings 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/portalsettings, agregue el siguiente JSON a la plantilla.
{
"name": "string"
// For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}
objetos microsoft.apimanagement/service/portalsettings
Establezca el nombre propiedad para especificar el tipo de objeto.
Para inicio de sesión, use:
{
"name": "signin",
"properties": {
"enabled": "bool"
}
}
Para registro, use:
{
"name": "signup",
"properties": {
"enabled": "bool",
"termsOfService": {
"consentRequired": "bool",
"enabled": "bool",
"text": "string"
}
}
}
Para delegación, use:
{
"name": "delegation",
"properties": {
"subscriptions": {
"enabled": "bool"
},
"url": "string",
"userRegistration": {
"enabled": "bool"
},
"validationKey": "string"
}
}
Valores de propiedad
microsoft.apimanagement/service/portalsettings
| Nombre | Descripción | Valor |
|---|---|---|
| nombre | Establezca en "signin" para el tipo Microsoft.ApiManagement/service/portalsettings. Establezca en "signup" para el tipo Microsoft.ApiManagement/service/portalsettings. Establezca en "delegación" para el tipo Microsoft.ApiManagement/service/portalsettings. | 'delegación' 'signin' 'signup' (obligatorio) |
Microsoft.ApiManagement/service/portalsettings
| Nombre | Descripción | Valor |
|---|---|---|
| apiVersion | La versión de api | '2024-05-01' |
| nombre | El nombre del recurso | 'signin' (obligatorio) |
| Propiedades | Propiedades del contrato de configuración de inicio de sesión. | PortalSigninSettingProperties |
| tipo | El tipo de recurso | "Microsoft.ApiManagement/service/portalsettings" |
Microsoft.ApiManagement/service/portalsettings
| Nombre | Descripción | Valor |
|---|---|---|
| apiVersion | La versión de api | '2024-05-01' |
| nombre | El nombre del recurso | 'signup' (obligatorio) |
| Propiedades | Propiedades del contrato de configuración de registro. | PortalSignupSettingsProperties |
| tipo | El tipo de recurso | "Microsoft.ApiManagement/service/portalsettings" |
Microsoft.ApiManagement/service/portalsettings
| Nombre | Descripción | Valor |
|---|---|---|
| apiVersion | La versión de api | '2024-05-01' |
| nombre | El nombre del recurso | 'delegación' (obligatorio) |
| Propiedades | Propiedades del contrato de configuración de delegación. | PortalDelegationSettingsProperties |
| tipo | El tipo de recurso | "Microsoft.ApiManagement/service/portalsettings" |
PortalDelegationSettingsProperties
| Nombre | Descripción | Valor |
|---|---|---|
| Suscripciones | Configuración de delegación de suscripciones. | subscriptionsDelegationSettingsProperties |
| URL | Dirección URL de delegación. | cuerda |
| userRegistration | Configuración de delegación de registro de usuarios. | registrationDelegationSettingsProperties |
| validationKey | Clave de validación codificada en base64 para validar que una solicitud procede de Azure API Management. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
PortalSigninSettingProperties
| Nombre | Descripción | Valor |
|---|---|---|
| Habilitado | Redirigir usuarios anónimos a la página de Sign-In. | Bool |
PortalSignupSettingsProperties
| Nombre | Descripción | Valor |
|---|---|---|
| Habilitado | Permitir que los usuarios se registren en un portal para desarrolladores. | Bool |
| termsOfService | Términos de las propiedades del contrato de servicio. | TermsOfServiceProperties |
RegistrationDelegationSettingsProperties
| Nombre | Descripción | Valor |
|---|---|---|
| Habilitado | Habilite o deshabilite la delegación para el registro de usuarios. | Bool |
SubscriptionsDelegationSettingsProperties
| Nombre | Descripción | Valor |
|---|---|---|
| Habilitado | Habilite o deshabilite la delegación para las suscripciones. | Bool |
TermsOfServiceProperties
| Nombre | Descripción | Valor |
|---|---|---|
| consentRequired | Pida al usuario que dé su consentimiento a los términos de servicio. | Bool |
| Habilitado | Mostrar términos de servicio durante un proceso de registro. | 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/portalsettings 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/portalsettings, agregue el siguiente terraform a la plantilla.
resource "azapi_resource" "symbolicname" {
name = "string"
// For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}
objetos microsoft.apimanagement/service/portalsettings
Establezca el nombre propiedad para especificar el tipo de objeto.
Para inicio de sesión, use:
{
name = "signin"
properties = {
enabled = bool
}
}
Para registro, use:
{
name = "signup"
properties = {
enabled = bool
termsOfService = {
consentRequired = bool
enabled = bool
text = "string"
}
}
}
Para delegación, use:
{
name = "delegation"
properties = {
subscriptions = {
enabled = bool
}
url = "string"
userRegistration = {
enabled = bool
}
validationKey = "string"
}
}
Valores de propiedad
microsoft.apimanagement/service/portalsettings
| Nombre | Descripción | Valor |
|---|---|---|
| nombre | Establezca en "signin" para el tipo Microsoft.ApiManagement/service/portalsettings. Establezca en "signup" para el tipo Microsoft.ApiManagement/service/portalsettings. Establezca en "delegación" para el tipo Microsoft.ApiManagement/service/portalsettings. | 'delegación' 'signin' 'signup' (obligatorio) |
Microsoft.ApiManagement/service/portalsettings
| Nombre | Descripción | Valor |
|---|---|---|
| nombre | El nombre del recurso | 'signin' (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 de inicio de sesión. | PortalSigninSettingProperties |
| tipo | El tipo de recurso | "Microsoft.ApiManagement/service/portalsettings@2024-05-01" |
Microsoft.ApiManagement/service/portalsettings
| Nombre | Descripción | Valor |
|---|---|---|
| nombre | El nombre del recurso | 'signup' (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 de registro. | PortalSignupSettingsProperties |
| tipo | El tipo de recurso | "Microsoft.ApiManagement/service/portalsettings@2024-05-01" |
Microsoft.ApiManagement/service/portalsettings
| Nombre | Descripción | Valor |
|---|---|---|
| nombre | El nombre del recurso | 'delegación' (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 de delegación. | PortalDelegationSettingsProperties |
| tipo | El tipo de recurso | "Microsoft.ApiManagement/service/portalsettings@2024-05-01" |
PortalDelegationSettingsProperties
| Nombre | Descripción | Valor |
|---|---|---|
| Suscripciones | Configuración de delegación de suscripciones. | subscriptionsDelegationSettingsProperties |
| URL | Dirección URL de delegación. | cuerda |
| userRegistration | Configuración de delegación de registro de usuarios. | registrationDelegationSettingsProperties |
| validationKey | Clave de validación codificada en base64 para validar que una solicitud procede de Azure API Management. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
PortalSigninSettingProperties
| Nombre | Descripción | Valor |
|---|---|---|
| Habilitado | Redirigir usuarios anónimos a la página de Sign-In. | Bool |
PortalSignupSettingsProperties
| Nombre | Descripción | Valor |
|---|---|---|
| Habilitado | Permitir que los usuarios se registren en un portal para desarrolladores. | Bool |
| termsOfService | Términos de las propiedades del contrato de servicio. | TermsOfServiceProperties |
RegistrationDelegationSettingsProperties
| Nombre | Descripción | Valor |
|---|---|---|
| Habilitado | Habilite o deshabilite la delegación para el registro de usuarios. | Bool |
SubscriptionsDelegationSettingsProperties
| Nombre | Descripción | Valor |
|---|---|---|
| Habilitado | Habilite o deshabilite la delegación para las suscripciones. | Bool |
TermsOfServiceProperties
| Nombre | Descripción | Valor |
|---|---|---|
| consentRequired | Pida al usuario que dé su consentimiento a los términos de servicio. | Bool |
| Habilitado | Mostrar términos de servicio durante un proceso de registro. | Bool |
| Mensaje de texto | Un texto de términos de servicio. | cuerda |