Serviço Microsoft.ApiManagement/portalconfigs 2022-04-01-preview

Artigo
12/21/2024

Definição de recurso do Bicep

O tipo de recurso service/portalconfigs 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/portalconfigs, adicione o Bicep a seguir ao seu modelo.

resource symbolicname 'Microsoft.ApiManagement/service/portalconfigs@2022-04-01-preview' = {
  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

Nome	Descrição	Valor
nome	O nome do recurso	corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 1 (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ção do portal do desenvolvedor.	portalConfigProperties

PortalConfigCorsProperties

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

PortalConfigCspProperties

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

PortalConfigDelegationProperties

Nome	Descrição	Valor
delegateRegistration	Habilitar ou desabilitar a delegação para o registro do usuário.	Bool
delegateSubscription	Habilitar ou desabilitar a delegação para assinaturas de produtos.	Bool
delegationUrl	Uma URL de ponto de extremidade de delegação.	corda
validationKey	Uma chave de validação codificada em base64 para garantir que as solicitações se originem do serviço de Gerenciamento de API do Azure.	corda Restrições: Valor confidencial. Passe como um parâmetro seguro.

PortalConfigProperties

Nome	Descrição	Valor
cors	As configurações de CORS (Compartilhamento de Recursos entre Origens) do portal do desenvolvedor.	portalConfigCorsProperties
Csp	As configurações da CSP (Política de Segurança de Conteúdo) do portal do desenvolvedor.	portalConfigCspProperties
delegação	As configurações de delegação do portal do desenvolvedor.	portalConfigDelegationProperties
enableBasicAuth	Habilitar ou desabilitar o método de autenticação Básica.	Bool
entrar		portalConfigPropertiesSignin
inscrição		PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Nome	Descrição	Valor
requerer	Redirecione usuários anônimos para a página de entrada.	Bool

PortalConfigPropertiesSignup

Nome	Descrição	Valor
termsOfService	Termos de configurações de serviço.	PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Nome	Descrição	Valor
requireConsent	Peça ao usuário consentimento para os termos de serviço.	Bool
Texto	Um texto de termos de serviço.	corda

Definição de recurso de modelo do ARM

O tipo de recurso service/portalconfigs 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/portalconfigs, adicione o JSON a seguir ao modelo.

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

Microsoft.ApiManagement/service/portalconfigs

Nome	Descrição	Valor
apiVersion	A versão da API	'2022-04-01-preview'
nome	O nome do recurso	corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 1 (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

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

PortalConfigCspProperties

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

PortalConfigDelegationProperties

Nome	Descrição	Valor
delegateRegistration	Habilitar ou desabilitar a delegação para o registro do usuário.	Bool
delegateSubscription	Habilitar ou desabilitar a delegação para assinaturas de produtos.	Bool
delegationUrl	Uma URL de ponto de extremidade de delegação.	corda
validationKey	Uma chave de validação codificada em base64 para garantir que as solicitações se originem do serviço de Gerenciamento de API do Azure.	corda Restrições: Valor confidencial. Passe como um parâmetro seguro.

PortalConfigProperties

Nome	Descrição	Valor
cors	As configurações de CORS (Compartilhamento de Recursos entre Origens) do portal do desenvolvedor.	portalConfigCorsProperties
Csp	As configurações da CSP (Política de Segurança de Conteúdo) do portal do desenvolvedor.	portalConfigCspProperties
delegação	As configurações de delegação do portal do desenvolvedor.	portalConfigDelegationProperties
enableBasicAuth	Habilitar ou desabilitar o método de autenticação Básica.	Bool
entrar		portalConfigPropertiesSignin
inscrição		PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Nome	Descrição	Valor
requerer	Redirecione usuários anônimos para a página de entrada.	Bool

PortalConfigPropertiesSignup

Nome	Descrição	Valor
termsOfService	Termos de configurações de serviço.	PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Nome	Descrição	Valor
requireConsent	Peça ao usuário consentimento para os termos de serviç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/portalconfigs 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/portalconfigs, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/portalconfigs@2022-04-01-preview"
  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

Nome	Descrição	Valor
nome	O nome do recurso	corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 1 (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ção do portal do desenvolvedor.	portalConfigProperties
tipo	O tipo de recurso	"Microsoft.ApiManagement/service/portalconfigs@2022-04-01-preview"

PortalConfigCorsProperties

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

PortalConfigCspProperties

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

PortalConfigDelegationProperties

Nome	Descrição	Valor
delegateRegistration	Habilitar ou desabilitar a delegação para o registro do usuário.	Bool
delegateSubscription	Habilitar ou desabilitar a delegação para assinaturas de produtos.	Bool
delegationUrl	Uma URL de ponto de extremidade de delegação.	corda
validationKey	Uma chave de validação codificada em base64 para garantir que as solicitações se originem do serviço de Gerenciamento de API do Azure.	corda Restrições: Valor confidencial. Passe como um parâmetro seguro.

PortalConfigProperties

Nome	Descrição	Valor
cors	As configurações de CORS (Compartilhamento de Recursos entre Origens) do portal do desenvolvedor.	portalConfigCorsProperties
Csp	As configurações da CSP (Política de Segurança de Conteúdo) do portal do desenvolvedor.	portalConfigCspProperties
delegação	As configurações de delegação do portal do desenvolvedor.	portalConfigDelegationProperties
enableBasicAuth	Habilitar ou desabilitar o método de autenticação Básica.	Bool
entrar		portalConfigPropertiesSignin
inscrição		PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Nome	Descrição	Valor
requerer	Redirecione usuários anônimos para a página de entrada.	Bool

PortalConfigPropertiesSignup

Nome	Descrição	Valor
termsOfService	Termos de configurações de serviço.	PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Nome	Descrição	Valor
requireConsent	Peça ao usuário consentimento para os termos de serviço.	Bool
Texto	Um texto de termos de serviço.	corda

Compartilhar via

Serviço Microsoft.ApiManagement/portalconfigs 2022-04-01-preview

Definição de recurso do Bicep

Formato de recurso

Valores de propriedade

Microsoft.ApiManagement/service/portalconfigs

PortalConfigCorsProperties

PortalConfigCspProperties

PortalConfigDelegationProperties

PortalConfigProperties

PortalConfigPropertiesSignin

PortalConfigPropertiesSignup

PortalConfigTermsOfServiceProperties

Definição de recurso de modelo do ARM

Formato de recurso

Valores de propriedade

Microsoft.ApiManagement/service/portalconfigs

PortalConfigCorsProperties

PortalConfigCspProperties

PortalConfigDelegationProperties

PortalConfigProperties

PortalConfigPropertiesSignin

PortalConfigPropertiesSignup

PortalConfigTermsOfServiceProperties

Definição de recurso do Terraform (provedor de AzAPI)

Formato de recurso

Valores de propriedade

Microsoft.ApiManagement/service/portalconfigs

PortalConfigCorsProperties

PortalConfigCspProperties

PortalConfigDelegationProperties

PortalConfigProperties

PortalConfigPropertiesSignin

PortalConfigPropertiesSignup

PortalConfigTermsOfServiceProperties

Comentários

Recursos adicionais