Sdílet prostřednictvím


Služba Microsoft.ApiManagement / portalsettings 2018-01-01

Definice prostředku Bicep

Typ prostředku service/portalsettings je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/portalsettings, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.ApiManagement/service/portalsettings@2018-01-01' = {
  name: 'string'
  // For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}

microsoft.apimanagement/service/portalsettings – objekty

Nastavte vlastnost název, která určuje typ objektu.

Pro přihlášenípoužijte:

{
  name: 'signin'
  properties: {
    enabled: bool
  }
}

Pro registrace použijte:

{
  name: 'signup'
  properties: {
    enabled: bool
    termsOfService: {
      consentRequired: bool
      enabled: bool
      text: 'string'
    }
  }
}

Pro delegování použijte:

{
  name: 'delegation'
  properties: {
    subscriptions: {
      enabled: bool
    }
    url: 'string'
    userRegistration: {
      enabled: bool
    }
    validationKey: 'string'
  }
}

Hodnoty vlastností

microsoft.apimanagement/service/portalsettings

Jméno Popis Hodnota
Jméno Nastavte na signin pro typ Microsoft.ApiManagement/service/portalsettings. Pro typ Microsoft.ApiManagement/service/portalsettingsnastavte na signup . Nastavte na delegování pro typ Microsoft.ApiManagement/service/portalsettings. "delegování"
'signin'
Registrace (povinné)

Microsoft.ApiManagement/service/portalsettings

Jméno Popis Hodnota
Jméno Název prostředku 'signin' (povinné)
rodič V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.
Symbolický název prostředku typu: služby
vlastnosti Vlastnosti kontraktu nastavení přihlášení portalSigninSettingProperties

Microsoft.ApiManagement/service/portalsettings

Jméno Popis Hodnota
Jméno Název prostředku Registrace (povinné)
rodič V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.
Symbolický název prostředku typu: služby
vlastnosti Vlastnosti kontraktu nastavení registrace PortalSignupSettingsProperties

Microsoft.ApiManagement/service/portalsettings

Jméno Popis Hodnota
Jméno Název prostředku "delegování" (povinné)
rodič V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.
Symbolický název prostředku typu: služby
vlastnosti Vlastnosti kontraktu nastavení delegování PortalDelegationSettingsProperties

PortalDelegationSettingsProperties

Jméno Popis Hodnota
předplatná Nastavení delegování předplatných subscriptionsDelegationSettingsProperties
adresa URL Adresa URL delegování. řetězec
userRegistration Nastavení delegování registrace uživatele RegistrationDelegationSettingsProperties
validationKey Ověřovací klíč kódovaný s kódováním Base64, který ověří, že požadavek pochází ze služby Azure API Management. řetězec

PortalSigninSettingProperties

Jméno Popis Hodnota
zpřístupněný Přesměrujte anonymní uživatele na stránku Sign-In. Bool

PortalSignupSettingsProperties

Jméno Popis Hodnota
zpřístupněný Povolte uživatelům registraci na portálu pro vývojáře. Bool
termsOfService Podmínky vlastností smlouvy o poskytování služeb. TermsOfServiceProperties

RegistrationDelegationSettingsProperties

Jméno Popis Hodnota
zpřístupněný Povolte nebo zakažte delegování pro registraci uživatelů. Bool

SubscriptionsDelegationSettingsProperties

Jméno Popis Hodnota
zpřístupněný Povolte nebo zakažte delegování pro předplatná. Bool

TermsOfServiceProperties

Jméno Popis Hodnota
consentRequired Požádejte uživatele o souhlas s podmínkami služby. Bool
zpřístupněný Během procesu registrace můžete zobrazit podmínky služby. Bool
Text Text podmínek služby. řetězec

Definice prostředku šablony ARM

Typ prostředku service/portalsettings je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/portalsettings, přidejte do šablony následující JSON.

