Share via

Microsoft.ApiManagement service/users 2016-07-07

Bicep resource definition

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

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

Resource format

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

resource symbolicname 'Microsoft.ApiManagement/service/users@2016-07-07' = {
  parent: resourceSymbolicName
  email: 'string'
  firstName: 'string'
  lastName: 'string'
  name: 'string'
  note: 'string'
  password: 'string'
  state: 'string'
}

Property Values

Microsoft.ApiManagement/service/users

Name Description Value
email Email address. Must not be empty and must be unique within the service instance. string

Constraints:
Min length = 1
Max length = 254 (required)
firstName First name. string

Constraints:
Min length = 1
Max length = 100 (required)
lastName Last name. string

Constraints:
Min length = 1
Max length = 100 (required)
name The resource name string

Constraints:
Min length = 1
Max length = 256
Pattern = ^[^*#&+:<>?]+$ (required)
note Optional note about a user set by the administrator. string
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: service
password User Password. string (required)
state Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. 'Active'
'Blocked'

Usage Examples

Bicep Samples

A basic example of deploying API Management User.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource service 'Microsoft.ApiManagement/service@2021-08-01' = {
  name: resourceName
  location: location
  properties: {
    certificates: []
    customProperties: {
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_GCM_SHA384': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11': 'false'
    }
    disableGateway: false
    publicNetworkAccess: 'Enabled'
    publisherEmail: 'pub1@email.com'
    publisherName: 'pub1'
    virtualNetworkType: 'None'
  }
  sku: {
    capacity: 1
    name: 'Developer'
  }
}

resource user 'Microsoft.ApiManagement/service/users@2021-08-01' = {
  parent: service
  name: resourceName
  properties: {
    email: 'azure-acctest230630032559695401@example.com'
    firstName: 'Acceptance'
    lastName: 'Test'
  }
}

ARM template resource definition

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

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

Resource format

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

{
  "type": "Microsoft.ApiManagement/service/users",
  "apiVersion": "2016-07-07",
  "name": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "note": "string",
  "password": "string",
  "state": "string"
}

Property Values

Microsoft.ApiManagement/service/users

Name Description Value
apiVersion The api version '2016-07-07'
email Email address. Must not be empty and must be unique within the service instance. string

Constraints:
Min length = 1
Max length = 254 (required)
firstName First name. string

Constraints:
Min length = 1
Max length = 100 (required)
lastName Last name. string

Constraints:
Min length = 1
Max length = 100 (required)
name The resource name string

Constraints:
Min length = 1
Max length = 256
Pattern = ^[^*#&+:<>?]+$ (required)
note Optional note about a user set by the administrator. string
password User Password. string (required)
state Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. 'Active'
'Blocked'
type The resource type 'Microsoft.ApiManagement/service/users'

Usage Examples

Terraform (AzAPI provider) resource definition

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

  • Resource groups

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

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/users@2016-07-07"
  name = "string"
  parent_id = "string"
  body = {
    email = "string"
    firstName = "string"
    lastName = "string"
    note = "string"
    password = "string"
    state = "string"
  }
}

Property Values

Microsoft.ApiManagement/service/users

Name Description Value
email Email address. Must not be empty and must be unique within the service instance. string

Constraints:
Min length = 1
Max length = 254 (required)
firstName First name. string

Constraints:
Min length = 1
Max length = 100 (required)
lastName Last name. string

Constraints:
Min length = 1
Max length = 100 (required)
name The resource name string

Constraints:
Min length = 1
Max length = 256
Pattern = ^[^*#&+:<>?]+$ (required)
note Optional note about a user set by the administrator. string
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service
password User Password. string (required)
state Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. 'Active'
'Blocked'
type The resource type "Microsoft.ApiManagement/service/users@2016-07-07"

Usage Examples

Terraform Samples

A basic example of deploying API Management User.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "service" {
  type      = "Microsoft.ApiManagement/service@2021-08-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      certificates = [
      ]
      customProperties = {
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30"                      = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10"                      = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11"                      = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"   = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA"   = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA"         = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256"      = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256"      = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA"         = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256"      = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_GCM_SHA384"      = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168"                         = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30"                              = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10"                              = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11"                              = "false"
      }
      disableGateway      = false
      publicNetworkAccess = "Enabled"
      publisherEmail      = "pub1@email.com"
      publisherName       = "pub1"
      virtualNetworkType  = "None"
    }
    sku = {
      capacity = 1
      name     = "Developer"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
  timeouts {
    create = "180m"
    update = "180m"
    delete = "180m"
  }
}

resource "azapi_resource" "user" {
  type      = "Microsoft.ApiManagement/service/users@2021-08-01"
  parent_id = azapi_resource.service.id
  name      = var.resource_name
  body = {
    properties = {
      email     = "azure-acctest230630032559695401@example.com"
      firstName = "Acceptance"
      lastName  = "Test"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on