Microsoft.ApiManagement-tjänsten/användare 2021-08-01
Bicep-resursdefinition
Resurstypen tjänst/användare kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/users-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.ApiManagement/service/users@2021-08-01' = {
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'
}
}
Egenskapsvärden
tjänst/användare
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Resursnamnet Se hur du anger namn och typer för underordnade resurser i Bicep. |
sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. |
| förälder | I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför den överordnade resursen. |
Symboliskt namn för resurs av typen: tjänst |
| Egenskaper | Skapa kontraktegenskaper för användarentitet. | UserCreateParameterPropertiesOrUserContractPropertie... |
UserCreateParameterPropertiesOrUserContractPropertie...
| Namn | Beskrivning | Värde |
|---|---|---|
| appType | Avgör vilken typ av program som skickar begäran om att skapa användare. Standard är den äldre portalen. | "developerPortal" "portal" |
| konfirmation | Avgör vilken typ av e-postbekräftelse som ska skickas till den nyskapade användaren. | "bjud in" "registrering" |
| E-post | E-postadress. Får inte vara tom och måste vara unik i tjänstinstansen. | sträng (krävs) Begränsningar: Min längd = 1 Maximal längd = 254 |
| firstName | Förnamn. | sträng (krävs) Begränsningar: Min längd = 1 Maxlängd = 100 |
| Identiteter | Samling med användaridentiteter. | UserIdentityContract[] |
| lastName | Efternamn. | sträng (krävs) Begränsningar: Min längd = 1 Maxlängd = 100 |
| not | Valfritt meddelande om en användare som angetts av administratören. | sträng |
| lösenord | Användarlösenord. Om inget värde anges genereras ett standardlösenord. | sträng |
| stat | Kontotillstånd. Anger om användaren är aktiv eller inte. Blockerade användare kan inte logga in på utvecklarportalen eller anropa API:er för prenumerationsprodukter. Standardtillståndet är Aktivt. | "aktiv" "blockerad" "borttagen" "väntar" |
UserIdentityContract
| Namn | Beskrivning | Värde |
|---|---|---|
| Id | Identifierarvärde inom providern. | sträng |
| familjeförsörjare | Identitetsproviderns namn. | sträng |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
| Mall | Beskrivning |
|---|---|
Skapa en API Management-instans och alla underresurser med hjälp av mallen
|
Den här mallen visar hur du skapar en API Management-tjänst och konfigurerar underentiteter |
Resursdefinition för ARM-mall
Resurstypen tjänst/användare kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/users-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.ApiManagement/service/users",
"apiVersion": "2021-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"
}
}
Egenskapsvärden
tjänst/användare
| Namn | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.ApiManagement/service/users" |
| apiVersion | Resurs-API-versionen | '2021-08-01' |
| Namn | Resursnamnet Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar. |
sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. |
| Egenskaper | Skapa kontraktegenskaper för användarentitet. | UserCreateParameterPropertiesOrUserContractPropertie... |
UserCreateParameterPropertiesOrUserContractPropertie...
| Namn | Beskrivning | Värde |
|---|---|---|
| appType | Avgör vilken typ av program som skickar begäran om att skapa användare. Standard är den äldre portalen. | "developerPortal" "portal" |
| konfirmation | Avgör vilken typ av e-postbekräftelse som ska skickas till den nyskapade användaren. | "bjud in" "registrering" |
| E-post | E-postadress. Får inte vara tom och måste vara unik i tjänstinstansen. | sträng (krävs) Begränsningar: Min längd = 1 Maximal längd = 254 |
| firstName | Förnamn. | sträng (krävs) Begränsningar: Min längd = 1 Maxlängd = 100 |
| Identiteter | Samling med användaridentiteter. | UserIdentityContract[] |
| lastName | Efternamn. | sträng (krävs) Begränsningar: Min längd = 1 Maxlängd = 100 |
| not | Valfritt meddelande om en användare som angetts av administratören. | sträng |
| lösenord | Användarlösenord. Om inget värde anges genereras ett standardlösenord. | sträng |
| stat | Kontotillstånd. Anger om användaren är aktiv eller inte. Blockerade användare kan inte logga in på utvecklarportalen eller anropa API:er för prenumerationsprodukter. Standardtillståndet är Aktivt. | "aktiv" "blockerad" "borttagen" "väntar" |
UserIdentityContract
| Namn | Beskrivning | Värde |
|---|---|---|
| Id | Identifierarvärde inom providern. | sträng |
| familjeförsörjare | Identitetsproviderns namn. | sträng |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
| Mall | Beskrivning |
|---|---|
|
Skapa en API Management-instans och alla underresurser med hjälp av mallen
|
Den här mallen visar hur du skapar en API Management-tjänst och konfigurerar underentiteter |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen tjänst/användare kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/users-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/users@2021-08-01"
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"
}
})
}
Egenskapsvärden
tjänst/användare
| Namn | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.ApiManagement/service/users@2021-08-01" |
| Namn | Resursnamnet | sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. |
| parent_id | ID för resursen som är överordnad för den här resursen. | ID för resurs av typen: tjänst |
| Egenskaper | Skapa kontraktegenskaper för användarentitet. | UserCreateParameterPropertiesOrUserContractPropertie... |
UserCreateParameterPropertiesOrUserContractPropertie...
| Namn | Beskrivning | Värde |
|---|---|---|
| appType | Avgör vilken typ av program som skickar begäran om att skapa användare. Standard är den äldre portalen. | "developerPortal" "portal" |
| konfirmation | Avgör vilken typ av e-postbekräftelse som ska skickas till den nyskapade användaren. | "bjud in" "registrering" |
| E-post | E-postadress. Får inte vara tom och måste vara unik i tjänstinstansen. | sträng (krävs) Begränsningar: Min längd = 1 Maximal längd = 254 |
| firstName | Förnamn. | sträng (krävs) Begränsningar: Min längd = 1 Maxlängd = 100 |
| Identiteter | Samling med användaridentiteter. | UserIdentityContract[] |
| lastName | Efternamn. | sträng (krävs) Begränsningar: Min längd = 1 Maxlängd = 100 |
| not | Valfritt meddelande om en användare som angetts av administratören. | sträng |
| lösenord | Användarlösenord. Om inget värde anges genereras ett standardlösenord. | sträng |
| stat | Kontotillstånd. Anger om användaren är aktiv eller inte. Blockerade användare kan inte logga in på utvecklarportalen eller anropa API:er för prenumerationsprodukter. Standardtillståndet är Aktivt. | "aktiv" "blockerad" "borttagen" "väntar" |
UserIdentityContract
| Namn | Beskrivning | Värde |
|---|---|---|
| Id | Identifierarvärde inom providern. | sträng |
| familjeförsörjare | Identitetsproviderns namn. | sträng |