Microsoft.ApiManagement-service/portalsettings 2024-06-01-preview
- meest recente
- 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
Bicep-resourcedefinitie
Het resourcetype service/portalsettings kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Resource microsoft.ApiManagement/service/portalsettings wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
resource symbolicname 'Microsoft.ApiManagement/service/portalsettings@2024-06-01-preview' = {
name: 'string'
// For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}
microsoft.apimanagement/service/portalsettings-objecten
Stel de eigenschap naam in om het type object op te geven.
Gebruik voor aanmelding:
{
name: 'signin'
properties: {
enabled: bool
}
}
Gebruik voor registratie:
{
name: 'signup'
properties: {
enabled: bool
termsOfService: {
consentRequired: bool
enabled: bool
text: 'string'
}
}
}
Gebruik voor delegering:
{
name: 'delegation'
properties: {
subscriptions: {
enabled: bool
}
url: 'string'
userRegistration: {
enabled: bool
}
validationKey: 'string'
}
}
Eigenschapswaarden
microsoft.apimanagement/service/portalsettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | Ingesteld op 'signin' voor het type Microsoft.ApiManagement/service/portalsettings. Ingesteld op 'registreren' voor het type Microsoft.ApiManagement/service/portalsettings. Ingesteld op 'delegatie' voor het type Microsoft.ApiManagement/service/portalsettings. | "delegatie" 'signin' 'registratie' (vereist) |
Microsoft.ApiManagement/service/portalsettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De resourcenaam | 'signin' (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 | Contracteigenschappen voor aanmeldingsinstellingen. | PortalSigninSettingProperties- |
Microsoft.ApiManagement/service/portalsettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De resourcenaam | 'registratie' (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 | Contracteigenschappen voor registratie-instellingen. | PortalSignupSettingsProperties- |
Microsoft.ApiManagement/service/portalsettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De resourcenaam | 'delegatie' (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 | Contracteigenschappen voor delegatie-instellingen. | PortalDelegationSettingsProperties- |
PortalDelegationSettingsProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| Abonnementen | Instellingen voor delegering van abonnementen. | SubscriptionsDelegationSettingsProperties- |
| URL | Een delegatie-URL. | snaar |
| userRegistration | Instellingen voor delegering van gebruikersregistratie. | RegistrationDelegationSettingsProperties |
| validationKey | Een met base64 gecodeerde validatiesleutel om te valideren dat een aanvraag afkomstig is van Azure API Management. | snaar Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
PortalSigninSettingProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| Ingeschakeld | Anonieme gebruikers omleiden naar de pagina Sign-In. | Bool |
PortalSignupSettingsProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| Ingeschakeld | Gebruikers toestaan zich aan te melden bij een ontwikkelaarsportal. | Bool |
| termsOfService | Eigenschappen van servicecontractvoorwaarden. | TermsOfServiceProperties- |
RegistrationDelegationSettingsProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| Ingeschakeld | Delegatie voor gebruikersregistratie in- of uitschakelen. | Bool |
SubscriptionsDelegationSettingsProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| Ingeschakeld | Delegatie voor abonnementen in- of uitschakelen. | Bool |
TermsOfServiceProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| consentRequired | Vraag de gebruiker om toestemming voor de servicevoorwaarden. | Bool |
| Ingeschakeld | Servicevoorwaarden weergeven tijdens een registratieproces. | Bool |
| Sms | Een servicevoorwaardentekst. | snaar |
Resourcedefinitie van ARM-sjabloon
Het resourcetype service/portalsettings kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een resource voor Microsoft.ApiManagement/service/portalsettings wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"name": "string"
// For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}
microsoft.apimanagement/service/portalsettings-objecten
Stel de eigenschap naam in om het type object op te geven.
Gebruik voor aanmelding:
{
"name": "signin",
"properties": {
"enabled": "bool"
}
}
Gebruik voor registratie:
{
"name": "signup",
"properties": {
"enabled": "bool",
"termsOfService": {
"consentRequired": "bool",
"enabled": "bool",
"text": "string"
}
}
}
Gebruik voor delegering:
{
"name": "delegation",
"properties": {
"subscriptions": {
"enabled": "bool"
},
"url": "string",
"userRegistration": {
"enabled": "bool"
},
"validationKey": "string"
}
}
Eigenschapswaarden
microsoft.apimanagement/service/portalsettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | Ingesteld op 'signin' voor het type Microsoft.ApiManagement/service/portalsettings. Ingesteld op 'registreren' voor het type Microsoft.ApiManagement/service/portalsettings. Ingesteld op 'delegatie' voor het type Microsoft.ApiManagement/service/portalsettings. | "delegatie" 'signin' 'registratie' (vereist) |
Microsoft.ApiManagement/service/portalsettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| apiVersion | De API-versie | '2024-06-01-preview' |
| naam | De resourcenaam | 'signin' (vereist) |
| Eigenschappen | Contracteigenschappen voor aanmeldingsinstellingen. | PortalSigninSettingProperties- |
| type | Het resourcetype | 'Microsoft.ApiManagement/service/portalsettings' |
Microsoft.ApiManagement/service/portalsettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| apiVersion | De API-versie | '2024-06-01-preview' |
| naam | De resourcenaam | 'registratie' (vereist) |
| Eigenschappen | Contracteigenschappen voor registratie-instellingen. | PortalSignupSettingsProperties- |
| type | Het resourcetype | 'Microsoft.ApiManagement/service/portalsettings' |
Microsoft.ApiManagement/service/portalsettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| apiVersion | De API-versie | '2024-06-01-preview' |
| naam | De resourcenaam | 'delegatie' (vereist) |
| Eigenschappen | Contracteigenschappen voor delegatie-instellingen. | PortalDelegationSettingsProperties- |
| type | Het resourcetype | 'Microsoft.ApiManagement/service/portalsettings' |
PortalDelegationSettingsProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| Abonnementen | Instellingen voor delegering van abonnementen. | SubscriptionsDelegationSettingsProperties- |
| URL | Een delegatie-URL. | snaar |
| userRegistration | Instellingen voor delegering van gebruikersregistratie. | RegistrationDelegationSettingsProperties |
| validationKey | Een met base64 gecodeerde validatiesleutel om te valideren dat een aanvraag afkomstig is van Azure API Management. | snaar Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
PortalSigninSettingProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| Ingeschakeld | Anonieme gebruikers omleiden naar de pagina Sign-In. | Bool |
PortalSignupSettingsProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| Ingeschakeld | Gebruikers toestaan zich aan te melden bij een ontwikkelaarsportal. | Bool |
| termsOfService | Eigenschappen van servicecontractvoorwaarden. | TermsOfServiceProperties- |
RegistrationDelegationSettingsProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| Ingeschakeld | Delegatie voor gebruikersregistratie in- of uitschakelen. | Bool |
SubscriptionsDelegationSettingsProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| Ingeschakeld | Delegatie voor abonnementen in- of uitschakelen. | Bool |
TermsOfServiceProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| consentRequired | Vraag de gebruiker om toestemming voor de servicevoorwaarden. | Bool |
| Ingeschakeld | Servicevoorwaarden weergeven tijdens een registratieproces. | Bool |
| Sms | Een servicevoorwaardentekst. | snaar |
Resourcedefinitie van Terraform (AzAPI-provider)
Het resourcetype service/portalsettings 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/portalsettings wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
name = "string"
// For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}
microsoft.apimanagement/service/portalsettings-objecten
Stel de eigenschap naam in om het type object op te geven.
Gebruik voor aanmelding:
{
name = "signin"
properties = {
enabled = bool
}
}
Gebruik voor registratie:
{
name = "signup"
properties = {
enabled = bool
termsOfService = {
consentRequired = bool
enabled = bool
text = "string"
}
}
}
Gebruik voor delegering:
{
name = "delegation"
properties = {
subscriptions = {
enabled = bool
}
url = "string"
userRegistration = {
enabled = bool
}
validationKey = "string"
}
}
Eigenschapswaarden
microsoft.apimanagement/service/portalsettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | Ingesteld op 'signin' voor het type Microsoft.ApiManagement/service/portalsettings. Ingesteld op 'registreren' voor het type Microsoft.ApiManagement/service/portalsettings. Ingesteld op 'delegatie' voor het type Microsoft.ApiManagement/service/portalsettings. | "delegatie" 'signin' 'registratie' (vereist) |
Microsoft.ApiManagement/service/portalsettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De resourcenaam | 'signin' (vereist) |
| parent_id | De id van de resource die het bovenliggende item voor deze resource is. | Id voor resource van het type: service- |
| Eigenschappen | Contracteigenschappen voor aanmeldingsinstellingen. | PortalSigninSettingProperties- |
| type | Het resourcetype | "Microsoft.ApiManagement/service/portalsettings@2024-06-01-preview" |
Microsoft.ApiManagement/service/portalsettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De resourcenaam | 'registratie' (vereist) |
| parent_id | De id van de resource die het bovenliggende item voor deze resource is. | Id voor resource van het type: service- |
| Eigenschappen | Contracteigenschappen voor registratie-instellingen. | PortalSignupSettingsProperties- |
| type | Het resourcetype | "Microsoft.ApiManagement/service/portalsettings@2024-06-01-preview" |
Microsoft.ApiManagement/service/portalsettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De resourcenaam | 'delegatie' (vereist) |
| parent_id | De id van de resource die het bovenliggende item voor deze resource is. | Id voor resource van het type: service- |
| Eigenschappen | Contracteigenschappen voor delegatie-instellingen. | PortalDelegationSettingsProperties- |
| type | Het resourcetype | "Microsoft.ApiManagement/service/portalsettings@2024-06-01-preview" |
PortalDelegationSettingsProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| Abonnementen | Instellingen voor delegering van abonnementen. | SubscriptionsDelegationSettingsProperties- |
| URL | Een delegatie-URL. | snaar |
| userRegistration | Instellingen voor delegering van gebruikersregistratie. | RegistrationDelegationSettingsProperties |
| validationKey | Een met base64 gecodeerde validatiesleutel om te valideren dat een aanvraag afkomstig is van Azure API Management. | snaar Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
PortalSigninSettingProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| Ingeschakeld | Anonieme gebruikers omleiden naar de pagina Sign-In. | Bool |
PortalSignupSettingsProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| Ingeschakeld | Gebruikers toestaan zich aan te melden bij een ontwikkelaarsportal. | Bool |
| termsOfService | Eigenschappen van servicecontractvoorwaarden. | TermsOfServiceProperties- |
RegistrationDelegationSettingsProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| Ingeschakeld | Delegatie voor gebruikersregistratie in- of uitschakelen. | Bool |
SubscriptionsDelegationSettingsProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| Ingeschakeld | Delegatie voor abonnementen in- of uitschakelen. | Bool |
TermsOfServiceProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| consentRequired | Vraag de gebruiker om toestemming voor de servicevoorwaarden. | Bool |
| Ingeschakeld | Servicevoorwaarden weergeven tijdens een registratieproces. | Bool |
| Sms | Een servicevoorwaardentekst. | snaar |