Dela via

Microsoft.ApiManagement service/users 2022-04-01-preview

  • Artikel

Bicep-resursdefinition

Resurstypen tjänst/användare kan distribueras med åtgärder som mål:

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@2022-04-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'
  }
}

Egenskapsvärden

tjänst/användare

Name Beskrivning Värde
name 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.
parent 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 överordnad resurs.		 Symboliskt namn för resurs av typen: tjänst
properties Skapa kontraktegenskaper för användarentitet. UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

Name Beskrivning Värde
appType Avgör vilken typ av program som skickar begäran om att skapa användare. Standard är äldre portal. "developerPortal"
"portal"
Bekräftelse Avgör vilken typ av e-postbekräftelse som ska skickas till den nyligen skapade 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)
firstName Förnamn. sträng (krävs)
Identiteter Samling med användaridentiteter. UserIdentityContract[]
lastName Efternamn. sträng (krävs)
anteckning Valfritt meddelande om en användare som angetts av administratören. sträng
password Användarlösenord. Om inget värde anges genereras ett standardlösenord. sträng
state 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

Name Beskrivning Värde
id Identifierarvärde inom providern. sträng
Leverantör Identitetsproviderns namn. sträng

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Description
Skapa en API Management-instans och alla underresurser med hjälp av mallen

Distribuera till Azure		 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 är mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Resurs för Microsoft.ApiManagement/service/users lägger du till följande JSON i mallen.

{
  "type": "Microsoft.ApiManagement/service/users",
  "apiVersion": "2022-04-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"
  }
}

Egenskapsvärden

tjänst/användare

Name Beskrivning Värde
typ Resurstypen "Microsoft.ApiManagement/service/users"
apiVersion Resurs-API-versionen "2022-04-01-preview"
name 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.
properties Användarentiteten skapar kontraktegenskaper. UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

Name Beskrivning Värde
appType Avgör vilken typ av program som skickar begäran om att skapa användare. Standardvärdet är en äldre portal. "developerPortal"
"portal"
Bekräftelse Avgör vilken typ av bekräftelsemeddelande som ska skickas till den nyligen skapade 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)
firstName Förnamn. sträng (krävs)
Identiteter Samling användaridentiteter. UserIdentityContract[]
lastName Efternamn. sträng (krävs)
anteckning Valfri anteckning om en användare som angetts av administratören. sträng
password Användarlösenord. Om inget värde anges genereras ett standardlösenord. sträng
state 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"
"borttaget"
"väntar"

UserIdentityContract

Name Beskrivning Värde
id Identifierarvärde inom providern. sträng
Leverantör Identitetsproviderns namn. sträng

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Description
Skapa en API Management-instans och alla underresurser med hjälp av mallen

Distribuera till Azure		 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 är mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Resurs för Microsoft.ApiManagement/service/users lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/users@2022-04-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"
    }
  })
}

Egenskapsvärden

tjänst/användare

Name Beskrivning Värde
typ Resurstypen "Microsoft.ApiManagement/service/users@2022-04-01-preview"
name 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
properties Användarentiteten skapar kontraktegenskaper. UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

Name Beskrivning Värde
appType Avgör vilken typ av program som skickar begäran om att skapa användare. Standardvärdet är en äldre portal. "developerPortal"
"portal"
Bekräftelse Avgör vilken typ av bekräftelsemeddelande som ska skickas till den nyligen skapade användaren. "bjud in"
"signup"
e-post E-postadress. Får inte vara tom och måste vara unik i tjänstinstansen. sträng (krävs)
firstName Förnamn. sträng (krävs)
Identiteter Samling användaridentiteter. UserIdentityContract[]
lastName Efternamn. sträng (krävs)
anteckning Valfri anteckning om en användare som angetts av administratören. sträng
password Användarlösenord. Om inget värde anges genereras ett standardlösenord. sträng
state 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"
"borttaget"
"väntar"

UserIdentityContract

Name Beskrivning Värde
id Identifierarvärde inom providern. sträng
Leverantör Identitetsproviderns namn. sträng