Microsoft.ApiManagement serviço/portalconfigs 2024-05-01

Artigo
12/21/2024

Definição de recursos do bíceps

O tipo de recurso service/portalconfigs pode ser implantado com operações que visam:

Grupos de recursos - Consulte comandos de implantação de grupo 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/portalconfigs, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.ApiManagement/service/portalconfigs@2024-05-01' = {
  parent: resourceSymbolicName
  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 propriedade

Microsoft.ApiManagement/service/portalconfigs

Designação	Descrição	Valor
Designação	O nome do recurso	string Restrições: Comprimento mínimo = 1 Comprimento máximo = 80 (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	As propriedades do contrato de configuração do portal do desenvolvedor.	PortalConfigProperties

PortalConfigCorsProperties

Designação	Descrição	Valor
allowedOrigens	Origens permitidas, por exemplo, `https://trusted.com`.	string[]

PortalConfigCspProperties

Designação	Descrição	Valor
allowedFontes	Fontes permitidas, por exemplo, `*.trusted.com`, `trusted.com`, `https://`.	string[]
modo	O modo da Política de Segurança de Conteúdo (CSP) do portal do desenvolvedor.	'deficientes' 'habilitado' 'ReportOnly'
reportUri	Os URLs usados pelo navegador para relatar violações de CSP.	string[]

PortalConfigDelegationProperties

Designação	Descrição	Valor
delegarRegisto	Habilite ou desabilite a delegação para registro de usuário.	Bool
delegarSubscrição	Habilite ou desabilite a delegação para assinaturas de produtos.	Bool
delegationUrl	Uma URL de ponto de extremidade de delegação.	string
chave de validação	Uma chave de validação codificada em base64 para garantir que as solicitações sejam originadas do serviço de Gerenciamento de API do Azure.	string Restrições: Valor sensível. Passe como um parâmetro seguro.

PortalConfigProperties

Designação	Descrição	Valor
CORS	As configurações do CORS (Cross-Origin Resource Sharing) do portal do desenvolvedor.	PortalConfigCorsProperties
CSP	As configurações da Política de Segurança de Conteúdo (CSP) do portal do desenvolvedor.	PortalConfigCspProperties
delegação	As configurações de delegação do portal do desenvolvedor.	PortalConfigDelegationProperties
enableBasicAuth	Habilite ou desabilite o método de autenticação Básico.	Bool
iniciar sessão		PortalConfigPropertiesSignin
registe-se		PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Designação	Descrição	Valor
requerer	Redirecione utilizadores anónimos para a página de início de sessão.	Bool

PortalConfigPropertiesSignup

Designação	Descrição	Valor
termosdeserviço	Configurações de termos de serviço.	PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Designação	Descrição	Valor
exigirConsentimento	Peça ao utilizador o consentimento para os termos de serviço.	Bool
Texto	Um texto de termos de serviço.	string

Definição de recurso de modelo ARM

O tipo de recurso service/portalconfigs pode ser implantado com operações que visam:

Grupos de recursos - Consulte comandos de implantação de grupo 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/portalconfigs, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.ApiManagement/service/portalconfigs",
  "apiVersion": "2024-05-01",
  "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 propriedade

Microsoft.ApiManagement/service/portalconfigs

Designação	Descrição	Valor
apiVersion	A versão api	'2024-05-01'
Designação	O nome do recurso	string Restrições: Comprimento mínimo = 1 Comprimento máximo = 80 (obrigatório)
propriedades	As propriedades do contrato de configuração do portal do desenvolvedor.	PortalConfigProperties
tipo	O tipo de recurso	'Microsoft.ApiManagement/service/portalconfigs'

PortalConfigCorsProperties

Designação	Descrição	Valor
allowedOrigens	Origens permitidas, por exemplo, `https://trusted.com`.	string[]

PortalConfigCspProperties

Designação	Descrição	Valor
allowedFontes	Fontes permitidas, por exemplo, `*.trusted.com`, `trusted.com`, `https://`.	string[]
modo	O modo da Política de Segurança de Conteúdo (CSP) do portal do desenvolvedor.	'deficientes' 'habilitado' 'ReportOnly'
reportUri	Os URLs usados pelo navegador para relatar violações de CSP.	string[]

PortalConfigDelegationProperties

Designação	Descrição	Valor
delegarRegisto	Habilite ou desabilite a delegação para registro de usuário.	Bool
delegarSubscrição	Habilite ou desabilite a delegação para assinaturas de produtos.	Bool
delegationUrl	Uma URL de ponto de extremidade de delegação.	string
chave de validação	Uma chave de validação codificada em base64 para garantir que as solicitações sejam originadas do serviço de Gerenciamento de API do Azure.	string Restrições: Valor sensível. Passe como um parâmetro seguro.

PortalConfigProperties

Designação	Descrição	Valor
CORS	As configurações do CORS (Cross-Origin Resource Sharing) do portal do desenvolvedor.	PortalConfigCorsProperties
CSP	As configurações da Política de Segurança de Conteúdo (CSP) do portal do desenvolvedor.	PortalConfigCspProperties
delegação	As configurações de delegação do portal do desenvolvedor.	PortalConfigDelegationProperties
enableBasicAuth	Habilite ou desabilite o método de autenticação Básico.	Bool
iniciar sessão		PortalConfigPropertiesSignin
registe-se		PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Designação	Descrição	Valor
requerer	Redirecione utilizadores anónimos para a página de início de sessão.	Bool

PortalConfigPropertiesSignup

Designação	Descrição	Valor
termosdeserviço	Configurações de termos de serviço.	PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Designação	Descrição	Valor
exigirConsentimento	Peça ao utilizador o consentimento para os termos de serviço.	Bool
Texto	Um texto de termos de serviço.	string

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso service/portalconfigs pode ser implantado com operações que visam:

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/portalconfigs, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/portalconfigs@2024-05-01"
  name = "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 propriedade

Microsoft.ApiManagement/service/portalconfigs

Designação	Descrição	Valor
Designação	O nome do recurso	string Restrições: Comprimento mínimo = 1 Comprimento máximo = 80 (obrigatório)
parent_id	A ID do recurso que é o pai para este recurso.	ID do recurso do tipo: serviço
propriedades	As propriedades do contrato de configuração do portal do desenvolvedor.	PortalConfigProperties
tipo	O tipo de recurso	"Microsoft.ApiManagement/service/portalconfigs@2024-05-01"

PortalConfigCorsProperties

Designação	Descrição	Valor
allowedOrigens	Origens permitidas, por exemplo, `https://trusted.com`.	string[]

PortalConfigCspProperties

Designação	Descrição	Valor
allowedFontes	Fontes permitidas, por exemplo, `*.trusted.com`, `trusted.com`, `https://`.	string[]
modo	O modo da Política de Segurança de Conteúdo (CSP) do portal do desenvolvedor.	'deficientes' 'habilitado' 'ReportOnly'
reportUri	Os URLs usados pelo navegador para relatar violações de CSP.	string[]

PortalConfigDelegationProperties

Designação	Descrição	Valor
delegarRegisto	Habilite ou desabilite a delegação para registro de usuário.	Bool
delegarSubscrição	Habilite ou desabilite a delegação para assinaturas de produtos.	Bool
delegationUrl	Uma URL de ponto de extremidade de delegação.	string
chave de validação	Uma chave de validação codificada em base64 para garantir que as solicitações sejam originadas do serviço de Gerenciamento de API do Azure.	string Restrições: Valor sensível. Passe como um parâmetro seguro.

PortalConfigProperties

Designação	Descrição	Valor
CORS	As configurações do CORS (Cross-Origin Resource Sharing) do portal do desenvolvedor.	PortalConfigCorsProperties
CSP	As configurações da Política de Segurança de Conteúdo (CSP) do portal do desenvolvedor.	PortalConfigCspProperties
delegação	As configurações de delegação do portal do desenvolvedor.	PortalConfigDelegationProperties
enableBasicAuth	Habilite ou desabilite o método de autenticação Básico.	Bool
iniciar sessão		PortalConfigPropertiesSignin
registe-se		PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Designação	Descrição	Valor
requerer	Redirecione utilizadores anónimos para a página de início de sessão.	Bool

PortalConfigPropertiesSignup

Designação	Descrição	Valor
termosdeserviço	Configurações de termos de serviço.	PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Designação	Descrição	Valor
exigirConsentimento	Peça ao utilizador o consentimento para os termos de serviço.	Bool
Texto	Um texto de termos de serviço.	string

Partilhar via

Microsoft.ApiManagement serviço/portalconfigs 2024-05-01

Definição de recursos do bíceps

Formato do recurso

Valores de propriedade

Microsoft.ApiManagement/service/portalconfigs

PortalConfigCorsProperties

PortalConfigCspProperties

PortalConfigDelegationProperties

PortalConfigProperties

PortalConfigPropertiesSignin

PortalConfigPropertiesSignup

PortalConfigTermsOfServiceProperties

Definição de recurso de modelo ARM

Formato do recurso

Valores de propriedade

Microsoft.ApiManagement/service/portalconfigs

PortalConfigCorsProperties

PortalConfigCspProperties

PortalConfigDelegationProperties

PortalConfigProperties

PortalConfigPropertiesSignin

PortalConfigPropertiesSignup

PortalConfigTermsOfServiceProperties

Definição de recursos Terraform (provedor AzAPI)

Formato do recurso

Valores de propriedade

Microsoft.ApiManagement/service/portalconfigs

PortalConfigCorsProperties

PortalConfigCspProperties

PortalConfigDelegationProperties

PortalConfigProperties

PortalConfigPropertiesSignin

PortalConfigPropertiesSignup

PortalConfigTermsOfServiceProperties

Comentários

Recursos adicionais