Partilhar via


Microsoft.ApiManagement service/portalsettings 2022-08-01

Definição de recursos do bíceps

O tipo de recurso service/portalsettings pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/portalsettings, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.ApiManagement/service/portalsettings@2022-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 início de sessão, utilize:

{
  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, utilize:

{
  name: 'delegation'
  properties: {
    subscriptions: {
      enabled: bool
    }
    url: 'string'
    userRegistration: {
      enabled: bool
    }
    validationKey: 'string'
  }
}

Valores de propriedade

microsoft.apimanagement/service/portalsettings

Designação Descrição Valor
Designação 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'
'Entrar'
'Inscrição' (obrigatório)

Microsoft.ApiManagement/service/portalsettings

Designação Descrição Valor
Designação 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 para recurso do tipo: serviço
propriedades Propriedades do contrato de configurações de login. PortalSigninSettingProperties

Microsoft.ApiManagement/service/portalsettings

Designação Descrição Valor
Designação O nome do recurso 'Inscriçã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 para recurso do tipo: serviço
propriedades Configurações de inscrição, propriedades do contrato. PortalSignupSettingsProperties

Microsoft.ApiManagement/service/portalsettings

Designação Descrição Valor
Designação 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 para recurso do tipo: serviço
propriedades Propriedades do contrato de configurações de delegação. PortalDelegationSettingsProperties

PortalDelegationSettingsProperties

Designação Descrição Valor
Subscrições Configurações de delegação de assinaturas. SubscriptionsDelegationSettingsProperties
URL Um URL de delegação. string
userRegisto Configurações de delegação de registro de usuário. RegistrationDelegationSettingsProperties
chave de validação Uma chave de validação codificada em base64 para validar que uma solicitação está vindo do Gerenciamento de API do Azure. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.

PortalSigninSettingProperties

Designação Descrição Valor
ativado Redirecionar usuários anônimos para a página Sign-In. Bool

PortalSignupSettingsProperties

Designação Descrição Valor
ativado Permitir que os usuários se inscrevam em um portal do desenvolvedor. Bool
termosdeserviço Termos de propriedade do contrato de serviços. TermsOfServiceProperties

RegistrationDelegationSettingsProperties

Designação Descrição Valor
ativado Habilite ou desabilite a delegação para registro de usuário. Bool

AssinaturasDelegaçãoConfiguraçõesPropriedades

Designação Descrição Valor
ativado Habilite ou desabilite a delegação para assinaturas. Bool

TermsOfServiceProperties

Designação Descrição Valor
consentimentoObrigatório Peça ao utilizador o consentimento para os termos de serviço. Bool
ativado Exiba os termos de serviço durante um processo de inscrição. Bool
Texto Um texto de termos de serviço. string

Definição de recurso de modelo ARM

O tipo de recurso service/portalsettings pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/portalsettings, adicione o seguinte JSON ao seu 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 início de sessão, utilize:

{
  "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, utilize:

{
  "name": "delegation",
  "properties": {
    "subscriptions": {
      "enabled": "bool"
    },
    "url": "string",
    "userRegistration": {
      "enabled": "bool"
    },
    "validationKey": "string"
  }
}

Valores de propriedade

microsoft.apimanagement/service/portalsettings

Designação Descrição Valor
Designação 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'
'Entrar'
'Inscrição' (obrigatório)

Microsoft.ApiManagement/service/portalsettings

Designação Descrição Valor
apiVersion A versão api '2022-08-01'
Designação O nome do recurso 'Signin' (obrigatório)
propriedades Propriedades do contrato de configurações de login. PortalSigninSettingProperties
tipo O tipo de recurso 'Microsoft.ApiManagement/service/portalsettings'

Microsoft.ApiManagement/service/portalsettings

Designação Descrição Valor
apiVersion A versão api '2022-08-01'
Designação O nome do recurso 'Inscrição' (obrigatório)
propriedades Configurações de inscrição, propriedades do contrato. PortalSignupSettingsProperties
tipo O tipo de recurso 'Microsoft.ApiManagement/service/portalsettings'

Microsoft.ApiManagement/service/portalsettings

Designação Descrição Valor
apiVersion A versão api '2022-08-01'
Designação 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

Designação Descrição Valor
Subscrições Configurações de delegação de assinaturas. SubscriptionsDelegationSettingsProperties
URL Um URL de delegação. string
userRegisto Configurações de delegação de registro de usuário. RegistrationDelegationSettingsProperties
chave de validação Uma chave de validação codificada em base64 para validar que uma solicitação está vindo do Gerenciamento de API do Azure. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.

PortalSigninSettingProperties

Designação Descrição Valor
ativado Redirecionar usuários anônimos para a página Sign-In. Bool

PortalSignupSettingsProperties

Designação Descrição Valor
ativado Permitir que os usuários se inscrevam em um portal do desenvolvedor. Bool
termosdeserviço Termos de propriedade do contrato de serviços. TermsOfServiceProperties

RegistrationDelegationSettingsProperties

Designação Descrição Valor
ativado Habilite ou desabilite a delegação para registro de usuário. Bool

AssinaturasDelegaçãoConfiguraçõesPropriedades

Designação Descrição Valor
ativado Habilite ou desabilite a delegação para assinaturas. Bool

TermsOfServiceProperties

Designação Descrição Valor
consentimentoObrigatório Peça ao utilizador o consentimento para os termos de serviço. Bool
ativado Exiba os termos de serviço durante um processo de inscrição. Bool
Texto Um texto de termos de serviço. string

Definição de recursos Terraform (provedor 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 log de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/portalsettings, adicione o seguinte Terraform 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 início de sessão, utilize:

{
  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, utilize:

{
  name = "delegation"
  properties = {
    subscriptions = {
      enabled = bool
    }
    url = "string"
    userRegistration = {
      enabled = bool
    }
    validationKey = "string"
  }
}

Valores de propriedade

microsoft.apimanagement/service/portalsettings

Designação Descrição Valor
Designação 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'
'Entrar'
'Inscrição' (obrigatório)

Microsoft.ApiManagement/service/portalsettings

Designação Descrição Valor
Designação O nome do recurso 'Signin' (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID do recurso do tipo: serviço
propriedades Propriedades do contrato de configurações de login. PortalSigninSettingProperties
tipo O tipo de recurso "Microsoft.ApiManagement/service/portalsettings@2022-08-01"

Microsoft.ApiManagement/service/portalsettings

Designação Descrição Valor
Designação O nome do recurso 'Inscrição' (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID do recurso do tipo: serviço
propriedades Configurações de inscrição, propriedades do contrato. PortalSignupSettingsProperties
tipo O tipo de recurso "Microsoft.ApiManagement/service/portalsettings@2022-08-01"

Microsoft.ApiManagement/service/portalsettings

Designação Descrição Valor
Designação O nome do recurso «Delegação» (obrigatório)
parent_id A ID do recurso que é o pai para este 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@2022-08-01"

PortalDelegationSettingsProperties

Designação Descrição Valor
Subscrições Configurações de delegação de assinaturas. SubscriptionsDelegationSettingsProperties
URL Um URL de delegação. string
userRegisto Configurações de delegação de registro de usuário. RegistrationDelegationSettingsProperties
chave de validação Uma chave de validação codificada em base64 para validar que uma solicitação está vindo do Gerenciamento de API do Azure. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.

PortalSigninSettingProperties

Designação Descrição Valor
ativado Redirecionar usuários anônimos para a página Sign-In. Bool

PortalSignupSettingsProperties

Designação Descrição Valor
ativado Permitir que os usuários se inscrevam em um portal do desenvolvedor. Bool
termosdeserviço Termos de propriedade do contrato de serviços. TermsOfServiceProperties

RegistrationDelegationSettingsProperties

Designação Descrição Valor
ativado Habilite ou desabilite a delegação para registro de usuário. Bool

AssinaturasDelegaçãoConfiguraçõesPropriedades

Designação Descrição Valor
ativado Habilite ou desabilite a delegação para assinaturas. Bool

TermsOfServiceProperties

Designação Descrição Valor
consentimentoObrigatório Peça ao utilizador o consentimento para os termos de serviço. Bool
ativado Exiba os termos de serviço durante um processo de inscrição. Bool
Texto Um texto de termos de serviço. string