Share via

Microsoft.ApiManagement service/users 2022-08-01

  • Article

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@2022-08-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    appType: 'string'
    confirmation: 'string'
    email: 'string'
    firstName: 'string'
    identities: [
      {
        id: 'string'
        provider: 'string'
      }
    ]
    lastName: 'string'
    note: 'string'
    password: 'string'
    state: 'string'
  }
}

Property values

Microsoft.ApiManagement/service/users

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 1 (required)
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
properties User entity create contract properties. UserCreateParameterPropertiesOrUserContractProperties

UserCreateParameterPropertiesOrUserContractProperties

Name Description Value
appType Determines the type of application which send the create user request. Default is legacy portal. 'developerPortal'
'portal'
confirmation Determines the type of confirmation e-mail that will be sent to the newly created user. 'invite'
'signup'
email Email address. Must not be empty and must be unique within the service instance. string

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

Constraints:
Min length = 1
Max length = 1 (required)
identities Collection of user identities. UserIdentityContract[]
lastName Last name. string

Constraints:
Min length = 1
Max length = 1 (required)
note Optional note about a user set by the administrator. string
password User Password. If no value is provided, a default password is generated. string
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'
'deleted'
'pending'

UserIdentityContract

Name Description Value
id Identifier value within provider. string
provider Identity provider name. string

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": "2022-08-01",
  "name": "string",
  "properties": {
    "appType": "string",
    "confirmation": "string",
    "email": "string",
    "firstName": "string",
    "identities": [
      {
        "id": "string",
        "provider": "string"
      }
    ],
    "lastName": "string",
    "note": "string",
    "password": "string",
    "state": "string"
  }
}

Property values

Microsoft.ApiManagement/service/users

Name Description Value
apiVersion The api version '2022-08-01'
name The resource name string

Constraints:
Min length = 1
Max length = 1 (required)
properties User entity create contract properties. UserCreateParameterPropertiesOrUserContractProperties
type The resource type 'Microsoft.ApiManagement/service/users'

UserCreateParameterPropertiesOrUserContractProperties

Name Description Value
appType Determines the type of application which send the create user request. Default is legacy portal. 'developerPortal'
'portal'
confirmation Determines the type of confirmation e-mail that will be sent to the newly created user. 'invite'
'signup'
email Email address. Must not be empty and must be unique within the service instance. string

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

Constraints:
Min length = 1
Max length = 1 (required)
identities Collection of user identities. UserIdentityContract[]
lastName Last name. string

Constraints:
Min length = 1
Max length = 1 (required)
note Optional note about a user set by the administrator. string
password User Password. If no value is provided, a default password is generated. string
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'
'deleted'
'pending'

UserIdentityContract

Name Description Value
id Identifier value within provider. string
provider Identity provider name. string

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@2022-08-01"
  name = "string"
  body = jsonencode({
    properties = {
      appType = "string"
      confirmation = "string"
      email = "string"
      firstName = "string"
      identities = [
        {
          id = "string"
          provider = "string"
        }
      ]
      lastName = "string"
      note = "string"
      password = "string"
      state = "string"
    }
  })
}

Property values

Microsoft.ApiManagement/service/users

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 1 (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service
properties User entity create contract properties. UserCreateParameterPropertiesOrUserContractProperties
type The resource type "Microsoft.ApiManagement/service/users@2022-08-01"

UserCreateParameterPropertiesOrUserContractProperties

Name Description Value
appType Determines the type of application which send the create user request. Default is legacy portal. 'developerPortal'
'portal'
confirmation Determines the type of confirmation e-mail that will be sent to the newly created user. 'invite'
'signup'
email Email address. Must not be empty and must be unique within the service instance. string

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

Constraints:
Min length = 1
Max length = 1 (required)
identities Collection of user identities. UserIdentityContract[]
lastName Last name. string

Constraints:
Min length = 1
Max length = 1 (required)
note Optional note about a user set by the administrator. string
password User Password. If no value is provided, a default password is generated. string
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'
'deleted'
'pending'

UserIdentityContract

Name Description Value
id Identifier value within provider. string
provider Identity provider name. string