Serviço Microsoft.ApiManagement/portalsettings 2021-08-01
- última
- 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
Definição de recurso do Bicep
O tipo de recurso service/portalsettings pode ser implantado com operações direcionadas:
- Grupos de recursos - Consulte comandos de implantação do grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.ApiManagement/service/portalsettings, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.ApiManagement/service/portalsettings@2021-08-01' = {
name: 'string'
// For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}
objetos microsoft.apimanagement/service/portalsettings
Defina o nome propriedade para especificar o tipo de objeto.
Para de entrada, use:
{
name: 'signin'
properties: {
enabled: bool
}
}
Para de inscrição, use:
{
name: 'signup'
properties: {
enabled: bool
termsOfService: {
consentRequired: bool
enabled: bool
text: 'string'
}
}
}
Para delegação, use:
{
name: 'delegation'
properties: {
subscriptions: {
enabled: bool
}
url: 'string'
userRegistration: {
enabled: bool
}
validationKey: 'string'
}
}
Valores de propriedade
microsoft.apimanagement/service/portalsettings
| Nome | Descrição | Valor |
|---|---|---|
| nome | Defina como 'signin' para o tipo Microsoft.ApiManagement/service/portalsettings. Defina como 'signup' para o tipo Microsoft.ApiManagement/service/portalsettings. Defina como "delegação" para o tipo Microsoft.ApiManagement/service/portalsettings. | 'delegação' 'signin' 'signup' (obrigatório) |
Microsoft.ApiManagement/service/portalsettings
| Nome | Descrição | Valor |
|---|---|---|
| nome | O nome do recurso | 'signin' (obrigatório) |
| pai | No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai. Para obter mais informações, consulte recurso filho fora do recurso pai. |
Nome simbólico do recurso do tipo: de serviço |
| Propriedades | Propriedades do contrato de configurações de entrada. | portalSigninSettingProperties |
Microsoft.ApiManagement/service/portalsettings
| Nome | Descrição | Valor |
|---|---|---|
| nome | O nome do recurso | 'signup' (obrigatório) |
| pai | No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai. Para obter mais informações, consulte recurso filho fora do recurso pai. |
Nome simbólico do recurso do tipo: de serviço |
| Propriedades | As propriedades do contrato de configurações de inscrição. | PortalSignupSettingsProperties |
Microsoft.ApiManagement/service/portalsettings
| Nome | Descrição | Valor |
|---|---|---|
| nome | O nome do recurso | 'delegação' (obrigatório) |
| pai | No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai. Para obter mais informações, consulte recurso filho fora do recurso pai. |
Nome simbólico do recurso do tipo: de serviço |
| Propriedades | Propriedades do contrato de configurações de delegação. | portalDelegationSettingsProperties |
PortalDelegationSettingsProperties
| Nome | Descrição | Valor |
|---|---|---|
| Assinaturas | Configurações de delegação de assinaturas. | SubscriptionsDelegationSettingsProperties |
| url | Uma URL de delegação. | corda |
| userRegistration | Configurações de delegação de registro de usuário. | RegistrationDelegationSettingsProperties |
| validationKey | Uma chave de validação codificada em base64 para validar que uma solicitação vem do Gerenciamento de API do Azure. | corda Restrições: Valor confidencial. Passe como um parâmetro seguro. |
PortalSigninSettingProperties
| Nome | Descrição | Valor |
|---|---|---|
| Habilitado | Redirecione usuários anônimos para a página Sign-In. | Bool |
PortalSignupSettingsProperties
| Nome | Descrição | Valor |
|---|---|---|
| Habilitado | Permitir que os usuários se inscrevam em um portal do desenvolvedor. | Bool |
| termsOfService | Termos de propriedades do contrato de serviço. | TermsOfServiceProperties |
RegistrationDelegationSettingsProperties
| Nome | Descrição | Valor |
|---|---|---|
| Habilitado | Habilitar ou desabilitar a delegação para o registro do usuário. | Bool |
SubscriptionsDelegationSettingsProperties
| Nome | Descrição | Valor |
|---|---|---|
| Habilitado | Habilite ou desabilite a delegação para assinaturas. | Bool |
TermsOfServiceProperties
| Nome | Descrição | Valor |
|---|---|---|
| consentRequired | Peça ao usuário consentimento para os termos de serviço. | Bool |
| Habilitado | Exibir termos de serviço durante um processo de inscrição. | Bool |
| Texto | Um texto de termos de serviço. | corda |
Definição de recurso de modelo do ARM
O tipo de recurso service/portalsettings pode ser implantado com operações direcionadas:
- Grupos de recursos - Consulte comandos de implantação do grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.ApiManagement/service/portalsettings, adicione o JSON a seguir ao modelo.
{
"name": "string"
// For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}
objetos microsoft.apimanagement/service/portalsettings
Defina o nome propriedade para especificar o tipo de objeto.
Para de entrada, use:
{
"name": "signin",
"properties": {
"enabled": "bool"
}
}
Para de inscrição, use:
{
"name": "signup",
"properties": {
"enabled": "bool",
"termsOfService": {
"consentRequired": "bool",
"enabled": "bool",
"text": "string"
}
}
}
Para delegação, use:
{
"name": "delegation",
"properties": {
"subscriptions": {
"enabled": "bool"
},
"url": "string",
"userRegistration": {
"enabled": "bool"
},
"validationKey": "string"
}
}
Valores de propriedade
microsoft.apimanagement/service/portalsettings
| Nome | Descrição | Valor |
|---|---|---|
| nome | Defina como 'signin' para o tipo Microsoft.ApiManagement/service/portalsettings. Defina como 'signup' para o tipo Microsoft.ApiManagement/service/portalsettings. Defina como "delegação" para o tipo Microsoft.ApiManagement/service/portalsettings. | 'delegação' 'signin' 'signup' (obrigatório) |
Microsoft.ApiManagement/service/portalsettings
| Nome | Descrição | Valor |
|---|---|---|
| apiVersion | A versão da API | '2021-08-01' |
| nome | O nome do recurso | 'signin' (obrigatório) |
| Propriedades | Propriedades do contrato de configurações de entrada. | portalSigninSettingProperties |
| tipo | O tipo de recurso | 'Microsoft.ApiManagement/service/portalsettings' |
Microsoft.ApiManagement/service/portalsettings
| Nome | Descrição | Valor |
|---|---|---|
| apiVersion | A versão da API | '2021-08-01' |
| nome | O nome do recurso | 'signup' (obrigatório) |
| Propriedades | As propriedades do contrato de configurações de inscrição. | PortalSignupSettingsProperties |
| tipo | O tipo de recurso | 'Microsoft.ApiManagement/service/portalsettings' |
Microsoft.ApiManagement/service/portalsettings
| Nome | Descrição | Valor |
|---|---|---|
| apiVersion | A versão da API | '2021-08-01' |
| nome | O nome do recurso | 'delegação' (obrigatório) |
| Propriedades | Propriedades do contrato de configurações de delegação. | portalDelegationSettingsProperties |
| tipo | O tipo de recurso | 'Microsoft.ApiManagement/service/portalsettings' |
PortalDelegationSettingsProperties
| Nome | Descrição | Valor |
|---|---|---|
| Assinaturas | Configurações de delegação de assinaturas. | SubscriptionsDelegationSettingsProperties |
| url | Uma URL de delegação. | corda |
| userRegistration | Configurações de delegação de registro de usuário. | RegistrationDelegationSettingsProperties |
| validationKey | Uma chave de validação codificada em base64 para validar que uma solicitação vem do Gerenciamento de API do Azure. | corda Restrições: Valor confidencial. Passe como um parâmetro seguro. |
PortalSigninSettingProperties
| Nome | Descrição | Valor |
|---|---|---|
| Habilitado | Redirecione usuários anônimos para a página Sign-In. | Bool |
PortalSignupSettingsProperties
| Nome | Descrição | Valor |
|---|---|---|
| Habilitado | Permitir que os usuários se inscrevam em um portal do desenvolvedor. | Bool |
| termsOfService | Termos de propriedades do contrato de serviço. | TermsOfServiceProperties |
RegistrationDelegationSettingsProperties
| Nome | Descrição | Valor |
|---|---|---|
| Habilitado | Habilitar ou desabilitar a delegação para o registro do usuário. | Bool |
SubscriptionsDelegationSettingsProperties
| Nome | Descrição | Valor |
|---|---|---|
| Habilitado | Habilite ou desabilite a delegação para assinaturas. | Bool |
TermsOfServiceProperties
| Nome | Descrição | Valor |
|---|---|---|
| consentRequired | Peça ao usuário consentimento para os termos de serviço. | Bool |
| Habilitado | Exibir termos de serviço durante um processo de inscrição. | Bool |
| Texto | Um texto de termos de serviço. | corda |
Definição de recurso do Terraform (provedor de AzAPI)
O tipo de recurso service/portalsettings pode ser implantado com operações direcionadas:
- grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.ApiManagement/service/portalsettings, adicione o Terraform a seguir ao seu modelo.
resource "azapi_resource" "symbolicname" {
name = "string"
// For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}
objetos microsoft.apimanagement/service/portalsettings
Defina o nome propriedade para especificar o tipo de objeto.
Para de entrada, use:
{
name = "signin"
properties = {
enabled = bool
}
}
Para de inscrição, use:
{
name = "signup"
properties = {
enabled = bool
termsOfService = {
consentRequired = bool
enabled = bool
text = "string"
}
}
}
Para delegação, use:
{
name = "delegation"
properties = {
subscriptions = {
enabled = bool
}
url = "string"
userRegistration = {
enabled = bool
}
validationKey = "string"
}
}
Valores de propriedade
microsoft.apimanagement/service/portalsettings
| Nome | Descrição | Valor |
|---|---|---|
| nome | Defina como 'signin' para o tipo Microsoft.ApiManagement/service/portalsettings. Defina como 'signup' para o tipo Microsoft.ApiManagement/service/portalsettings. Defina como "delegação" para o tipo Microsoft.ApiManagement/service/portalsettings. | 'delegação' 'signin' 'signup' (obrigatório) |
Microsoft.ApiManagement/service/portalsettings
| Nome | Descrição | Valor |
|---|---|---|
| nome | O nome do recurso | 'signin' (obrigatório) |
| parent_id | A ID do recurso que é o pai desse recurso. | ID do recurso do tipo: serviço |
| Propriedades | Propriedades do contrato de configurações de entrada. | portalSigninSettingProperties |
| tipo | O tipo de recurso | "Microsoft.ApiManagement/service/portalsettings@2021-08-01" |
Microsoft.ApiManagement/service/portalsettings
| Nome | Descrição | Valor |
|---|---|---|
| nome | O nome do recurso | 'signup' (obrigatório) |
| parent_id | A ID do recurso que é o pai desse recurso. | ID do recurso do tipo: serviço |
| Propriedades | As propriedades do contrato de configurações de inscrição. | PortalSignupSettingsProperties |
| tipo | O tipo de recurso | "Microsoft.ApiManagement/service/portalsettings@2021-08-01" |
Microsoft.ApiManagement/service/portalsettings
| Nome | Descrição | Valor |
|---|---|---|
| nome | O nome do recurso | 'delegação' (obrigatório) |
| parent_id | A ID do recurso que é o pai desse recurso. | ID do recurso do tipo: serviço |
| Propriedades | Propriedades do contrato de configurações de delegação. | portalDelegationSettingsProperties |
| tipo | O tipo de recurso | "Microsoft.ApiManagement/service/portalsettings@2021-08-01" |
PortalDelegationSettingsProperties
| Nome | Descrição | Valor |
|---|---|---|
| Assinaturas | Configurações de delegação de assinaturas. | SubscriptionsDelegationSettingsProperties |
| url | Uma URL de delegação. | corda |
| userRegistration | Configurações de delegação de registro de usuário. | RegistrationDelegationSettingsProperties |
| validationKey | Uma chave de validação codificada em base64 para validar que uma solicitação vem do Gerenciamento de API do Azure. | corda Restrições: Valor confidencial. Passe como um parâmetro seguro. |
PortalSigninSettingProperties
| Nome | Descrição | Valor |
|---|---|---|
| Habilitado | Redirecione usuários anônimos para a página Sign-In. | Bool |
PortalSignupSettingsProperties
| Nome | Descrição | Valor |
|---|---|---|
| Habilitado | Permitir que os usuários se inscrevam em um portal do desenvolvedor. | Bool |
| termsOfService | Termos de propriedades do contrato de serviço. | TermsOfServiceProperties |
RegistrationDelegationSettingsProperties
| Nome | Descrição | Valor |
|---|---|---|
| Habilitado | Habilitar ou desabilitar a delegação para o registro do usuário. | Bool |
SubscriptionsDelegationSettingsProperties
| Nome | Descrição | Valor |
|---|---|---|
| Habilitado | Habilite ou desabilite a delegação para assinaturas. | Bool |
TermsOfServiceProperties
| Nome | Descrição | Valor |
|---|---|---|
| consentRequired | Peça ao usuário consentimento para os termos de serviço. | Bool |
| Habilitado | Exibir termos de serviço durante um processo de inscrição. | Bool |
| Texto | Um texto de termos de serviço. | corda |