Servizio Microsoft.ApiManagement/users 2022-08-01

Articolo
07/24/2024

Definizione di risorsa Bicep

Il tipo di risorsa service/users può essere distribuito con operazioni destinate a:

gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.ApiManagement/service/users, aggiungere il bicep seguente al modello.

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

Valori delle proprietà

servizio/utenti

Nome	Descrizione	Valore
nome	Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio in Bicep.	stringa (obbligatorio) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico.
genitore	In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre. Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.	Nome simbolico per la risorsa di tipo: servizio
proprietà	L'entità utente crea proprietà del contratto.	UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

Nome	Descrizione	Valore
appType	Determina il tipo di applicazione che invia la richiesta di creazione dell'utente. Il valore predefinito è il portale legacy.	'developerPortal' 'portal'
conferma	Determina il tipo di messaggio di posta elettronica di conferma che verrà inviato all'utente appena creato.	'invite' 'iscrizione'
E-mail	Indirizzo email. Non deve essere vuoto e deve essere univoco all'interno dell'istanza del servizio.	stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 254
firstName	Nome di battesimo.	stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 100
Identità	Raccolta di identità utente.	UserIdentityContract[]
lastName	Cognome.	stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 100
nota	Nota facoltativa su un utente impostato dall'amministratore.	corda
parola d’ordine	Password utente. Se non viene specificato alcun valore, viene generata una password predefinita.	corda
stato	Stato dell'account. Specifica se l'utente è attivo o meno. Gli utenti bloccati non possono accedere al portale per sviluppatori o chiamare le API dei prodotti sottoscritti. Lo stato predefinito è Attivo.	'active' 'bloccato' 'deleted' 'in sospeso'

UserIdentityContract

Nome	Descrizione	Valore
Id	Valore dell'identificatore all'interno del provider.	corda
provider	Nome del provider di identità.	corda

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Sagoma	Descrizione
Creare un'istanza di Gestione API e tutte le risorse secondarie usando modello	Questo modello illustra come creare un servizio Gestione API e configurare le sottoentità

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa service/users può essere distribuito con operazioni destinate a:

gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.ApiManagement/service/users, aggiungere il codice JSON seguente al modello.

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

Valori delle proprietà

servizio/utenti

Nome	Descrizione	Valore
digitare	Tipo di risorsa	'Microsoft.ApiManagement/service/users'
apiVersion	Versione dell'API della risorsa	'2022-08-01'
nome	Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio in modelli DI Resource Manager JSON.	stringa (obbligatorio) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico.
proprietà	L'entità utente crea proprietà del contratto.	UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

Nome	Descrizione	Valore
appType	Determina il tipo di applicazione che invia la richiesta di creazione dell'utente. Il valore predefinito è il portale legacy.	'developerPortal' 'portal'
conferma	Determina il tipo di messaggio di posta elettronica di conferma che verrà inviato all'utente appena creato.	'invite' 'iscrizione'
E-mail	Indirizzo email. Non deve essere vuoto e deve essere univoco all'interno dell'istanza del servizio.	stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 254
firstName	Nome di battesimo.	stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 100
Identità	Raccolta di identità utente.	UserIdentityContract[]
lastName	Cognome.	stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 100
nota	Nota facoltativa su un utente impostato dall'amministratore.	corda
parola d’ordine	Password utente. Se non viene specificato alcun valore, viene generata una password predefinita.	corda
stato	Stato dell'account. Specifica se l'utente è attivo o meno. Gli utenti bloccati non possono accedere al portale per sviluppatori o chiamare le API dei prodotti sottoscritti. Lo stato predefinito è Attivo.	'active' 'bloccato' 'deleted' 'in sospeso'

UserIdentityContract

Nome	Descrizione	Valore
Id	Valore dell'identificatore all'interno del provider.	corda
provider	Nome del provider di identità.	corda

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Sagoma	Descrizione
Creare un'istanza di Gestione API e tutte le risorse secondarie usando modello	Questo modello illustra come creare un servizio Gestione API e configurare le sottoentità

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa service/users può essere distribuito con operazioni destinate a:

gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.ApiManagement/service/users, aggiungere il codice Terraform seguente al modello.

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

Valori delle proprietà

servizio/utenti

Nome	Descrizione	Valore
digitare	Tipo di risorsa	"Microsoft.ApiManagement/service/users@2022-08-01"
nome	Nome della risorsa	stringa (obbligatorio) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico.
parent_id	ID della risorsa padre per questa risorsa.	ID per la risorsa di tipo: servizio
proprietà	L'entità utente crea proprietà del contratto.	UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

Nome	Descrizione	Valore
appType	Determina il tipo di applicazione che invia la richiesta di creazione dell'utente. Il valore predefinito è il portale legacy.	"developerPortal" "portale"
conferma	Determina il tipo di messaggio di posta elettronica di conferma che verrà inviato all'utente appena creato.	"invita" "iscrizione"
E-mail	Indirizzo email. Non deve essere vuoto e deve essere univoco all'interno dell'istanza del servizio.	stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 254
firstName	Nome di battesimo.	stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 100
Identità	Raccolta di identità utente.	UserIdentityContract[]
lastName	Cognome.	stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 100
nota	Nota facoltativa su un utente impostato dall'amministratore.	corda
parola d’ordine	Password utente. Se non viene specificato alcun valore, viene generata una password predefinita.	corda
stato	Stato dell'account. Specifica se l'utente è attivo o meno. Gli utenti bloccati non possono accedere al portale per sviluppatori o chiamare le API dei prodotti sottoscritti. Lo stato predefinito è Attivo.	"attivo" "bloccato" "eliminato" "in sospeso"

UserIdentityContract

Nome	Descrizione	Valore
Id	Valore dell'identificatore all'interno del provider.	corda
provider	Nome del provider di identità.	corda

Condividi tramite

Servizio Microsoft.ApiManagement/users 2022-08-01

Definizione di risorsa Bicep

Formato risorsa

Valori delle proprietà

servizio/utenti

UserCreateParameterPropertiesOrUserContractPropertie...

UserIdentityContract

Modelli di avvio rapido

Definizione di risorsa del modello di Resource Manager

Formato risorsa

Valori delle proprietà

servizio/utenti

UserCreateParameterPropertiesOrUserContractPropertie...

UserIdentityContract

Modelli di avvio rapido

Definizione di risorsa Terraform (provider AzAPI)

Formato risorsa

Valori delle proprietà

servizio/utenti

UserCreateParameterPropertiesOrUserContractPropertie...

UserIdentityContract

Commenti e suggerimenti

Risorse aggiuntive