Microsoft.ApiManagement service/portalsettings 2024-05-01

The service/portalsettings resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

To create a Microsoft.ApiManagement/service/portalsettings resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ApiManagement/service/portalsettings@2024-05-01' = {
  name: 'string'
  // For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}

Set the name property to specify the type of object.

For signin, use:

{
  name: 'signin'
  properties: {
    enabled: bool
  }
}

For signup, use:

{
  name: 'signup'
  properties: {
    enabled: bool
    termsOfService: {
      consentRequired: bool
      enabled: bool
      text: 'string'
    }
  }
}

For delegation, use:

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

The service/portalsettings resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

To create a Microsoft.ApiManagement/service/portalsettings resource, add the following JSON to your template.

{
  "name": "string"
  // For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}

Set the name property to specify the type of object.

For signin, use:

{
  "name": "signin",
  "properties": {
    "enabled": "bool"
  }
}

For signup, use:

{
  "name": "signup",
  "properties": {
    "enabled": "bool",
    "termsOfService": {
      "consentRequired": "bool",
      "enabled": "bool",
      "text": "string"
    }
  }
}

For delegation, use:

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

The service/portalsettings resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

To create a Microsoft.ApiManagement/service/portalsettings resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  name = "string"
  // For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}

Set the name property to specify the type of object.

For signin, use:

{
  name = "signin"
  properties = {
    enabled = bool
  }
}

For signup, use:

{
  name = "signup"
  properties = {
    enabled = bool
    termsOfService = {
      consentRequired = bool
      enabled = bool
      text = "string"
    }
  }
}

For delegation, use:

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