Przeczytaj w języku angielskim

Udostępnij za pośrednictwem

Microsoft.ApiManagement service/portalconfigs 2023-09-01-preview

  • Artykuł
Wybieranie języka wdrażania

Definicja zasobu Bicep

Typ zasobu service/portalconfigs można wdrożyć przy użyciu operacji docelowych:

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

resource symbolicname 'Microsoft.ApiManagement/service/portalconfigs@2023-09-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    cors: {
      allowedOrigins: [
        'string'
      ]
    }
    csp: {
      allowedSources: [
        'string'
      ]
      mode: 'string'
      reportUri: [
        'string'
      ]
    }
    delegation: {
      delegateRegistration: bool
      delegateSubscription: bool
      delegationUrl: 'string'
      validationKey: 'string'
    }
    enableBasicAuth: bool
    signin: {
      require: bool
    }
    signup: {
      termsOfService: {
        requireConsent: bool
        text: 'string'
      }
    }
  }
}

Wartości właściwości

Microsoft.ApiManagement/service/portalconfigs

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 80 (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 konfiguracji portalu dla deweloperów. PortalConfigProperties

PortalConfigCorsProperties

Nazwa Opis Wartość
allowedOrigins Dozwolone źródła, np. https://trusted.com. string[]

PortalConfigCspProperties

Nazwa Opis Wartość
allowedSources Dozwolone źródła, np. *.trusted.com, trusted.com, https://. string[]
tryb Tryb zasad zabezpieczeń zawartości portalu dla deweloperów (CSP). "wyłączone"
"włączone"
"reportOnly"
identyfikator reportUri Adresy URL używane przez przeglądarkę do zgłaszania naruszeń dostawcy CSP. string[]

PortalConfigDelegationProperties

Nazwa Opis Wartość
delegateRegistration Włącz lub wyłącz delegowanie na potrzeby rejestracji użytkownika. Bool
delegateSubscription Włączanie lub wyłączanie delegowania dla subskrypcji produktów. Bool
delegowanieUrl Adres URL punktu końcowego delegowania. struna
validationKey Klucz weryfikacji zakodowany w formacie base64 w celu zapewnienia, że żądania pochodzą z usługi Azure API Management. struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr.

PortalConfigProperties

Nazwa Opis Wartość
cors Ustawienia współużytkowania zasobów między źródłami (CORS) portalu dla deweloperów. PortalConfigCorsProperties
Csp Ustawienia zasad zabezpieczeń zawartości portalu dla deweloperów (CSP). PortalConfigCspProperties
delegacja Ustawienia delegowania portalu dla deweloperów. PortalConfigDelegationProperties
enableBasicAuth Włącz lub wyłącz metodę uwierzytelniania podstawowego. Bool
signin PortalConfigPropertiesSignin
rejestracja PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Nazwa Opis Wartość
wymagać Przekieruj użytkowników anonimowych na stronę logowania. Bool

PortalConfigPropertiesSignup

Nazwa Opis Wartość
termsOfService Ustawienia warunków użytkowania usługi. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Nazwa Opis Wartość
requireConsent Poproś użytkownika o zgodę na warunki użytkowania usługi. Bool
Tekst Warunki korzystania z tekstu usługi. struna

Definicja zasobu szablonu usługi ARM

Typ zasobu service/portalconfigs można wdrożyć przy użyciu operacji docelowych:

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

{
  "type": "Microsoft.ApiManagement/service/portalconfigs",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "cors": {
      "allowedOrigins": [ "string" ]
    },
    "csp": {
      "allowedSources": [ "string" ],
      "mode": "string",
      "reportUri": [ "string" ]
    },
    "delegation": {
      "delegateRegistration": "bool",
      "delegateSubscription": "bool",
      "delegationUrl": "string",
      "validationKey": "string"
    },
    "enableBasicAuth": "bool",
    "signin": {
      "require": "bool"
    },
    "signup": {
      "termsOfService": {
        "requireConsent": "bool",
        "text": "string"
      }
    }
  }
}

Wartości właściwości

Microsoft.ApiManagement/service/portalconfigs

Nazwa Opis Wartość
apiVersion Wersja interfejsu API "2023-09-01-preview"
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 80 (wymagane)
Właściwości Właściwości kontraktu konfiguracji portalu dla deweloperów. PortalConfigProperties
typ Typ zasobu "Microsoft.ApiManagement/service/portalconfigs"

PortalConfigCorsProperties

Nazwa Opis Wartość
allowedOrigins Dozwolone źródła, np. https://trusted.com. string[]

PortalConfigCspProperties

