Microsoft.ApiManagement service/users 2019-01-01

The service/users resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

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

resource symbolicname 'Microsoft.ApiManagement/service/users@2019-01-01' = {
  name: 'string'
  parent: parentSymbolicName
  properties: {
    appType: 'string'
    confirmation: 'string'
    email: 'string'
    firstName: 'string'
    identities: [
      {
        id: 'string'
        provider: 'string'
      }
    ]
    lastName: 'string'
    note: 'string'
    password: 'string'
    state: 'string'
  }
}

Property values

service/users

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.ApiManagement/service/users'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2019-01-01'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (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.
parentSymbolicName
properties User profile. UserCreateParameterProperties

UserCreateParameterProperties

Name Description Value
appType 'developerPortal'
'portal'
confirmation 'invite'
'signup'
email Email address. string (required)
firstName First name. string (required)
identities Collection of user identities. UserIdentityContract[]
lastName Last name. string (required)
note Optional note about a user set by the administrator. string
password 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

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an API Management instance and all sub resources using template

Deploy to Azure
This template demonstrates how to create a API Management service and configure sub-entities