Condividi tramite

Servizio Microsoft.ApiManagement/portalsettings 2021-12-01-preview

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa service/portalsettings può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.ApiManagement/service/portalsettings, aggiungere il bicep seguente al modello.

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

oggetti microsoft.apimanagement/service/portalsettings

Impostare la proprietà nome per specificare il tipo di oggetto.

Per accesso, usare:

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

Per di iscrizione, usare:

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

Per delega, usare:

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

Valori delle proprietà

microsoft.apimanagement/service/portalsettings

Nome Descrizione Valore
nome Impostare su "signin" per il tipo Microsoft.ApiManagement/service/portalsettings. Impostare su "iscrizione" per il tipo Microsoft.ApiManagement/service/portalsettings. Impostare su "delega" per il tipo Microsoft.ApiManagement/service/portalsettings. 'delega'
'signin'
'signup' (obbligatorio)

Microsoft.ApiManagement/service/portalsettings

Nome Descrizione Valore
nome Nome della risorsa 'signin' (obbligatorio)
genitore In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.		 Nome simbolico per la risorsa di tipo: servizio
proprietà Proprietà del contratto delle impostazioni di accesso. PortalSigninSettingProperties

Microsoft.ApiManagement/service/portalsettings

Nome Descrizione Valore
nome Nome della risorsa 'signup' (obbligatorio)
genitore In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.		 Nome simbolico per la risorsa di tipo: servizio
proprietà Proprietà del contratto delle impostazioni di iscrizione. PortalSignupSettingsProperties

Microsoft.ApiManagement/service/portalsettings

Nome Descrizione Valore
nome Nome della risorsa 'delega' (obbligatorio)
genitore In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.		 Nome simbolico per la risorsa di tipo: servizio
proprietà Proprietà del contratto delle impostazioni di delega. PortalDelegationSettingsProperties

PortalDelegationSettingsProperties

Nome Descrizione Valore
Sottoscrizioni Impostazioni di delega delle sottoscrizioni. SubscriptionsDelegationSettingsProperties
URL URL di delega. corda
userRegistration Impostazioni di delega della registrazione utente. RegistrationDelegationSettingsProperties
validationKey Chiave di convalida con codifica Base64 per convalidare che una richiesta proviene da Gestione API di Azure. corda

Vincoli:
Valore sensibile. Passare come parametro sicuro.

PortalSigninSettingProperties

Nome Descrizione Valore
Abilitato Reindirizzare gli utenti anonimi alla pagina Sign-In. Bool

PortalSignupSettingsProperties

Nome Descrizione Valore
Abilitato Consentire agli utenti di iscriversi a un portale per sviluppatori. Bool
termsOfService Condizioni per le proprietà del contratto di servizio. TermsOfServiceProperties

RegistrationDelegationSettingsProperties

Nome Descrizione Valore
Abilitato Abilitare o disabilitare la delega per la registrazione dell'utente. Bool

SubscriptionsDelegationSettingsProperties

Nome Descrizione Valore
Abilitato Abilitare o disabilitare la delega per le sottoscrizioni. Bool

TermsOfServiceProperties

Nome Descrizione Valore
consentRequired Chiedere all'utente il consenso alle condizioni per il servizio. Bool
Abilitato Visualizzare le condizioni per il servizio durante un processo di iscrizione. Bool
Testo Testo relativo alle condizioni per il servizio. corda

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa service/portalsettings può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.ApiManagement/service/portalsettings, aggiungere il codice JSON seguente al modello.

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

oggetti microsoft.apimanagement/service/portalsettings

Impostare la proprietà nome per specificare il tipo di oggetto.

Per accesso, usare:

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

Per di iscrizione, usare:

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

Per delega, usare:

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

Valori delle proprietà

microsoft.apimanagement/service/portalsettings

Nome Descrizione Valore
nome Impostare su "signin" per il tipo Microsoft.ApiManagement/service/portalsettings. Impostare su "iscrizione" per il tipo Microsoft.ApiManagement/service/portalsettings. Impostare su "delega" per il tipo Microsoft.ApiManagement/service/portalsettings. 'delega'
'signin'
'signup' (obbligatorio)

Microsoft.ApiManagement/service/portalsettings

Nome Descrizione Valore
apiVersion Versione dell'API '2021-12-01-preview'
nome Nome della risorsa 'signin' (obbligatorio)
proprietà Proprietà del contratto delle impostazioni di accesso. PortalSigninSettingProperties
digitare Tipo di risorsa 'Microsoft.ApiManagement/service/portalsettings'

Microsoft.ApiManagement/service/portalsettings

Nome Descrizione Valore
apiVersion Versione dell'API '2021-12-01-preview'
nome Nome della risorsa 'signup' (obbligatorio)
proprietà Proprietà del contratto delle impostazioni di iscrizione. PortalSignupSettingsProperties
digitare Tipo di risorsa 'Microsoft.ApiManagement/service/portalsettings'

Microsoft.ApiManagement/service/portalsettings

