Freigeben über

Microsoft.ApiManagement-Dienst/Benutzer

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp "Dienst/Benutzer" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

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 Ihrer Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.ApiManagement/service/users@2024-06-01-preview' = {
  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'
  }
}

Eigenschaftswerte

Microsoft.ApiManagement/service/users

Name Beschreibung Wert
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
Elternteil 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 des Typs: Dienst-
Eigenschaften Benutzerentität erstellt Vertragseigenschaften. UserCreateParameterPropertiesOrUserContractProperties

UserCreateParameterPropertiesOrUserContractProperties

Name Beschreibung Wert
appType Bestimmt den Typ der Anwendung, die die Benutzeranforderung zum Erstellen 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. "einladung"
"Registrierung"
E-Mail E-Mail-Adresse. Darf nicht leer sein und muss innerhalb der Dienstinstanz eindeutig sein. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
firstName Vorname. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
Identitäten Sammlung von Benutzeridentitäten. UserIdentityContract[]
Nachname Nachname. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
Anmerkung Optionaler Hinweis zu einem vom Administrator festgelegten Benutzer. Schnur
Passwort Benutzerkennwort. Wenn kein Wert angegeben wird, wird ein Standardkennwort generiert. Schnur
Zustand Kontostatus. Gibt an, ob der Benutzer aktiv ist oder nicht. Blockierte Benutzer können sich nicht beim Entwicklerportal anmelden oder APIs von abonnierten Produkten aufrufen. Der Standardstatus ist "Aktiv". "aktiv"
"blockiert"
"gelöscht"
"Ausstehend"

UserIdentityContract

Name Beschreibung Wert
id Bezeichnerwert innerhalb des Anbieters. Schnur
Anbieter Identitätsanbietername. Schnur

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "Dienst/Benutzer" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

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": "2024-06-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

Microsoft.ApiManagement/service/users

Name Beschreibung Wert
apiVersion Die API-Version "2024-06-01-preview"
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
Eigenschaften Benutzerentität erstellt Vertragseigenschaften. UserCreateParameterPropertiesOrUserContractProperties
Art Der Ressourcentyp "Microsoft.ApiManagement/service/users"

UserCreateParameterPropertiesOrUserContractProperties

Name Beschreibung Wert
appType Bestimmt den Typ der Anwendung, die die Benutzeranforderung zum Erstellen 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. "einladung"
"Registrierung"
E-Mail E-Mail-Adresse. Darf nicht leer sein und muss innerhalb der Dienstinstanz eindeutig sein. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
firstName Vorname. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
Identitäten Sammlung von Benutzeridentitäten. UserIdentityContract[]
Nachname Nachname. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
Anmerkung Optionaler Hinweis zu einem vom Administrator festgelegten Benutzer. Schnur
Passwort Benutzerkennwort. Wenn kein Wert angegeben wird, wird ein Standardkennwort generiert. Schnur
Zustand Kontostatus. Gibt an, ob der Benutzer aktiv ist oder nicht. Blockierte Benutzer können sich nicht beim Entwicklerportal anmelden oder APIs von abonnierten Produkten aufrufen. Der Standardstatus ist "Aktiv". "aktiv"
"blockiert"
"gelöscht"
"Ausstehend"

UserIdentityContract

Name Beschreibung Wert
id Bezeichnerwert innerhalb des Anbieters. Schnur
Anbieter Identitätsanbietername. Schnur

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "Dienst/Benutzer" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • 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 Ihrer Vorlage die folgende Terraform hinzu.

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

Eigenschaftswerte

Microsoft.ApiManagement/service/users

Name Beschreibung Wert
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource des Typs: Dienst-
Eigenschaften Benutzerentität erstellt Vertragseigenschaften. UserCreateParameterPropertiesOrUserContractProperties
Art Der Ressourcentyp "Microsoft.ApiManagement/service/users@2024-06-01-preview"

UserCreateParameterPropertiesOrUserContractProperties

Name Beschreibung Wert
appType Bestimmt den Typ der Anwendung, die die Benutzeranforderung zum Erstellen 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. "einladung"
"Registrierung"
E-Mail E-Mail-Adresse. Darf nicht leer sein und muss innerhalb der Dienstinstanz eindeutig sein. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
firstName Vorname. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
Identitäten Sammlung von Benutzeridentitäten. UserIdentityContract[]
Nachname Nachname. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
Anmerkung Optionaler Hinweis zu einem vom Administrator festgelegten Benutzer. Schnur
Passwort Benutzerkennwort. Wenn kein Wert angegeben wird, wird ein Standardkennwort generiert. Schnur
Zustand Kontostatus. Gibt an, ob der Benutzer aktiv ist oder nicht. Blockierte Benutzer können sich nicht beim Entwicklerportal anmelden oder APIs von abonnierten Produkten aufrufen. Der Standardstatus ist "Aktiv". "aktiv"
"blockiert"
"gelöscht"
"Ausstehend"

UserIdentityContract

Name Beschreibung Wert
id Bezeichnerwert innerhalb des Anbieters. Schnur
Anbieter Identitätsanbietername. Schnur