Microsoft.ApiManagement service/portalsettings 2024-05-01
- neueste
- 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-Vorschau-
- 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-Ressourcendefinition
Der Ressourcentyp "service/portalsettings" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/portalsettings-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Bicep hinzu.
resource symbolicname 'Microsoft.ApiManagement/service/portalsettings@2024-05-01' = {
name: 'string'
// For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}
microsoft.apimanagement/service/portalsettings-Objekte
Legen Sie den Namen Eigenschaft fest, um den Objekttyp anzugeben.
Verwenden Sie für signin:
{
name: 'signin'
properties: {
enabled: bool
}
}
Verwenden Sie für Registrierung:
{
name: 'signup'
properties: {
enabled: bool
termsOfService: {
consentRequired: bool
enabled: bool
text: 'string'
}
}
}
Verwenden Sie für Delegierung:
{
name: 'delegation'
properties: {
subscriptions: {
enabled: bool
}
url: 'string'
userRegistration: {
enabled: bool
}
validationKey: 'string'
}
}
Eigenschaftswerte
microsoft.apimanagement/service/portalsettings
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Legen Sie für den Typ Microsoft.ApiManagement/service/portalsettingsauf "signin" fest. Legen Sie für den Typ Microsoft.ApiManagement/service/portalsettingsauf "Signup" fest. Legen Sie für den Typ Microsoft.ApiManagement/service/portalsettingsauf "delegierung" fest. | "Delegierung" "signin" "Registrierung" (erforderlich) |
Microsoft.ApiManagement/service/portalsettings
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | "signin" (erforderlich) |
| Elternteil | In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource. |
Symbolischer Name für Ressource des Typs: Dienst- |
| Eigenschaften | Vertragseigenschaften für Anmeldeeinstellungen. | PortalSigninSettingProperties |
Microsoft.ApiManagement/service/portalsettings
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | "Registrierung" (erforderlich) |
| Elternteil | In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource. |
Symbolischer Name für Ressource des Typs: Dienst- |
| Eigenschaften | Vertragseigenschaften für Registrierungseinstellungen. | PortalSignupSettingsProperties |
Microsoft.ApiManagement/service/portalsettings
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | "Delegierung" (erforderlich) |
| Elternteil | In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource. |
Symbolischer Name für Ressource des Typs: Dienst- |
| Eigenschaften | Vertragseigenschaften für Delegierungseinstellungen. | PortalDelegationSettingsProperties |
PortalDelegationSettingsProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Abonnements | Abonnementdelegierungseinstellungen. | SubscriptionsDelegationSettingsProperties |
| URL | Eine Delegierungs-URL. | Schnur |
| userRegistration | Einstellungen für die Benutzerregistrierungsdelegierung. | RegistrationDelegationSettingsProperties |
| validationKey | Ein base64-codierter Überprüfungsschlüssel, der überprüft werden soll, dass eine Anforderung von Azure API Management stammt. | Schnur Zwänge: Vertraulicher Wert. Übergeben Als sicherer Parameter. |
PortalSigninSettingProperties
| Name | Beschreibung | Wert |
|---|---|---|
| ermöglichte | Anonyme Benutzer zur Sign-In Seite umleiten. | Bool |
PortalSignupSettingsProperties
| Name | Beschreibung | Wert |
|---|---|---|
| ermöglichte | Zulassen, dass sich Benutzer bei einem Entwicklerportal registrieren können. | Bool |
| termsOfService | Servicevertragseigenschaften. | TermsOfServiceProperties |
RegistrationDelegationSettingsProperties
| Name | Beschreibung | Wert |
|---|---|---|
| ermöglichte | Aktivieren oder Deaktivieren der Delegierung für die Benutzerregistrierung. | Bool |
SubscriptionsDelegationSettingsProperties
| Name | Beschreibung | Wert |
|---|---|---|
| ermöglichte | Aktivieren oder Deaktivieren der Delegierung für Abonnements. | Bool |
TermsOfServiceProperties
| Name | Beschreibung | Wert |
|---|---|---|
| consentRequired | Bitten Sie den Benutzer um Zustimmung zu den Nutzungsbedingungen. | Bool |
| ermöglichte | Nutzungsbedingungen während eines Registrierungsvorgangs anzeigen. | Bool |
| Text | Ein Nutzungsbedingungentext. | Schnur |
ARM-Vorlagenressourcendefinition
Der Ressourcentyp "service/portalsettings" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/portalsettings-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"name": "string"
// For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}
microsoft.apimanagement/service/portalsettings-Objekte
Legen Sie den Namen Eigenschaft fest, um den Objekttyp anzugeben.
Verwenden Sie für signin:
{
"name": "signin",
"properties": {
"enabled": "bool"
}
}
Verwenden Sie für Registrierung:
{
"name": "signup",
"properties": {
"enabled": "bool",
"termsOfService": {
"consentRequired": "bool",
"enabled": "bool",
"text": "string"
}
}
}
Verwenden Sie für Delegierung:
{
"name": "delegation",
"properties": {
"subscriptions": {
"enabled": "bool"
},
"url": "string",
"userRegistration": {
"enabled": "bool"
},
"validationKey": "string"
}
}
Eigenschaftswerte
microsoft.apimanagement/service/portalsettings
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Legen Sie für den Typ Microsoft.ApiManagement/service/portalsettingsauf "signin" fest. Legen Sie für den Typ Microsoft.ApiManagement/service/portalsettingsauf "Signup" fest. Legen Sie für den Typ Microsoft.ApiManagement/service/portalsettingsauf "delegierung" fest. | "Delegierung" "signin" "Registrierung" (erforderlich) |
Microsoft.ApiManagement/service/portalsettings
| Name | Beschreibung | Wert |
|---|---|---|
| apiVersion | Die API-Version | '2024-05-01' |
| Name | Der Ressourcenname | "signin" (erforderlich) |
| Eigenschaften | Vertragseigenschaften für Anmeldeeinstellungen. | PortalSigninSettingProperties |
| Art | Der Ressourcentyp | 'Microsoft.ApiManagement/service/portalsettings' |
Microsoft.ApiManagement/service/portalsettings
| Name | Beschreibung | Wert |
|---|---|---|
| apiVersion | Die API-Version | '2024-05-01' |
| Name | Der Ressourcenname | "Registrierung" (erforderlich) |
| Eigenschaften | Vertragseigenschaften für Registrierungseinstellungen. | PortalSignupSettingsProperties |
| Art | Der Ressourcentyp | 'Microsoft.ApiManagement/service/portalsettings' |
Microsoft.ApiManagement/service/portalsettings
| Name | Beschreibung | Wert |
|---|---|---|
| apiVersion | Die API-Version | '2024-05-01' |
| Name | Der Ressourcenname | "Delegierung" (erforderlich) |
| Eigenschaften | Vertragseigenschaften für Delegierungseinstellungen. | PortalDelegationSettingsProperties |
| Art | Der Ressourcentyp | 'Microsoft.ApiManagement/service/portalsettings' |
PortalDelegationSettingsProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Abonnements | Abonnementdelegierungseinstellungen. | SubscriptionsDelegationSettingsProperties |
| URL | Eine Delegierungs-URL. | Schnur |
| userRegistration | Einstellungen für die Benutzerregistrierungsdelegierung. | RegistrationDelegationSettingsProperties |
| validationKey | Ein base64-codierter Überprüfungsschlüssel, der überprüft werden soll, dass eine Anforderung von Azure API Management stammt. | Schnur Zwänge: Vertraulicher Wert. Übergeben Als sicherer Parameter. |
PortalSigninSettingProperties
| Name | Beschreibung | Wert |
|---|---|---|
| ermöglichte | Anonyme Benutzer zur Sign-In Seite umleiten. | Bool |
PortalSignupSettingsProperties
| Name | Beschreibung | Wert |
|---|---|---|
| ermöglichte | Zulassen, dass sich Benutzer bei einem Entwicklerportal registrieren können. | Bool |
| termsOfService | Servicevertragseigenschaften. | TermsOfServiceProperties |
RegistrationDelegationSettingsProperties
| Name | Beschreibung | Wert |
|---|---|---|
| ermöglichte | Aktivieren oder Deaktivieren der Delegierung für die Benutzerregistrierung. | Bool |
SubscriptionsDelegationSettingsProperties
| Name | Beschreibung | Wert |
|---|---|---|
| ermöglichte | Aktivieren oder Deaktivieren der Delegierung für Abonnements. | Bool |
TermsOfServiceProperties
| Name | Beschreibung | Wert |
|---|---|---|
| consentRequired | Bitten Sie den Benutzer um Zustimmung zu den Nutzungsbedingungen. | Bool |
| ermöglichte | Nutzungsbedingungen während eines Registrierungsvorgangs anzeigen. | Bool |
| Text | Ein Nutzungsbedingungentext. | Schnur |
Terraform -Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp "service/portalsettings" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/portalsettings-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.
resource "azapi_resource" "symbolicname" {
name = "string"
// For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}
microsoft.apimanagement/service/portalsettings-Objekte
Legen Sie den Namen Eigenschaft fest, um den Objekttyp anzugeben.
Verwenden Sie für signin:
{
name = "signin"
properties = {
enabled = bool
}
}
Verwenden Sie für Registrierung:
{
name = "signup"
properties = {
enabled = bool
termsOfService = {
consentRequired = bool
enabled = bool
text = "string"
}
}
}
Verwenden Sie für Delegierung:
{
name = "delegation"
properties = {
subscriptions = {
enabled = bool
}
url = "string"
userRegistration = {
enabled = bool
}
validationKey = "string"
}
}
Eigenschaftswerte
microsoft.apimanagement/service/portalsettings
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Legen Sie für den Typ Microsoft.ApiManagement/service/portalsettingsauf "signin" fest. Legen Sie für den Typ Microsoft.ApiManagement/service/portalsettingsauf "Signup" fest. Legen Sie für den Typ Microsoft.ApiManagement/service/portalsettingsauf "delegierung" fest. | "Delegierung" "signin" "Registrierung" (erforderlich) |
Microsoft.ApiManagement/service/portalsettings
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | "signin" (erforderlich) |
| parent_id | Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. | ID für Ressource des Typs: Dienst- |
| Eigenschaften | Vertragseigenschaften für Anmeldeeinstellungen. | PortalSigninSettingProperties |
| Art | Der Ressourcentyp | "Microsoft.ApiManagement/service/portalsettings@2024-05-01" |
Microsoft.ApiManagement/service/portalsettings
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | "Registrierung" (erforderlich) |
| parent_id | Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. | ID für Ressource des Typs: Dienst- |
| Eigenschaften | Vertragseigenschaften für Registrierungseinstellungen. | PortalSignupSettingsProperties |
| Art | Der Ressourcentyp | "Microsoft.ApiManagement/service/portalsettings@2024-05-01" |
Microsoft.ApiManagement/service/portalsettings
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | "Delegierung" (erforderlich) |
| parent_id | Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. | ID für Ressource des Typs: Dienst- |
| Eigenschaften | Vertragseigenschaften für Delegierungseinstellungen. | PortalDelegationSettingsProperties |
| Art | Der Ressourcentyp | "Microsoft.ApiManagement/service/portalsettings@2024-05-01" |
PortalDelegationSettingsProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Abonnements | Abonnementdelegierungseinstellungen. | SubscriptionsDelegationSettingsProperties |
| URL | Eine Delegierungs-URL. | Schnur |
| userRegistration | Einstellungen für die Benutzerregistrierungsdelegierung. | RegistrationDelegationSettingsProperties |
| validationKey | Ein base64-codierter Überprüfungsschlüssel, der überprüft werden soll, dass eine Anforderung von Azure API Management stammt. | Schnur Zwänge: Vertraulicher Wert. Übergeben Als sicherer Parameter. |
PortalSigninSettingProperties
| Name | Beschreibung | Wert |
|---|---|---|
| ermöglichte | Anonyme Benutzer zur Sign-In Seite umleiten. | Bool |
PortalSignupSettingsProperties
| Name | Beschreibung | Wert |
|---|---|---|
| ermöglichte | Zulassen, dass sich Benutzer bei einem Entwicklerportal registrieren können. | Bool |
| termsOfService | Servicevertragseigenschaften. | TermsOfServiceProperties |
RegistrationDelegationSettingsProperties
| Name | Beschreibung | Wert |
|---|---|---|
| ermöglichte | Aktivieren oder Deaktivieren der Delegierung für die Benutzerregistrierung. | Bool |
SubscriptionsDelegationSettingsProperties
| Name | Beschreibung | Wert |
|---|---|---|
| ermöglichte | Aktivieren oder Deaktivieren der Delegierung für Abonnements. | Bool |
TermsOfServiceProperties
| Name | Beschreibung | Wert |
|---|---|---|
| consentRequired | Bitten Sie den Benutzer um Zustimmung zu den Nutzungsbedingungen. | Bool |
| ermöglichte | Nutzungsbedingungen während eines Registrierungsvorgangs anzeigen. | Bool |
| Text | Ein Nutzungsbedingungentext. | Schnur |