Sdílet prostřednictvím

Služba Microsoft.ApiManagement / uživatelé 2024-05-01

  • Článek

Definice prostředku Bicep

Typ prostředku služby nebo uživatelů je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/users, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.ApiManagement/service/users@2024-05-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'
  }
}

Hodnoty vlastností

Microsoft.ApiManagement/service/users

Jméno Popis Hodnota
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
rodič V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.		 Symbolický název prostředku typu: služby
vlastnosti Entita uživatele vytvoří vlastnosti kontraktu. UserCreateParameterPropertiesOrUserContractPropertProperties

UserCreateParameterPropertiesOrUserContractProperties

Jméno Popis Hodnota
appType Určuje typ aplikace, která odešle žádost o vytvoření uživatele. Výchozí hodnota je starší verze portálu. DeveloperPortal
Portál
potvrzení Určuje typ potvrzovací e-mailu, který se odešle nově vytvořenému uživateli. Pozvat
Registrace
E-mail E-mailová adresa Nesmí být prázdný a musí být jedinečný v rámci instance služby. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
firstName Křestní jméno. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
identity Kolekce identit uživatelů UserIdentityContract[]
lastName Příjmení. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
poznámka Nepovinná poznámka o uživateli nastaveném správcem. řetězec
heslo Heslo uživatele. Pokud není zadaná žádná hodnota, vygeneruje se výchozí heslo. řetězec
stát Stav účtu Určuje, jestli je uživatel aktivní nebo ne. Blokovaní uživatelé se nemůžou přihlásit k portálu pro vývojáře nebo volat žádná rozhraní API předplacených produktů. Výchozí stav je Aktivní. Aktivní
"blokováno"
"odstraněno"
Čeká se na vyřízení

UserIdentityContract

Jméno Popis Hodnota
id Hodnota identifikátoru v rámci zprostředkovatele. řetězec
poskytovatel Název zprostředkovatele identity. řetězec

Definice prostředku šablony ARM

Typ prostředku služby nebo uživatelů je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/users, přidejte do šablony následující JSON.

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

Hodnoty vlastností

Microsoft.ApiManagement/service/users

Jméno Popis Hodnota
apiVersion Verze rozhraní API '2024-05-01'
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
vlastnosti Entita uživatele vytvoří vlastnosti kontraktu. UserCreateParameterPropertiesOrUserContractPropertProperties
typ Typ prostředku Microsoft.ApiManagement/service/users

UserCreateParameterPropertiesOrUserContractProperties

Jméno Popis Hodnota
appType Určuje typ aplikace, která odešle žádost o vytvoření uživatele. Výchozí hodnota je starší verze portálu. DeveloperPortal
Portál
potvrzení Určuje typ potvrzovací e-mailu, který se odešle nově vytvořenému uživateli. Pozvat
Registrace
E-mail E-mailová adresa Nesmí být prázdný a musí být jedinečný v rámci instance služby. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
firstName Křestní jméno. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
identity Kolekce identit uživatelů UserIdentityContract[]
lastName Příjmení. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
poznámka Nepovinná poznámka o uživateli nastaveném správcem. řetězec
heslo Heslo uživatele. Pokud není zadaná žádná hodnota, vygeneruje se výchozí heslo. řetězec
stát Stav účtu Určuje, jestli je uživatel aktivní nebo ne. Blokovaní uživatelé se nemůžou přihlásit k portálu pro vývojáře nebo volat žádná rozhraní API předplacených produktů. Výchozí stav je Aktivní. Aktivní
"blokováno"
"odstraněno"
Čeká se na vyřízení

UserIdentityContract

Jméno Popis Hodnota
id Hodnota identifikátoru v rámci zprostředkovatele. řetězec
poskytovatel Název zprostředkovatele identity. řetězec

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku služby nebo uživatelů je možné nasadit s operacemi, které cílí:

  • skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/users, přidejte do šablony následující Terraform.

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

Hodnoty vlastností

Microsoft.ApiManagement/service/users

Jméno Popis Hodnota
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: služby
vlastnosti Entita uživatele vytvoří vlastnosti kontraktu. UserCreateParameterPropertiesOrUserContractPropertProperties
typ Typ prostředku Microsoft.ApiManagement/service/users@2024-05-01

UserCreateParameterPropertiesOrUserContractProperties

Jméno Popis Hodnota
appType Určuje typ aplikace, která odešle žádost o vytvoření uživatele. Výchozí hodnota je starší verze portálu. DeveloperPortal
Portál
potvrzení Určuje typ potvrzovací e-mailu, který se odešle nově vytvořenému uživateli. Pozvat
Registrace
E-mail E-mailová adresa Nesmí být prázdný a musí být jedinečný v rámci instance služby. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
firstName Křestní jméno. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
identity Kolekce identit uživatelů UserIdentityContract[]
lastName Příjmení. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
poznámka Nepovinná poznámka o uživateli nastaveném správcem. řetězec
heslo Heslo uživatele. Pokud není zadaná žádná hodnota, vygeneruje se výchozí heslo. řetězec
stát Stav účtu Určuje, jestli je uživatel aktivní nebo ne. Blokovaní uživatelé se nemůžou přihlásit k portálu pro vývojáře nebo volat žádná rozhraní API předplacených produktů. Výchozí stav je Aktivní. Aktivní
"blokováno"
"odstraněno"
Čeká se na vyřízení

UserIdentityContract

Jméno Popis Hodnota
id Hodnota identifikátoru v rámci zprostředkovatele. řetězec
poskytovatel Název zprostředkovatele identity. řetězec