Nazwa Opis Wartość
allowedSources Dozwolone źródła, np. *.trusted.com, trusted.com, https://. string[]
tryb Tryb zasad zabezpieczeń zawartości portalu dla deweloperów (CSP). "wyłączone"
"włączone"
"reportOnly"
identyfikator reportUri Adresy URL używane przez przeglądarkę do zgłaszania naruszeń dostawcy CSP. string[]

PortalConfigDelegationProperties

Nazwa Opis Wartość
delegateRegistration Włącz lub wyłącz delegowanie na potrzeby rejestracji użytkownika. Bool
delegateSubscription Włączanie lub wyłączanie delegowania dla subskrypcji produktów. Bool
delegowanieUrl Adres URL punktu końcowego delegowania. struna
validationKey Klucz weryfikacji zakodowany w formacie base64 w celu zapewnienia, że żądania pochodzą z usługi Azure API Management. struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr.

PortalConfigProperties

Nazwa Opis Wartość
cors Ustawienia współużytkowania zasobów między źródłami (CORS) portalu dla deweloperów. PortalConfigCorsProperties
Csp Ustawienia zasad zabezpieczeń zawartości portalu dla deweloperów (CSP). PortalConfigCspProperties
delegacja Ustawienia delegowania portalu dla deweloperów. PortalConfigDelegationProperties
enableBasicAuth Włącz lub wyłącz metodę uwierzytelniania podstawowego. Bool
signin PortalConfigPropertiesSignin
rejestracja PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Nazwa Opis Wartość
wymagać Przekieruj użytkowników anonimowych na stronę logowania. Bool

PortalConfigPropertiesSignup

Nazwa Opis Wartość
termsOfService Ustawienia warunków użytkowania usługi. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Nazwa Opis Wartość
requireConsent Poproś użytkownika o zgodę na warunki użytkowania usługi. Bool
Tekst Warunki korzystania z tekstu usługi. struna

Przykłady użycia

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/portalconfigs@2023-09-01-preview"
  name = "string"
  body = {
    properties = {
      cors = {
        allowedOrigins = [
          "string"
        ]
      }
      csp = {
        allowedSources = [
          "string"
        ]
        mode = "string"
        reportUri = [
          "string"
        ]
      }
      delegation = {
        delegateRegistration = bool
        delegateSubscription = bool
        delegationUrl = "string"
        validationKey = "string"
      }
      enableBasicAuth = bool
      signin = {
        require = bool
      }
      signup = {
        termsOfService = {
          requireConsent = bool
          text = "string"
        }
      }
    }
  }
}

Wartości właściwości

Microsoft.ApiManagement/service/portalconfigs

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 80 (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 konfiguracji portalu dla deweloperów. PortalConfigProperties
typ Typ zasobu "Microsoft.ApiManagement/service/portalconfigs@2023-09-01-preview"

PortalConfigCorsProperties

Nazwa Opis Wartość
allowedOrigins Dozwolone źródła, np. https://trusted.com. string[]

PortalConfigCspProperties

Nazwa Opis Wartość
allowedSources Dozwolone źródła, np. *.trusted.com, trusted.com, https://. string[]
tryb Tryb zasad zabezpieczeń zawartości portalu dla deweloperów (CSP). "wyłączone"
"włączone"
"reportOnly"
identyfikator reportUri Adresy URL używane przez przeglądarkę do zgłaszania naruszeń dostawcy CSP. string[]

PortalConfigDelegationProperties

Nazwa Opis Wartość
delegateRegistration Włącz lub wyłącz delegowanie na potrzeby rejestracji użytkownika. Bool
delegateSubscription Włączanie lub wyłączanie delegowania dla subskrypcji produktów. Bool
delegowanieUrl Adres URL punktu końcowego delegowania. struna
validationKey Klucz weryfikacji zakodowany w formacie base64 w celu zapewnienia, że żądania pochodzą z usługi Azure API Management. struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr.

PortalConfigProperties

Nazwa Opis Wartość
cors Ustawienia współużytkowania zasobów między źródłami (CORS) portalu dla deweloperów. PortalConfigCorsProperties
Csp Ustawienia zasad zabezpieczeń zawartości portalu dla deweloperów (CSP). PortalConfigCspProperties
delegacja Ustawienia delegowania portalu dla deweloperów. PortalConfigDelegationProperties
enableBasicAuth Włącz lub wyłącz metodę uwierzytelniania podstawowego. Bool
signin PortalConfigPropertiesSignin
rejestracja PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Nazwa Opis Wartość
wymagać Przekieruj użytkowników anonimowych na stronę logowania. Bool

PortalConfigPropertiesSignup

Nazwa Opis Wartość
termsOfService Ustawienia warunków użytkowania usługi. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Nazwa Opis Wartość
requireConsent Poproś użytkownika o zgodę na warunki użytkowania usługi. Bool
Tekst Warunki korzystania z tekstu usługi. struna