Microsoft.ApiManagement service/users
Bicep resource definition
The service/users 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.
Resource format
To create a Microsoft.ApiManagement/service/users resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ApiManagement/service/users@2023-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
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 |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) Character limit: 1-80 Valid characters: Alphanumerics and hyphens. Start with letter and end with alphanumeric. |
| 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. | UserCreateParameterPropertiesOrUserContractPropertie... |
UserCreateParameterPropertiesOrUserContractPropertie...
| 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 address. Must not be empty and must be unique within the service instance. | string (required) Constraints: Min length = 1 Max length = 254 |
|
| firstName | First name. | string (required) Constraints: Min length = 1 Max length = 100 |
| identities | Collection of user identities. | UserIdentityContract[] |
| lastName | Last name. | string (required) Constraints: Min length = 1 Max length = 100 |
| 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 |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create an API Management instance and all sub resources using template |
This template demonstrates how to create a API Management service and configure sub-entities |
ARM template resource definition
The service/users 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.
Resource format
To create a Microsoft.ApiManagement/service/users resource, add the following JSON to your template.
{
"type": "Microsoft.ApiManagement/service/users",
"apiVersion": "2023-09-01-preview",
"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
service/users
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.ApiManagement/service/users' |
| apiVersion | The resource api version | '2023-09-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) Character limit: 1-80 Valid characters: Alphanumerics and hyphens. Start with letter and end with alphanumeric. |
| properties | User entity create contract properties. | UserCreateParameterPropertiesOrUserContractPropertie... |
UserCreateParameterPropertiesOrUserContractPropertie...
| 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 address. Must not be empty and must be unique within the service instance. | string (required) Constraints: Min length = 1 Max length = 254 |
|
| firstName | First name. | string (required) Constraints: Min length = 1 Max length = 100 |
| identities | Collection of user identities. | UserIdentityContract[] |
| lastName | Last name. | string (required) Constraints: Min length = 1 Max length = 100 |
| 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 |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Create an API Management instance and all sub resources using template |
This template demonstrates how to create a API Management service and configure sub-entities |
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@2023-09-01-preview"
name = "string"
parent_id = "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
service/users
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.ApiManagement/service/users@2023-09-01-preview" |
| name | The resource name | string (required) Character limit: 1-80 Valid characters: Alphanumerics and hyphens. Start with letter and end with alphanumeric. |
| 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. | UserCreateParameterPropertiesOrUserContractPropertie... |
UserCreateParameterPropertiesOrUserContractPropertie...
| 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 address. Must not be empty and must be unique within the service instance. | string (required) Constraints: Min length = 1 Max length = 254 |
|
| firstName | First name. | string (required) Constraints: Min length = 1 Max length = 100 |
| identities | Collection of user identities. | UserIdentityContract[] |
| lastName | Last name. | string (required) Constraints: Min length = 1 Max length = 100 |
| 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 |