Dela via

Microsoft.ApiManagement service/portalsettings 2023-05-01-preview

  • Artikel

Bicep-resursdefinition

Resurstypen service/portalsettings kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/portalsettings-resurs lägger du till följande Bicep i mallen.

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

microsoft.apimanagement/service/portalsettings-objekt

Ange egenskapen namn för att ange typ av objekt.

För inloggninganvänder du:

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

För registreringanvänder du:

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

Använd för delegering:

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

Egenskapsvärden

microsoft.apimanagement/service/portalsettings

Namn Beskrivning Värde
Namn Ange till "signin" för typ Microsoft.ApiManagement/service/portalsettings. Ange till "registrering" för typen Microsoft.ApiManagement/service/portalsettings. Ange till delegering för typ Microsoft.ApiManagement/service/portalsettings. "delegering"
"signin"
"registrering" (krävs)

Microsoft.ApiManagement/service/portalsettings

Namn Beskrivning Värde
Namn Resursnamnet "signin" (krävs)
förälder I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför den överordnade resursen.		 Symboliskt namn för resurs av typen: tjänst
Egenskaper Kontraktegenskaper för inloggningsinställningar. PortalSigninSettingEgenskaper

Microsoft.ApiManagement/service/portalsettings

Namn Beskrivning Värde
Namn Resursnamnet "registrering" (krävs)
förälder I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför den överordnade resursen.		 Symboliskt namn för resurs av typen: tjänst
Egenskaper Avtalsegenskaper för registreringsinställningar. PortalSignupSettingsEgenskaper

Microsoft.ApiManagement/service/portalsettings

Namn Beskrivning Värde
Namn Resursnamnet "delegering" (krävs)
förälder I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför den överordnade resursen.		 Symboliskt namn för resurs av typen: tjänst
Egenskaper Kontraktegenskaper för delegeringsinställningar. PortalDelegationSettingsEgenskaper

PortalDelegationSettingsProperties

Namn Beskrivning Värde
prenumerationer Delegeringsinställningar för prenumerationer. SubscriptionsDelegationSettingsProperties
URL En delegerings-URL. sträng
userRegistration Delegeringsinställningar för användarregistrering. RegistrationDelegationSettingsEgenskaper
validationKey En base64-kodad valideringsnyckel för att verifiera att en begäran kommer från Azure API Management. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.

PortalSigninSettingEgenskaper

Namn Beskrivning Värde
Aktiverat Omdirigera anonyma användare till sidan Sign-In. Bool

PortalSignupSettingsEgenskaper

Namn Beskrivning Värde
Aktiverat Tillåt användare att registrera sig på en utvecklarportal. Bool
termsOfService Egenskaper för tjänstevillkorskontrakt. TermsOfServiceProperties

RegistrationDelegationSettingsProperties

Namn Beskrivning Värde
Aktiverat Aktivera eller inaktivera delegering för användarregistrering. Bool

SubscriptionsDelegationSettingsProperties

Namn Beskrivning Värde
Aktiverat Aktivera eller inaktivera delegering för prenumerationer. Bool

TermsOfServiceProperties

Namn Beskrivning Värde
consentRequired Be användaren om medgivande till användarvillkoren. Bool
Aktiverat Visa tjänstvillkor under en registreringsprocess. Bool
SMS En text om villkor för tjänsten. sträng

Resursdefinition för ARM-mall

Resurstypen service/portalsettings kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/portalsettings-resurs lägger du till följande JSON i mallen.

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

microsoft.apimanagement/service/portalsettings-objekt

Ange egenskapen namn för att ange typ av objekt.

För inloggninganvänder du:

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

För registreringanvänder du:

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

Använd för delegering:

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

Egenskapsvärden

microsoft.apimanagement/service/portalsettings

Namn Beskrivning Värde
Namn Ange till "signin" för typ Microsoft.ApiManagement/service/portalsettings. Ange till "registrering" för typen Microsoft.ApiManagement/service/portalsettings. Ange till delegering för typ Microsoft.ApiManagement/service/portalsettings. "delegering"
"signin"
"registrering" (krävs)

Microsoft.ApiManagement/service/portalsettings

Namn Beskrivning Värde
apiVersion API-versionen "2023-05-01-preview"
Namn Resursnamnet "signin" (krävs)
Egenskaper Kontraktegenskaper för inloggningsinställningar. PortalSigninSettingEgenskaper
typ Resurstypen "Microsoft.ApiManagement/service/portalsettings"

Microsoft.ApiManagement/service/portalsettings

Namn Beskrivning Värde
apiVersion API-versionen "2023-05-01-preview"
Namn Resursnamnet "registrering" (krävs)
Egenskaper Avtalsegenskaper för registreringsinställningar. PortalSignupSettingsEgenskaper
typ Resurstypen "Microsoft.ApiManagement/service/portalsettings"

Microsoft.ApiManagement/service/portalsettings

