Delen via


Microsoft.ApiManagement-service/gebruikers 2023-09-01-preview

Bicep-resourcedefinitie

Het resourcetype service/gebruikers kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource microsoft.ApiManagement/service/gebruikers wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

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

Eigenschapswaarden

Microsoft.ApiManagement/service/gebruikers

Naam Beschrijving Waarde
naam De resourcenaam string

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1 (vereist)
ouder In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd.

Zie onderliggende resource buiten de bovenliggende resourcevoor meer informatie.
Symbolische naam voor resource van het type: service
Eigenschappen Gebruikersentiteit maakt contracteigenschappen. UserCreateParameterPropertiesOrUserContractProperties

UserCreateParameterPropertiesOrUserContractProperties

Naam Beschrijving Waarde
appType Bepaalt het type toepassing dat de aanvraag voor het maken van de gebruiker verzendt. De standaardinstelling is een verouderde portal. 'developerPortal'
'portal'
bevestiging Bepaalt het type bevestigingsmail dat naar de zojuist gemaakte gebruiker wordt verzonden. 'uitnodigen'
'registratie'
E-mail E-mailadres. Mag niet leeg zijn en moet uniek zijn binnen het service-exemplaar. string

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1 (vereist)
firstName Voornaam. string

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1 (vereist)
Identiteiten Verzameling gebruikersidentiteiten. UserIdentityContract[]
lastName Achternaam. string

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1 (vereist)
notitie Optionele opmerking over een gebruiker die is ingesteld door de beheerder. snaar
wachtwoord Gebruikerswachtwoord. Als er geen waarde wordt opgegeven, wordt er een standaardwachtwoord gegenereerd. snaar
staat Accountstatus. Hiermee geeft u op of de gebruiker actief is of niet. Geblokkeerde gebruikers kunnen zich niet aanmelden bij de ontwikkelaarsportal of eventuele API's van geabonneerde producten aanroepen. De standaardstatus is Actief. 'actief'
'geblokkeerd'
'verwijderd'
'in behandeling'

UserIdentityContract

Naam Beschrijving Waarde
legitimatiebewijs Id-waarde binnen provider. snaar
aanbieder Naam van id-provider. snaar

Resourcedefinitie van ARM-sjabloon

Het resourcetype service/gebruikers kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.ApiManagement/service/gebruikersresource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

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

Eigenschapswaarden

Microsoft.ApiManagement/service/gebruikers

Naam Beschrijving Waarde
apiVersion De API-versie '2023-09-01-preview'
naam De resourcenaam string

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1 (vereist)
Eigenschappen Gebruikersentiteit maakt contracteigenschappen. UserCreateParameterPropertiesOrUserContractProperties
type Het resourcetype 'Microsoft.ApiManagement/service/users'

UserCreateParameterPropertiesOrUserContractProperties

Naam Beschrijving Waarde
appType Bepaalt het type toepassing dat de aanvraag voor het maken van de gebruiker verzendt. De standaardinstelling is een verouderde portal. 'developerPortal'
'portal'
bevestiging Bepaalt het type bevestigingsmail dat naar de zojuist gemaakte gebruiker wordt verzonden. 'uitnodigen'
'registratie'
E-mail E-mailadres. Mag niet leeg zijn en moet uniek zijn binnen het service-exemplaar. string

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1 (vereist)
firstName Voornaam. string

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1 (vereist)
Identiteiten Verzameling gebruikersidentiteiten. UserIdentityContract[]
lastName Achternaam. string

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1 (vereist)
notitie Optionele opmerking over een gebruiker die is ingesteld door de beheerder. snaar
wachtwoord Gebruikerswachtwoord. Als er geen waarde wordt opgegeven, wordt er een standaardwachtwoord gegenereerd. snaar
staat Accountstatus. Hiermee geeft u op of de gebruiker actief is of niet. Geblokkeerde gebruikers kunnen zich niet aanmelden bij de ontwikkelaarsportal of eventuele API's van geabonneerde producten aanroepen. De standaardstatus is Actief. 'actief'
'geblokkeerd'
'verwijderd'
'in behandeling'

UserIdentityContract

Naam Beschrijving Waarde
legitimatiebewijs Id-waarde binnen provider. snaar
aanbieder Naam van id-provider. snaar

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype service/gebruikers kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource microsoft.ApiManagement/service/gebruikers wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

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

Eigenschapswaarden

Microsoft.ApiManagement/service/gebruikers

Naam Beschrijving Waarde
naam De resourcenaam string

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1 (vereist)
parent_id De id van de resource die het bovenliggende item voor deze resource is. Id voor resource van het type: service-
Eigenschappen Gebruikersentiteit maakt contracteigenschappen. UserCreateParameterPropertiesOrUserContractProperties
type Het resourcetype "Microsoft.ApiManagement/service/users@2023-09-01-preview"

UserCreateParameterPropertiesOrUserContractProperties

Naam Beschrijving Waarde
appType Bepaalt het type toepassing dat de aanvraag voor het maken van de gebruiker verzendt. De standaardinstelling is een verouderde portal. 'developerPortal'
'portal'
bevestiging Bepaalt het type bevestigingsmail dat naar de zojuist gemaakte gebruiker wordt verzonden. 'uitnodigen'
'registratie'
E-mail E-mailadres. Mag niet leeg zijn en moet uniek zijn binnen het service-exemplaar. string

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1 (vereist)
firstName Voornaam. string

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1 (vereist)
Identiteiten Verzameling gebruikersidentiteiten. UserIdentityContract[]
lastName Achternaam. string

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1 (vereist)
notitie Optionele opmerking over een gebruiker die is ingesteld door de beheerder. snaar
wachtwoord Gebruikerswachtwoord. Als er geen waarde wordt opgegeven, wordt er een standaardwachtwoord gegenereerd. snaar
staat Accountstatus. Hiermee geeft u op of de gebruiker actief is of niet. Geblokkeerde gebruikers kunnen zich niet aanmelden bij de ontwikkelaarsportal of eventuele API's van geabonneerde producten aanroepen. De standaardstatus is Actief. 'actief'
'geblokkeerd'
'verwijderd'
'in behandeling'

UserIdentityContract

Naam Beschrijving Waarde
legitimatiebewijs Id-waarde binnen provider. snaar
aanbieder Naam van id-provider. snaar