Dela via

Microsoft.ApiManagement-tjänsten/användare 2020-12-01

  • 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@2020-12-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'
  }
}

Egenskapsvärden

Microsoft.ApiManagement/service/users

Namn Beskrivning Värde
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
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. UserCreateParameterPropertiesOrUserContractProperties

UserCreateParameterPropertiesOrUserContractProperties

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

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
firstName Förnamn. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
Identiteter Samling med användaridentiteter. UserIdentityContract[]
lastName Efternamn. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
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

Resursdefinition för ARM-mall

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 JSON i mallen.

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

Microsoft.ApiManagement/service/users

Namn Beskrivning Värde
apiVersion API-versionen '2020-12-01'
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
Egenskaper Skapa kontraktegenskaper för användarentitet. UserCreateParameterPropertiesOrUserContractProperties
typ Resurstypen "Microsoft.ApiManagement/service/users"

UserCreateParameterPropertiesOrUserContractProperties

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

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
firstName Förnamn. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
Identiteter Samling med användaridentiteter. UserIdentityContract[]
lastName Efternamn. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
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

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@2020-12-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"
    }
  })
}

Egenskapsvärden

Microsoft.ApiManagement/service/users

Namn Beskrivning Värde
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
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. UserCreateParameterPropertiesOrUserContractProperties
typ Resurstypen "Microsoft.ApiManagement/service/users@2020-12-01"

UserCreateParameterPropertiesOrUserContractProperties

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

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
firstName Förnamn. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
Identiteter Samling med användaridentiteter. UserIdentityContract[]
lastName Efternamn. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
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