Namn Beskrivning Värde
apiVersion API-versionen "2023-05-01-preview"
Namn Resursnamnet "delegering" (krävs)
Egenskaper Kontraktegenskaper för delegeringsinställningar. PortalDelegationSettingsEgenskaper
typ Resurstypen "Microsoft.ApiManagement/service/portalsettings"

PortalDelegationSettingsProperties

Namn Beskrivning Värde
prenumerationer Delegeringsinställningar för prenumerationer. SubscriptionsDelegationSettingsProperties
URL En delegerings-URL. sträng
userRegistration Delegeringsinställningar för användarregistrering. RegistrationDelegationSettingsEgenskaper
validationKey En base64-kodad valideringsnyckel för att verifiera att en begäran kommer från Azure API Management. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.

PortalSigninSettingEgenskaper

Namn Beskrivning Värde
Aktiverat Omdirigera anonyma användare till sidan Sign-In. Bool

PortalSignupSettingsEgenskaper

Namn Beskrivning Värde
Aktiverat Tillåt användare att registrera sig på en utvecklarportal. Bool
termsOfService Egenskaper för tjänstevillkorskontrakt. TermsOfServiceProperties

RegistrationDelegationSettingsProperties

Namn Beskrivning Värde
Aktiverat Aktivera eller inaktivera delegering för användarregistrering. Bool

SubscriptionsDelegationSettingsProperties

Namn Beskrivning Värde
Aktiverat Aktivera eller inaktivera delegering för prenumerationer. Bool

TermsOfServiceProperties

Namn Beskrivning Värde
consentRequired Be användaren om medgivande till användarvillkoren. Bool
Aktiverat Visa tjänstvillkor under en registreringsprocess. Bool
SMS En text om villkor för tjänsten. sträng

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen service/portalsettings kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/portalsettings-resurs lägger du till följande Terraform i mallen.

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

microsoft.apimanagement/service/portalsettings-objekt

Ange egenskapen namn för att ange typ av objekt.

För inloggninganvänder du:

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

För registreringanvänder du:

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

Använd för delegering:

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

Egenskapsvärden

microsoft.apimanagement/service/portalsettings

Namn Beskrivning Värde
Namn Ange till "signin" för typ Microsoft.ApiManagement/service/portalsettings. Ange till "registrering" för typen Microsoft.ApiManagement/service/portalsettings. Ange till delegering för typ Microsoft.ApiManagement/service/portalsettings. "delegering"
"signin"
"registrering" (krävs)

Microsoft.ApiManagement/service/portalsettings

Namn Beskrivning Värde
Namn Resursnamnet "signin" (krävs)
parent_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: tjänst
Egenskaper Kontraktegenskaper för inloggningsinställningar. PortalSigninSettingEgenskaper
typ Resurstypen "Microsoft.ApiManagement/service/portalsettings@2023-05-01-preview"

Microsoft.ApiManagement/service/portalsettings

Namn Beskrivning Värde
Namn Resursnamnet "registrering" (krävs)
parent_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: tjänst
Egenskaper Avtalsegenskaper för registreringsinställningar. PortalSignupSettingsEgenskaper
typ Resurstypen "Microsoft.ApiManagement/service/portalsettings@2023-05-01-preview"

Microsoft.ApiManagement/service/portalsettings

Namn Beskrivning Värde
Namn Resursnamnet "delegering" (krävs)
parent_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: tjänst
Egenskaper Kontraktegenskaper för delegeringsinställningar. PortalDelegationSettingsEgenskaper
typ Resurstypen "Microsoft.ApiManagement/service/portalsettings@2023-05-01-preview"

PortalDelegationSettingsProperties

Namn Beskrivning Värde
prenumerationer Delegeringsinställningar för prenumerationer. SubscriptionsDelegationSettingsProperties
URL En delegerings-URL. sträng
userRegistration Delegeringsinställningar för användarregistrering. RegistrationDelegationSettingsEgenskaper
validationKey En base64-kodad valideringsnyckel för att verifiera att en begäran kommer från Azure API Management. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.

PortalSigninSettingEgenskaper

Namn Beskrivning Värde
Aktiverat Omdirigera anonyma användare till sidan Sign-In. Bool

PortalSignupSettingsEgenskaper

Namn Beskrivning Värde
Aktiverat Tillåt användare att registrera sig på en utvecklarportal. Bool
termsOfService Egenskaper för tjänstevillkorskontrakt. TermsOfServiceProperties

RegistrationDelegationSettingsProperties

Namn Beskrivning Värde
Aktiverat Aktivera eller inaktivera delegering för användarregistrering. Bool

SubscriptionsDelegationSettingsProperties

Namn Beskrivning Värde
Aktiverat Aktivera eller inaktivera delegering för prenumerationer. Bool

TermsOfServiceProperties

Namn Beskrivning Värde
consentRequired Be användaren om medgivande till användarvillkoren. Bool
Aktiverat Visa tjänstvillkor under en registreringsprocess. Bool
SMS En text om villkor för tjänsten. sträng