Microsoft.ApiManagement service/portalsettings 2022-08-01

• najnowsze
• 2024-06-01-preview
• 2024-05-01
• 2023-09-01-preview
• 2023-05-01-preview
• 2023-03-01-preview
• 2022-09-01-preview
• 2022-08-01
• 2022-04-01-preview
• 2021-12-01-preview
• 2021-08-01
• 2021-04-01-preview
• 2021-01-01-preview
• 2020-12-01
• 2020-06-01-preview
• 2019-12-01
• 2019-12-01-preview
• 2019-01-01
• 2018-06-01-preview
• 2018-01-01
• 2017-03-01

Definicja zasobu Bicep

Typ zasobu service/portalsettings 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/portalsettings, dodaj następujący kod Bicep do szablonu.

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

microsoft.apimanagement/service/portalsettings objects

Ustaw właściwość nazwy , aby określić typ obiektu.

W przypadku signinużyj:

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

W przypadku rejestracjiużyj:

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

W przypadkudelegowania użyj:

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

Wartości właściwości

microsoft.apimanagement/service/portalsettings

Nazwa	Opis	Wartość
nazwa	Ustaw wartość "signin" dla typu Microsoft.ApiManagement/service/portalsettings. Ustaw wartość "signup" dla typu Microsoft.ApiManagement/service/portalsettings. Ustaw wartość "delegowanie" dla typu Microsoft.ApiManagement/service/portalsettings.	"Delegowanie" "signin" "Rejestracja" (wymagane)

Microsoft.ApiManagement/service/portalsettings

