Microsoft.ApiManagement service/users 2021-08-01

Definicja zasobu Bicep

Typ zasobu usługi/użytkowników można wdrożyć przy użyciu operacji docelowych:

• grupy zasobów — zobacz polecenia wdrażania grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/users, dodaj następujący kod Bicep do szablonu.

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

Wartości właściwości

Microsoft.ApiManagement/service/users

Nazwa	Opis	Wartość
nazwa	Nazwa zasobu	struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 80 (wymagane)
rodzic	W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym. Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.	Nazwa symboliczna zasobu typu: usługi
Właściwości	Jednostka użytkownika tworzy właściwości kontraktu.	UserCreateParameterPropertiesOrUserContractProperties

UserCreateParameterPropertiesOrUserContractProperties

Nazwa	Opis	Wartość
appType	Określa typ aplikacji, która wysyła żądanie tworzenia użytkownika. Wartość domyślna to starszy portal.	"developerPortal" "portal"
potwierdzenie	Określa typ wiadomości e-mail z potwierdzeniem, która zostanie wysłana do nowo utworzonego użytkownika.	"Zaproś" "Rejestracja"
E-mail	Adres e-mail. Nie może być pusta i musi być unikatowa w ramach wystąpienia usługi.	struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 254 (wymagana)
firstName	Imię.	struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 100 (wymagana)
Tożsamości	Kolekcja tożsamości użytkowników.	UserIdentityContract[]
lastName	Nazwisko.	struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 100 (wymagana)
nuta	Opcjonalna uwaga dotycząca użytkownika ustawionego przez administratora.	struna
hasło	Hasło użytkownika. Jeśli nie zostanie podana żadna wartość, zostanie wygenerowane domyślne hasło.	struna
stan	Stan konta. Określa, czy użytkownik jest aktywny, czy nie. Zablokowani użytkownicy nie mogą zalogować się do portalu deweloperów ani wywoływać żadnych interfejsów API subskrybowanych produktów. Stan domyślny to Aktywny.	"aktywny" "zablokowane" "usunięte" "Oczekujące"

UserIdentityContract

Nazwa	Opis	Wartość
id	Wartość identyfikatora w ramach dostawcy.	struna
dostawca	Nazwa dostawcy tożsamości.	struna

Definicja zasobu szablonu usługi ARM

Typ zasobu usługi/użytkowników można wdrożyć przy użyciu operacji docelowych:

• grupy zasobów — zobacz polecenia wdrażania grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/users, dodaj następujący kod JSON do szablonu.

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

Wartości właściwości

Microsoft.ApiManagement/service/users

Nazwa	Opis	Wartość
apiVersion	Wersja interfejsu API	'2021-08-01'
nazwa	Nazwa zasobu	struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 80 (wymagane)
Właściwości	Jednostka użytkownika tworzy właściwości kontraktu.	UserCreateParameterPropertiesOrUserContractProperties
typ	Typ zasobu	"Microsoft.ApiManagement/service/users"

UserCreateParameterPropertiesOrUserContractProperties

Nazwa	Opis	Wartość
appType	Określa typ aplikacji, która wysyła żądanie tworzenia użytkownika. Wartość domyślna to starszy portal.	"developerPortal" "portal"
potwierdzenie	Określa typ wiadomości e-mail z potwierdzeniem, która zostanie wysłana do nowo utworzonego użytkownika.	"Zaproś" "Rejestracja"
E-mail	Adres e-mail. Nie może być pusta i musi być unikatowa w ramach wystąpienia usługi.	struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 254 (wymagana)
firstName	Imię.	struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 100 (wymagana)
Tożsamości	Kolekcja tożsamości użytkowników.	UserIdentityContract[]
lastName	Nazwisko.	struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 100 (wymagana)
nuta	Opcjonalna uwaga dotycząca użytkownika ustawionego przez administratora.	struna
hasło	Hasło użytkownika. Jeśli nie zostanie podana żadna wartość, zostanie wygenerowane domyślne hasło.	struna
stan	Stan konta. Określa, czy użytkownik jest aktywny, czy nie. Zablokowani użytkownicy nie mogą zalogować się do portalu deweloperów ani wywoływać żadnych interfejsów API subskrybowanych produktów. Stan domyślny to Aktywny.	"aktywny" "zablokowane" "usunięte" "Oczekujące"

UserIdentityContract

Nazwa	Opis	Wartość
id	Wartość identyfikatora w ramach dostawcy.	struna
dostawca	Nazwa dostawcy tożsamości.	struna

Przykłady użycia

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu usługi/użytkowników można wdrożyć przy użyciu operacji docelowych:

• grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/users, dodaj następujący program Terraform do szablonu.

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

Wartości właściwości

Microsoft.ApiManagement/service/users

Nazwa	Opis	Wartość
nazwa	Nazwa zasobu	struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 80 (wymagane)
parent_id	Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu.	Identyfikator zasobu typu: usługi
Właściwości	Jednostka użytkownika tworzy właściwości kontraktu.	UserCreateParameterPropertiesOrUserContractProperties
typ	Typ zasobu	"Microsoft.ApiManagement/service/users@2021-08-01"

UserCreateParameterPropertiesOrUserContractProperties

Nazwa	Opis	Wartość
appType	Określa typ aplikacji, która wysyła żądanie tworzenia użytkownika. Wartość domyślna to starszy portal.	"developerPortal" "portal"
potwierdzenie	Określa typ wiadomości e-mail z potwierdzeniem, która zostanie wysłana do nowo utworzonego użytkownika.	"Zaproś" "Rejestracja"
E-mail	Adres e-mail. Nie może być pusta i musi być unikatowa w ramach wystąpienia usługi.	struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 254 (wymagana)
firstName	Imię.	struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 100 (wymagana)
Tożsamości	Kolekcja tożsamości użytkowników.	UserIdentityContract[]
lastName	Nazwisko.	struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 100 (wymagana)
nuta	Opcjonalna uwaga dotycząca użytkownika ustawionego przez administratora.	struna
hasło	Hasło użytkownika. Jeśli nie zostanie podana żadna wartość, zostanie wygenerowane domyślne hasło.	struna
stan	Stan konta. Określa, czy użytkownik jest aktywny, czy nie. Zablokowani użytkownicy nie mogą zalogować się do portalu deweloperów ani wywoływać żadnych interfejsów API subskrybowanych produktów. Stan domyślny to Aktywny.	"aktywny" "zablokowane" "usunięte" "Oczekujące"

UserIdentityContract

Nazwa	Opis	Wartość
id	Wartość identyfikatora w ramach dostawcy.	struna
dostawca	Nazwa dostawcy tożsamości.	struna