Nome Descrizione Valore
apiVersion Versione dell'API '2021-12-01-preview'
nome Nome della risorsa 'delega' (obbligatorio)
proprietà Proprietà del contratto delle impostazioni di delega. PortalDelegationSettingsProperties
digitare Tipo di risorsa 'Microsoft.ApiManagement/service/portalsettings'

PortalDelegationSettingsProperties

Nome Descrizione Valore
Sottoscrizioni Impostazioni di delega delle sottoscrizioni. SubscriptionsDelegationSettingsProperties
URL URL di delega. corda
userRegistration Impostazioni di delega della registrazione utente. RegistrationDelegationSettingsProperties
validationKey Chiave di convalida con codifica Base64 per convalidare che una richiesta proviene da Gestione API di Azure. corda

Vincoli:
Valore sensibile. Passare come parametro sicuro.

PortalSigninSettingProperties

Nome Descrizione Valore
Abilitato Reindirizzare gli utenti anonimi alla pagina Sign-In. Bool

PortalSignupSettingsProperties

Nome Descrizione Valore
Abilitato Consentire agli utenti di iscriversi a un portale per sviluppatori. Bool
termsOfService Condizioni per le proprietà del contratto di servizio. TermsOfServiceProperties

RegistrationDelegationSettingsProperties

Nome Descrizione Valore
Abilitato Abilitare o disabilitare la delega per la registrazione dell'utente. Bool

SubscriptionsDelegationSettingsProperties

Nome Descrizione Valore
Abilitato Abilitare o disabilitare la delega per le sottoscrizioni. Bool

TermsOfServiceProperties

Nome Descrizione Valore
consentRequired Chiedere all'utente il consenso alle condizioni per il servizio. Bool
Abilitato Visualizzare le condizioni per il servizio durante un processo di iscrizione. Bool
Testo Testo relativo alle condizioni per il servizio. corda

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa service/portalsettings può essere distribuito con operazioni destinate a:

  • gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.ApiManagement/service/portalsettings, aggiungere il comando Terraform seguente al modello.

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

oggetti microsoft.apimanagement/service/portalsettings

Impostare la proprietà nome per specificare il tipo di oggetto.

Per accesso, usare:

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

Per di iscrizione, usare:

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

Per delega, usare:

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

Valori delle proprietà

microsoft.apimanagement/service/portalsettings

Nome Descrizione Valore
nome Impostare su "signin" per il tipo Microsoft.ApiManagement/service/portalsettings. Impostare su "iscrizione" per il tipo Microsoft.ApiManagement/service/portalsettings. Impostare su "delega" per il tipo Microsoft.ApiManagement/service/portalsettings. 'delega'
'signin'
'signup' (obbligatorio)

Microsoft.ApiManagement/service/portalsettings

Nome Descrizione Valore
nome Nome della risorsa 'signin' (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: servizio
proprietà Proprietà del contratto delle impostazioni di accesso. PortalSigninSettingProperties
digitare Tipo di risorsa "Microsoft.ApiManagement/service/portalsettings@2021-12-01-preview"

Microsoft.ApiManagement/service/portalsettings

Nome Descrizione Valore
nome Nome della risorsa 'signup' (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: servizio
proprietà Proprietà del contratto delle impostazioni di iscrizione. PortalSignupSettingsProperties
digitare Tipo di risorsa "Microsoft.ApiManagement/service/portalsettings@2021-12-01-preview"

Microsoft.ApiManagement/service/portalsettings

Nome Descrizione Valore
nome Nome della risorsa 'delega' (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: servizio
proprietà Proprietà del contratto delle impostazioni di delega. PortalDelegationSettingsProperties
digitare Tipo di risorsa "Microsoft.ApiManagement/service/portalsettings@2021-12-01-preview"

PortalDelegationSettingsProperties

Nome Descrizione Valore
Sottoscrizioni Impostazioni di delega delle sottoscrizioni. SubscriptionsDelegationSettingsProperties
URL URL di delega. corda
userRegistration Impostazioni di delega della registrazione utente. RegistrationDelegationSettingsProperties
validationKey Chiave di convalida con codifica Base64 per convalidare che una richiesta proviene da Gestione API di Azure. corda

Vincoli:
Valore sensibile. Passare come parametro sicuro.

PortalSigninSettingProperties

Nome Descrizione Valore
Abilitato Reindirizzare gli utenti anonimi alla pagina Sign-In. Bool

PortalSignupSettingsProperties

Nome Descrizione Valore
Abilitato Consentire agli utenti di iscriversi a un portale per sviluppatori. Bool
termsOfService Condizioni per le proprietà del contratto di servizio. TermsOfServiceProperties

RegistrationDelegationSettingsProperties

Nome Descrizione Valore
Abilitato Abilitare o disabilitare la delega per la registrazione dell'utente. Bool

SubscriptionsDelegationSettingsProperties

Nome Descrizione Valore
Abilitato Abilitare o disabilitare la delega per le sottoscrizioni. Bool

TermsOfServiceProperties

Nome Descrizione Valore
consentRequired Chiedere all'utente il consenso alle condizioni per il servizio. Bool
Abilitato Visualizzare le condizioni per il servizio durante un processo di iscrizione. Bool
Testo Testo relativo alle condizioni per il servizio. corda