Freigeben über

Microsoft.ApiManagement service/users 2021-12-01-preview

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp Dienst/Benutzer kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/users-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.

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

Eigenschaftswerte

service/users

Name BESCHREIBUNG Wert
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep festlegen.		 Zeichenfolge (erforderlich)

Zeichenlimit: 1-80

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.

Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden.
parent In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.		 Symbolischer Name für Ressource vom Typ: Dienst
properties Benutzerentität erstellt Vertragseigenschaften. UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

Name BESCHREIBUNG Wert
appType Bestimmt den Typ der Anwendung, die die Create-Benutzeranforderung sendet. Der Standardwert ist das Legacyportal. "developerPortal"
"Portal"
Bestätigung Bestimmt den Typ der Bestätigungs-E-Mail, die an den neu erstellten Benutzer gesendet wird. "einladen"
"Anmeldung"
email E-Mail-Adresse. Darf nicht leer sein und muss innerhalb der Dienstinstanz eindeutig sein. Zeichenfolge (erforderlich)
firstName Vorname. Zeichenfolge (erforderlich)
Identitäten Sammlung von Benutzeridentitäten. UserIdentityContract[]
lastName Nachname. Zeichenfolge (erforderlich)
Hinweis Optionale, vom Administrator eingegebene Notiz über einen Benutzer. Zeichenfolge
password Benutzerkennwort. Wenn kein Wert angegeben wird, wird ein Standardkennwort generiert. Zeichenfolge
state Kontostatus. Gibt an, ob der Benutzer aktiv ist. Gesperrte Benutzer können sich nicht im Entwicklerportal anmelden und keine APIs von abonnierten Produkten aufrufen. Der Standardzustand ist Aktiv. "aktiv"
"blockiert"
"gelöscht"
"Ausstehend"

UserIdentityContract

Name BESCHREIBUNG Wert
id Bezeichnerwert innerhalb des Anbieters. Zeichenfolge
Provider Name des Identitätsanbieters. Zeichenfolge

Schnellstartvorlagen

Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen einer API Management-Instanz und aller Unterressourcen mithilfe einer Vorlage

Bereitstellen in Azure		 Diese Vorlage veranschaulicht, wie Sie einen API Management Dienst erstellen und Unterentitäten konfigurieren.

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp Dienst/Benutzer kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/users-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

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

Eigenschaftswerte

service/users

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.ApiManagement/service/users"
apiVersion Die Ressourcen-API-Version "2021-12-01-preview"
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen.		 Zeichenfolge (erforderlich)

Zeichenlimit: 1-80

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.

Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden.
properties Benutzerentität erstellt Vertragseigenschaften. UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

Name BESCHREIBUNG Wert
appType Bestimmt den Typ der Anwendung, die die Create-Benutzeranforderung sendet. Der Standardwert ist das Legacyportal. "developerPortal"
"Portal"
Bestätigung Bestimmt den Typ der Bestätigungs-E-Mail, die an den neu erstellten Benutzer gesendet wird. "einladen"
"Anmeldung"
email E-Mail-Adresse. Darf nicht leer sein und muss innerhalb der Dienstinstanz eindeutig sein. Zeichenfolge (erforderlich)
firstName Vorname. Zeichenfolge (erforderlich)
Identitäten Sammlung von Benutzeridentitäten. UserIdentityContract[]
lastName Nachname. Zeichenfolge (erforderlich)
Hinweis Optionale, vom Administrator eingegebene Notiz über einen Benutzer. Zeichenfolge
password Benutzerkennwort. Wenn kein Wert angegeben wird, wird ein Standardkennwort generiert. Zeichenfolge
state Kontostatus. Gibt an, ob der Benutzer aktiv ist. Gesperrte Benutzer können sich nicht im Entwicklerportal anmelden und keine APIs von abonnierten Produkten aufrufen. Der Standardzustand ist Aktiv. "aktiv"
"blockiert"
"gelöscht"
"Ausstehend"

UserIdentityContract

Name BESCHREIBUNG Wert
id Bezeichnerwert innerhalb des Anbieters. Zeichenfolge
Provider Name des Identitätsanbieters. Zeichenfolge

Schnellstartvorlagen

Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen einer API Management-Instanz und aller Unterressourcen mithilfe einer Vorlage

Bereitstellen in Azure		 Diese Vorlage veranschaulicht, wie Sie einen API Management Dienst erstellen und Unterentitäten konfigurieren.

Terraform (AzAPI-Anbieter) Ressourcendefinition

Der Ressourcentyp Dienst/Benutzer kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/users-Ressource zu erstellen, fügen Sie Der Vorlage die folgende Terraform-Ressource hinzu.

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

Eigenschaftswerte

service/users

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.ApiManagement/service/users@2021-12-01-preview"
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 1-80

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.

Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden.
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource vom Typ: Dienst
properties Benutzerentität erstellt Vertragseigenschaften. UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

Name BESCHREIBUNG Wert
appType Bestimmt den Typ der Anwendung, die die Create-Benutzeranforderung sendet. Der Standardwert ist das Legacyportal. "developerPortal"
"Portal"
Bestätigung Bestimmt den Typ der Bestätigungs-E-Mail, die an den neu erstellten Benutzer gesendet wird. "Einladen"
"Registrierung"
email E-Mail-Adresse. Darf nicht leer sein und muss innerhalb der Dienstinstanz eindeutig sein. Zeichenfolge (erforderlich)
firstName Vorname. Zeichenfolge (erforderlich)
Identitäten Sammlung von Benutzeridentitäten. UserIdentityContract[]
lastName Nachname. Zeichenfolge (erforderlich)
Hinweis Optionale, vom Administrator eingegebene Notiz über einen Benutzer. Zeichenfolge
password Benutzerkennwort. Wenn kein Wert angegeben wird, wird ein Standardkennwort generiert. Zeichenfolge
state Kontostatus. Gibt an, ob der Benutzer aktiv ist. Gesperrte Benutzer können sich nicht im Entwicklerportal anmelden und keine APIs von abonnierten Produkten aufrufen. Der Standardzustand ist Aktiv. "aktiv"
"blockiert"
"gelöscht"
"Ausstehend"

UserIdentityContract

Name BESCHREIBUNG Wert
id Bezeichnerwert innerhalb des Anbieters. Zeichenfolge
Provider Name des Identitätsanbieters. Zeichenfolge