{
  "name": "string"
  // For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}

microsoft.apimanagement/service/portalsettings – objekty

Nastavte vlastnost název, která určuje typ objektu.

Pro přihlášenípoužijte:

{
  "name": "signin",
  "properties": {
    "enabled": "bool"
  }
}

Pro registrace použijte:

{
  "name": "signup",
  "properties": {
    "enabled": "bool",
    "termsOfService": {
      "consentRequired": "bool",
      "enabled": "bool",
      "text": "string"
    }
  }
}

Pro delegování použijte:

{
  "name": "delegation",
  "properties": {
    "subscriptions": {
      "enabled": "bool"
    },
    "url": "string",
    "userRegistration": {
      "enabled": "bool"
    },
    "validationKey": "string"
  }
}

Hodnoty vlastností

microsoft.apimanagement/service/portalsettings

Jméno Popis Hodnota
Jméno Nastavte na signin pro typ Microsoft.ApiManagement/service/portalsettings. Pro typ Microsoft.ApiManagement/service/portalsettingsnastavte na signup . Nastavte na delegování pro typ Microsoft.ApiManagement/service/portalsettings. "delegování"
'signin'
Registrace (povinné)

Microsoft.ApiManagement/service/portalsettings

Jméno Popis Hodnota
apiVersion Verze rozhraní API '2018-01-01'
Jméno Název prostředku 'signin' (povinné)
vlastnosti Vlastnosti kontraktu nastavení přihlášení portalSigninSettingProperties
typ Typ prostředku Microsoft.ApiManagement/service/portalsettings

Microsoft.ApiManagement/service/portalsettings

Jméno Popis Hodnota
apiVersion Verze rozhraní API '2018-01-01'
Jméno Název prostředku Registrace (povinné)
vlastnosti Vlastnosti kontraktu nastavení registrace PortalSignupSettingsProperties
typ Typ prostředku Microsoft.ApiManagement/service/portalsettings

Microsoft.ApiManagement/service/portalsettings

Jméno Popis Hodnota
apiVersion Verze rozhraní API '2018-01-01'
Jméno Název prostředku "delegování" (povinné)
vlastnosti Vlastnosti kontraktu nastavení delegování PortalDelegationSettingsProperties
typ Typ prostředku Microsoft.ApiManagement/service/portalsettings

PortalDelegationSettingsProperties

Jméno Popis Hodnota
předplatná Nastavení delegování předplatných subscriptionsDelegationSettingsProperties
adresa URL Adresa URL delegování. řetězec
userRegistration Nastavení delegování registrace uživatele RegistrationDelegationSettingsProperties
validationKey Ověřovací klíč kódovaný s kódováním Base64, který ověří, že požadavek pochází ze služby Azure API Management. řetězec

PortalSigninSettingProperties

Jméno Popis Hodnota
zpřístupněný Přesměrujte anonymní uživatele na stránku Sign-In. Bool

PortalSignupSettingsProperties

Jméno Popis Hodnota
zpřístupněný Povolte uživatelům registraci na portálu pro vývojáře. Bool
termsOfService Podmínky vlastností smlouvy o poskytování služeb. TermsOfServiceProperties

RegistrationDelegationSettingsProperties

Jméno Popis Hodnota
zpřístupněný Povolte nebo zakažte delegování pro registraci uživatelů. Bool

SubscriptionsDelegationSettingsProperties

Jméno Popis Hodnota
zpřístupněný Povolte nebo zakažte delegování pro předplatná. Bool

TermsOfServiceProperties

Jméno Popis Hodnota
consentRequired Požádejte uživatele o souhlas s podmínkami služby. Bool
zpřístupněný Během procesu registrace můžete zobrazit podmínky služby. Bool
Text Text podmínek služby. řetězec

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku service/portalsettings je možné nasadit s operacemi, které cílí:

  • skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/portalsettings, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  name = "string"
  // For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}

microsoft.apimanagement/service/portalsettings – objekty

Nastavte vlastnost název, která určuje typ objektu.

Pro přihlášenípoužijte:

{
  name = "signin"
  properties = {
    enabled = bool
  }
}

Pro registrace použijte:

{
  name = "signup"
  properties = {
    enabled = bool
    termsOfService = {
      consentRequired = bool
      enabled = bool
      text = "string"
    }
  }
}

Pro delegování použijte:

{
  name = "delegation"
  properties = {
    subscriptions = {
      enabled = bool
    }
    url = "string"
    userRegistration = {
      enabled = bool
    }
    validationKey = "string"
  }
}

Hodnoty vlastností

microsoft.apimanagement/service/portalsettings

Jméno Popis Hodnota
Jméno Nastavte na signin pro typ Microsoft.ApiManagement/service/portalsettings. Pro typ Microsoft.ApiManagement/service/portalsettingsnastavte na signup . Nastavte na delegování pro typ Microsoft.ApiManagement/service/portalsettings. "delegování"
'signin'
Registrace (povinné)

Microsoft.ApiManagement/service/portalsettings

Jméno Popis Hodnota
Jméno Název prostředku 'signin' (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: služby
vlastnosti Vlastnosti kontraktu nastavení přihlášení portalSigninSettingProperties
typ Typ prostředku "Microsoft.ApiManagement/service/portalsettings@2018-01-01"

Microsoft.ApiManagement/service/portalsettings

Jméno Popis Hodnota
Jméno Název prostředku Registrace (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: služby
vlastnosti Vlastnosti kontraktu nastavení registrace PortalSignupSettingsProperties
typ Typ prostředku "Microsoft.ApiManagement/service/portalsettings@2018-01-01"

Microsoft.ApiManagement/service/portalsettings

Jméno Popis Hodnota
Jméno Název prostředku "delegování" (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: služby
vlastnosti Vlastnosti kontraktu nastavení delegování PortalDelegationSettingsProperties
typ Typ prostředku "Microsoft.ApiManagement/service/portalsettings@2018-01-01"

PortalDelegationSettingsProperties

Jméno Popis Hodnota
předplatná Nastavení delegování předplatných subscriptionsDelegationSettingsProperties
adresa URL Adresa URL delegování. řetězec
userRegistration Nastavení delegování registrace uživatele RegistrationDelegationSettingsProperties
validationKey Ověřovací klíč kódovaný s kódováním Base64, který ověří, že požadavek pochází ze služby Azure API Management. řetězec

PortalSigninSettingProperties

Jméno Popis Hodnota
zpřístupněný Přesměrujte anonymní uživatele na stránku Sign-In. Bool

PortalSignupSettingsProperties

Jméno Popis Hodnota
zpřístupněný Povolte uživatelům registraci na portálu pro vývojáře. Bool
termsOfService Podmínky vlastností smlouvy o poskytování služeb. TermsOfServiceProperties

RegistrationDelegationSettingsProperties

Jméno Popis Hodnota
zpřístupněný Povolte nebo zakažte delegování pro registraci uživatelů. Bool

SubscriptionsDelegationSettingsProperties

Jméno Popis Hodnota
zpřístupněný Povolte nebo zakažte delegování pro předplatná. Bool

TermsOfServiceProperties

Jméno Popis Hodnota
consentRequired Požádejte uživatele o souhlas s podmínkami služby. Bool
zpřístupněný Během procesu registrace můžete zobrazit podmínky služby. Bool
Text Text podmínek služby. řetězec