Condividi tramite

Servizio Microsoft.ApiManagement/users 2021-08-01

  • Articolo

Definizione di risorsa Bicep

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

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

Formato di risorsa

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

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'
  }
}

Valori delle proprietà

servizio/utenti

Nome Descrizione valore
name 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.
padre 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 esterna alla risorsa padre.		 Nome simbolico per la risorsa di tipo: servizio
properties L'entità utente crea proprietà del contratto. UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

Nome Descrizione Valore
appType Determina il tipo di applicazione che invia la richiesta di creazione 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'
email Indirizzo di posta elettronica. Non deve essere vuoto e deve essere univoco all'interno dell'istanza del servizio. stringa (obbligatorio)
firstName Nome. stringa (obbligatorio)
identità Raccolta di identità utente. UserIdentityContract[]
lastName Cognome. stringa (obbligatorio)
nota Nota facoltativa su un utente impostata dall'amministratore. string
password Password utente. Se non viene specificato alcun valore, viene generata una password predefinita. string
state Stato dell'account. Specifica se l'utente è attivo o meno. Gli utenti bloccati non possono eseguire l'accesso al portale per sviluppatori o chiamare le API di prodotti sottoscritti. Lo stato predefinito è Attivo. 'active'
'bloccato'
'deleted'
'in sospeso'

UserIdentityContract

Nome Descrizione Valore
id Valore dell'identificatore all'interno del provider. string
provider Nome del provider di identità. string

Modelli di avvio rapido

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

Modello Descrizione
Creare un'istanza di Gestione API e tutte le relative risorse secondarie tramite un modello

Distribuisci in Azure		 Questo modello illustra come creare un servizio di 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:

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

Formato di risorsa

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

{
  "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"
  }
}

Valori delle proprietà

servizio/utenti

Nome Descrizione Valore
tipo Tipo di risorsa 'Microsoft.ApiManagement/service/users'
apiVersion Versione dell'API della risorsa '2021-08-01'
name Nome della risorsa

Informazioni su come impostare nomi e tipi per le risorse figlio nei 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.
properties L'entità utente crea proprietà del contratto. UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

Nome Descrizione Valore
appType Determina il tipo di applicazione che invia la richiesta di creazione 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'
email Indirizzo di posta elettronica. Non deve essere vuoto e deve essere univoco all'interno dell'istanza del servizio. stringa (obbligatorio)
firstName Nome. stringa (obbligatorio)
identità Raccolta di identità utente. UserIdentityContract[]
lastName Cognome. stringa (obbligatorio)
nota Nota facoltativa su un utente impostata dall'amministratore. string
password Password utente. Se non viene specificato alcun valore, viene generata una password predefinita. string
state Stato dell'account. Specifica se l'utente è attivo o meno. Gli utenti bloccati non possono eseguire l'accesso al portale per sviluppatori o chiamare le API di prodotti sottoscritti. Lo stato predefinito è Attivo. 'active'
'bloccato'
'deleted'
'in sospeso'

UserIdentityContract

Nome Descrizione Valore
id Valore dell'identificatore all'interno del provider. string
provider Nome del provider di identità. string

Modelli di avvio rapido

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

Modello Descrizione
Creare un'istanza di Gestione API e tutte le relative risorse secondarie tramite un modello

Distribuisci in Azure		 Questo modello illustra come creare un servizio di Gestione API e configurare le sottoentità

Definizione della 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 di 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@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"
    }
  })
}

Valori delle proprietà

servizio/utenti

Nome Descrizione Valore
tipo Tipo di risorsa "Microsoft.ApiManagement/service/users@2021-08-01"
name Nome della risorsa stringa (obbligatoria)

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
properties 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 posta elettronica di conferma che verrà inviato all'utente appena creato. "invito"
"iscrizione"
email Indirizzo di posta elettronica. Non deve essere vuoto e deve essere univoco all'interno dell'istanza del servizio. stringa (obbligatoria)
firstName Nome. stringa (obbligatoria)
identità Raccolta di identità utente. UserIdentityContract[]
lastName Cognome. stringa (obbligatoria)
nota Nota facoltativa su un utente impostata dall'amministratore. string
password Password utente. Se non viene specificato alcun valore, viene generata una password predefinita. string
state Stato dell'account. Specifica se l'utente è attivo o meno. Gli utenti bloccati non possono eseguire l'accesso al portale per sviluppatori o chiamare le API di prodotti sottoscritti. Lo stato predefinito è Attivo. "attivo"
"bloccato"
"eliminato"
"in sospeso"

UserIdentityContract

Nome Descrizione Valore
id Valore identificatore all'interno del provider. string
provider Nome del provider di identità. string