Nazwa	Opis	Wartość
nazwa	Nazwa zasobu	"signin" (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	Właściwości kontraktu ustawień logowania.	PortalSigninSettingProperties

Microsoft.ApiManagement/service/portalsettings

Nazwa	Opis	Wartość
nazwa	Nazwa zasobu	"Rejestracja" (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	Właściwości kontraktu ustawień rejestracji.	PortalSignupSettingsProperties

Microsoft.ApiManagement/service/portalsettings

Nazwa	Opis	Wartość
nazwa	Nazwa zasobu	"delegowanie" (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	Właściwości kontraktu ustawień delegowania.	PortalDelegationSettingsProperties

PortalDelegationSettingsProperties

Nazwa	Opis	Wartość
Subskrypcji	Ustawienia delegowania subskrypcji.	SubscriptionsDelegationSettingsProperties
adres URL	Adres URL delegowania.	struna
userRegistration	Ustawienia delegowania rejestracji użytkownika.	RegistrationDelegationSettingsProperties
validationKey	Klucz weryfikacji zakodowany w formacie base64 do zweryfikowania, że żądanie pochodzi z usługi Azure API Management.	struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr.

PortalSigninSettingProperties

Nazwa	Opis	Wartość
Włączone	Przekieruj użytkowników anonimowych na stronę Sign-In.	Bool

PortalSignupSettingsProperties

Nazwa	Opis	Wartość
Włączone	Zezwalaj użytkownikom na rejestrację w portalu dla deweloperów.	Bool
termsOfService	Warunki użytkowania umowy o świadczenie usług.	TermsOfServiceProperties

RegistrationDelegationSettingsProperties

Nazwa	Opis	Wartość
Włączone	Włącz lub wyłącz delegowanie na potrzeby rejestracji użytkownika.	Bool

SubscriptionsDelegationSettingsProperties

Nazwa	Opis	Wartość
Włączone	Włączanie lub wyłączanie delegowania dla subskrypcji.	Bool

TermsOfServiceProperties

Nazwa	Opis	Wartość
consentRequired	Poproś użytkownika o zgodę na warunki użytkowania usługi.	Bool
Włączone	Wyświetlanie warunków świadczenia usługi podczas procesu rejestracji.	Bool
Tekst	Warunki korzystania z tekstu usługi.	struna

Definicja zasobu szablonu usługi ARM

Typ zasobu service/portalsettings 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/portalsettings, dodaj następujący kod JSON do szablonu.

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

microsoft.apimanagement/service/portalsettings objects

Ustaw właściwość nazwy , aby określić typ obiektu.

W przypadku signinużyj:

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

W przypadku rejestracjiużyj:

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

W przypadkudelegowania użyj:

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

Wartości właściwości

microsoft.apimanagement/service/portalsettings

Nazwa	Opis	Wartość
nazwa	Ustaw wartość "signin" dla typu Microsoft.ApiManagement/service/portalsettings. Ustaw wartość "signup" dla typu Microsoft.ApiManagement/service/portalsettings. Ustaw wartość "delegowanie" dla typu Microsoft.ApiManagement/service/portalsettings.	"Delegowanie" "signin" "Rejestracja" (wymagane)

Microsoft.ApiManagement/service/portalsettings

Nazwa	Opis	Wartość
apiVersion	Wersja interfejsu API	'2022-08-01'
nazwa	Nazwa zasobu	"signin" (wymagane)
Właściwości	Właściwości kontraktu ustawień logowania.	PortalSigninSettingProperties
typ	Typ zasobu	"Microsoft.ApiManagement/service/portalsettings"

Microsoft.ApiManagement/service/portalsettings

Nazwa	Opis	Wartość
apiVersion	Wersja interfejsu API	'2022-08-01'
nazwa	Nazwa zasobu	"Rejestracja" (wymagane)
Właściwości	Właściwości kontraktu ustawień rejestracji.	PortalSignupSettingsProperties
typ	Typ zasobu	"Microsoft.ApiManagement/service/portalsettings"

Microsoft.ApiManagement/service/portalsettings

Nazwa	Opis	Wartość
apiVersion	Wersja interfejsu API	'2022-08-01'
nazwa	Nazwa zasobu	"delegowanie" (wymagane)
Właściwości	Właściwości kontraktu ustawień delegowania.	PortalDelegationSettingsProperties
typ	Typ zasobu	"Microsoft.ApiManagement/service/portalsettings"

PortalDelegationSettingsProperties

Nazwa	Opis	Wartość
Subskrypcji	Ustawienia delegowania subskrypcji.	SubscriptionsDelegationSettingsProperties
adres URL	Adres URL delegowania.	struna
userRegistration	Ustawienia delegowania rejestracji użytkownika.	RegistrationDelegationSettingsProperties
validationKey	Klucz weryfikacji zakodowany w formacie base64 do zweryfikowania, że żądanie pochodzi z usługi Azure API Management.	struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr.

PortalSigninSettingProperties

Nazwa	Opis	Wartość
Włączone	Przekieruj użytkowników anonimowych na stronę Sign-In.	Bool

PortalSignupSettingsProperties

Nazwa	Opis	Wartość
Włączone	Zezwalaj użytkownikom na rejestrację w portalu dla deweloperów.	Bool
termsOfService	Warunki użytkowania umowy o świadczenie usług.	TermsOfServiceProperties

RegistrationDelegationSettingsProperties

Nazwa	Opis	Wartość
Włączone	Włącz lub wyłącz delegowanie na potrzeby rejestracji użytkownika.	Bool

SubscriptionsDelegationSettingsProperties

Nazwa	Opis	Wartość
Włączone	Włączanie lub wyłączanie delegowania dla subskrypcji.	Bool

TermsOfServiceProperties

Nazwa	Opis	Wartość
consentRequired	Poproś użytkownika o zgodę na warunki użytkowania usługi.	Bool
Włączone	Wyświetlanie warunków świadczenia usługi podczas procesu rejestracji.	Bool
Tekst	Warunki korzystania z tekstu usługi.	struna

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu service/portalsettings 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/portalsettings, dodaj następujący program Terraform do szablonu.

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

microsoft.apimanagement/service/portalsettings objects

Ustaw właściwość nazwy , aby określić typ obiektu.

W przypadku signinużyj:

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

W przypadku rejestracjiużyj:

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

W przypadkudelegowania użyj:

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

Wartości właściwości

microsoft.apimanagement/service/portalsettings

Nazwa	Opis	Wartość
nazwa	Ustaw wartość "signin" dla typu Microsoft.ApiManagement/service/portalsettings. Ustaw wartość "signup" dla typu Microsoft.ApiManagement/service/portalsettings. Ustaw wartość "delegowanie" dla typu Microsoft.ApiManagement/service/portalsettings.	"Delegowanie" "signin" "Rejestracja" (wymagane)

Microsoft.ApiManagement/service/portalsettings

Nazwa	Opis	Wartość
nazwa	Nazwa zasobu	"signin" (wymagane)
parent_id	Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu.	Identyfikator zasobu typu: usługi
Właściwości	Właściwości kontraktu ustawień logowania.	PortalSigninSettingProperties
typ	Typ zasobu	"Microsoft.ApiManagement/service/portalsettings@2022-08-01"

Microsoft.ApiManagement/service/portalsettings

Nazwa	Opis	Wartość
nazwa	Nazwa zasobu	"Rejestracja" (wymagane)
parent_id	Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu.	Identyfikator zasobu typu: usługi
Właściwości	Właściwości kontraktu ustawień rejestracji.	PortalSignupSettingsProperties
typ	Typ zasobu	"Microsoft.ApiManagement/service/portalsettings@2022-08-01"

Microsoft.ApiManagement/service/portalsettings

Nazwa	Opis	Wartość
nazwa	Nazwa zasobu	"delegowanie" (wymagane)
parent_id	Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu.	Identyfikator zasobu typu: usługi
Właściwości	Właściwości kontraktu ustawień delegowania.	PortalDelegationSettingsProperties
typ	Typ zasobu	"Microsoft.ApiManagement/service/portalsettings@2022-08-01"

PortalDelegationSettingsProperties

Nazwa	Opis	Wartość
Subskrypcji	Ustawienia delegowania subskrypcji.	SubscriptionsDelegationSettingsProperties
adres URL	Adres URL delegowania.	struna
userRegistration	Ustawienia delegowania rejestracji użytkownika.	RegistrationDelegationSettingsProperties
validationKey	Klucz weryfikacji zakodowany w formacie base64 do zweryfikowania, że żądanie pochodzi z usługi Azure API Management.	struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr.

PortalSigninSettingProperties

Nazwa	Opis	Wartość
Włączone	Przekieruj użytkowników anonimowych na stronę Sign-In.	Bool

PortalSignupSettingsProperties

Nazwa	Opis	Wartość
Włączone	Zezwalaj użytkownikom na rejestrację w portalu dla deweloperów.	Bool
termsOfService	Warunki użytkowania umowy o świadczenie usług.	TermsOfServiceProperties

RegistrationDelegationSettingsProperties

Nazwa	Opis	Wartość
Włączone	Włącz lub wyłącz delegowanie na potrzeby rejestracji użytkownika.	Bool

SubscriptionsDelegationSettingsProperties

Nazwa	Opis	Wartość
Włączone	Włączanie lub wyłączanie delegowania dla subskrypcji.	Bool

TermsOfServiceProperties

Nazwa	Opis	Wartość
consentRequired	Poproś użytkownika o zgodę na warunki użytkowania usługi.	Bool
Włączone	Wyświetlanie warunków świadczenia usługi podczas procesu rejestracji.	Bool
Tekst	Warunki korzystania z tekstu usługi.	struna