Microsoft.AppPlatform Spring/gateways 2022-05-01-preview

  • Artikel

Bicep-resursdefinition

Resurstypen Spring/gateways kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.AppPlatform/Spring/gateways-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.AppPlatform/Spring/gateways@2022-05-01-preview' = {
  name: 'string'
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  parent: resourceSymbolicName
  properties: {
    apiMetadataProperties: {
      description: 'string'
      documentation: 'string'
      serverUrl: 'string'
      title: 'string'
      version: 'string'
    }
    corsProperties: {
      allowCredentials: bool
      allowedHeaders: [
        'string'
      ]
      allowedMethods: [
        'string'
      ]
      allowedOrigins: [
        'string'
      ]
      exposedHeaders: [
        'string'
      ]
      maxAge: int
    }
    httpsOnly: bool
    public: bool
    resourceRequests: {
      cpu: 'string'
      memory: 'string'
    }
    ssoProperties: {
      clientId: 'string'
      clientSecret: 'string'
      issuerUri: 'string'
      scope: [
        'string'
      ]
    }
  }
}

Egenskapsvärden

Spring/gateways

Name Beskrivning Värde
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i Bicep.		 sträng (krävs)
sku SKU för Spring Cloud Gateway-resursen Sku
parent I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför överordnad resurs.		 Symboliskt namn för resurs av typen: Spring
properties Nyttolast för Spring Cloud Gateway-egenskaper GatewayEgenskaper

GatewayEgenskaper

Name Beskrivning Värde
apiMetadataEgenskaper API-metadataegenskap för Spring Cloud Gateway GatewayApiMetadataEgenskaper
corsProperties Resursdelningsegenskap för korsande ursprung GatewayCorsEgenskaper
httpsOnly Ange om endast https tillåts. boolesk
offentligt Anger om Spring Cloud Gateway exponerar slutpunkten. boolesk
resourceRequests Den begärda resurskvantiteten för nödvändig processor och minne. GatewayResourceRequests
ssoEgenskaper Konfiguration med enkel inloggning Egenskaper för enkel inloggning

GatewayApiMetadataEgenskaper

Name Beskrivning Värde
beskrivning Detaljerad beskrivning av de API:er som är tillgängliga på gatewayinstansen (standard: Generated OpenAPI 3 document that describes the API routes configured.) sträng
documentation (dokumentation) Plats för ytterligare dokumentation för DE API:er som är tillgängliga på Gateway-instansen sträng
serverUrl Bas-URL som API-konsumenter använder för att komma åt API:er på gatewayinstansen. sträng
title Rubrik som beskriver kontexten för de API:er som är tillgängliga på gatewayinstansen (standard: Spring Cloud Gateway for K8S) sträng
version Version av API:er som är tillgängliga på den här Gateway-instansen (standard: unspecified). sträng

GatewayCorsEgenskaper

Name Beskrivning Värde
allowCredentials Om användarautentiseringsuppgifter stöds för begäranden mellan webbplatser. Giltiga värden: true, false. boolesk
allowedHeaders Tillåtna rubriker i begäranden mellan webbplatser. Med specialvärdet * kan faktiska begäranden skicka valfritt sidhuvud. string[]
allowedMethods Tillåtna HTTP-metoder för begäranden mellan webbplatser. Specialvärdet * tillåter alla metoder. Om inte anges GET och HEAD tillåts som standard. string[]
allowedOrigins Tillåtna ursprung för att göra begäranden mellan webbplatser. Specialvärdet * tillåter alla domäner. string[]
exposedHeaders HTTP-svarshuvuden som ska exponeras för begäranden mellan webbplatser. string[]
maxAge Hur länge, i sekunder, kan svaret från en begäran före flygningen cachelagras av klienter. int

GatewayResourceRequests

Name Beskrivning Värde
Cpu Cpu allokerad till varje Spring Cloud Gateway-instans. sträng
minne Minne allokerat till varje Spring Cloud Gateway-instans. sträng

Egenskaper för enkel inloggning

Name Beskrivning Värde
ClientID Den offentliga identifieraren för programmet sträng
clientSecret Hemligheten som endast är känd för programmet och auktoriseringsservern sträng
issuerUri URI för utfärdaridentifierare sträng
omfång Den definierar de specifika åtgärder som program kan utföra för en användares räkning string[]

Sku

Name Beskrivning Värde
capacity Aktuell kapacitet för målresursen int
name Namn på SKU:n sträng
nivå Nivå för SKU:n sträng

Resursdefinition för ARM-mall

Resurstypen Spring/gateways kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.AppPlatform/Spring/gateways-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.AppPlatform/Spring/gateways",
  "apiVersion": "2022-05-01-preview",
  "name": "string",
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "properties": {
    "apiMetadataProperties": {
      "description": "string",
      "documentation": "string",
      "serverUrl": "string",
      "title": "string",
      "version": "string"
    },
    "corsProperties": {
      "allowCredentials": "bool",
      "allowedHeaders": [ "string" ],
      "allowedMethods": [ "string" ],
      "allowedOrigins": [ "string" ],
      "exposedHeaders": [ "string" ],
      "maxAge": "int"
    },
    "httpsOnly": "bool",
    "public": "bool",
    "resourceRequests": {
      "cpu": "string",
      "memory": "string"
    },
    "ssoProperties": {
      "clientId": "string",
      "clientSecret": "string",
      "issuerUri": "string",
      "scope": [ "string" ]
    }
  }
}

Egenskapsvärden

Spring/gateways

Name Beskrivning Värde
typ Resurstypen "Microsoft.AppPlatform/Spring/gateways"
apiVersion Resurs-API-versionen "2022-05-01-preview"
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar.		 sträng (krävs)
sku SKU för Spring Cloud Gateway-resursen Sku
properties Nyttolast för Spring Cloud Gateway-egenskaper GatewayEgenskaper

GatewayEgenskaper

Name Beskrivning Värde
apiMetadataEgenskaper API-metadataegenskap för Spring Cloud Gateway GatewayApiMetadataEgenskaper
corsProperties Resursdelningsegenskap för korsande ursprung GatewayCorsEgenskaper
httpsOnly Ange om endast https tillåts. boolesk
offentligt Anger om Spring Cloud Gateway exponerar slutpunkten. boolesk
resourceRequests Den begärda resurskvantiteten för nödvändig processor och minne. GatewayResourceRequests
ssoEgenskaper Konfiguration med enkel inloggning Egenskaper för enkel inloggning

GatewayApiMetadataEgenskaper

Name Beskrivning Värde
beskrivning Detaljerad beskrivning av de API:er som är tillgängliga på gatewayinstansen (standard: Generated OpenAPI 3 document that describes the API routes configured.) sträng
documentation (dokumentation) Plats för ytterligare dokumentation för DE API:er som är tillgängliga på gatewayinstansen sträng
serverUrl Bas-URL som API-konsumenter använder för att få åtkomst till API:er på gatewayinstansen. sträng
title Rubrik som beskriver kontexten för de API:er som är tillgängliga på gatewayinstansen (standard: Spring Cloud Gateway for K8S) sträng
version Version av API:er som är tillgängliga på den här gatewayinstansen (standard: unspecified). sträng

GatewayCorsProperties

Name Beskrivning Värde
allowCredentials Om användarautentiseringsuppgifter stöds för begäranden mellan webbplatser. Giltiga värden: true, false. boolesk
allowedHeaders Tillåtna rubriker i begäranden mellan webbplatser. Med specialvärdet * kan faktiska begäranden skicka valfritt sidhuvud. string[]
allowedMethods Tillåtna HTTP-metoder för begäranden mellan webbplatser. Det särskilda värdet * tillåter alla metoder. Om det inte anges GET tillåts och HEAD som standard. string[]
allowedOrigins Tillåtna ursprung för att göra begäranden mellan webbplatser. Det särskilda värdet * tillåter alla domäner. string[]
exposedHeaders HTTP-svarshuvuden som ska exponeras för begäranden mellan webbplatser. string[]
maxAge Hur länge, i sekunder, kan svaret från en begäran före förhandsversion cachelagras av klienter. int

GatewayResourceRequests

Name Beskrivning Värde
Cpu Processorn allokeras till varje Spring Cloud Gateway-instans. sträng
minne Minne allokerat till varje Spring Cloud Gateway-instans. sträng

SsoProperties

Name Beskrivning Värde
ClientID Den offentliga identifieraren för programmet sträng
clientSecret Hemligheten som endast är känd för programmet och auktoriseringsservern sträng
issuerUri URI för utfärdaridentifierare sträng
omfång Den definierar de specifika åtgärder som program kan tillåtas utföra för en användares räkning string[]

Sku

Name Beskrivning Värde
capacity Målresursens aktuella kapacitet int
name Namnet på SKU:n sträng
nivå Nivå för SKU:n sträng

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen Spring/gateways kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Resurs för Microsoft.AppPlatform/Spring/gateways lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AppPlatform/Spring/gateways@2022-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      apiMetadataProperties = {
        description = "string"
        documentation = "string"
        serverUrl = "string"
        title = "string"
        version = "string"
      }
      corsProperties = {
        allowCredentials = bool
        allowedHeaders = [
          "string"
        ]
        allowedMethods = [
          "string"
        ]
        allowedOrigins = [
          "string"
        ]
        exposedHeaders = [
          "string"
        ]
        maxAge = int
      }
      httpsOnly = bool
      public = bool
      resourceRequests = {
        cpu = "string"
        memory = "string"
      }
      ssoProperties = {
        clientId = "string"
        clientSecret = "string"
        issuerUri = "string"
        scope = [
          "string"
        ]
      }
    }
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
  })
}

Egenskapsvärden

Spring/gateways

Name Beskrivning Värde
typ Resurstypen "Microsoft.AppPlatform/Spring/gateways@2022-05-01-preview"
name Resursnamnet sträng (krävs)
parent_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: Spring
sku SKU för Spring Cloud Gateway-resursen Sku
properties Nyttolast för Spring Cloud Gateway-egenskaper GatewayEgenskaper

GatewayEgenskaper

Name Beskrivning Värde
apiMetadataProperties API-metadataegenskap för Spring Cloud Gateway GatewayApiMetadataProperties
corsProperties Resursdelningsegenskap för korsande ursprung GatewayCorsProperties
httpsOnly Ange om endast https tillåts. boolesk
offentligt Anger om Spring Cloud Gateway exponerar slutpunkten. boolesk
resourceRequests Den begärda resurskvantiteten för nödvändig processor och minne. GatewayResourceRequests
ssoProperties Konfiguration relaterad till enkel inloggning SsoProperties

GatewayApiMetadataProperties

Name Beskrivning Värde
beskrivning Detaljerad beskrivning av de API:er som är tillgängliga på gatewayinstansen (standard: Generated OpenAPI 3 document that describes the API routes configured.) sträng
documentation (dokumentation) Plats för ytterligare dokumentation för DE API:er som är tillgängliga på gatewayinstansen sträng
serverUrl Bas-URL som API-konsumenter använder för att få åtkomst till API:er på gatewayinstansen. sträng
title Rubrik som beskriver kontexten för de API:er som är tillgängliga på gatewayinstansen (standard: Spring Cloud Gateway for K8S) sträng
version Version av API:er som är tillgängliga på den här gatewayinstansen (standard: unspecified). sträng

GatewayCorsProperties

Name Beskrivning Värde
allowCredentials Om användarautentiseringsuppgifter stöds för begäranden mellan webbplatser. Giltiga värden: true, false. boolesk
allowedHeaders Tillåtna rubriker i begäranden mellan webbplatser. Med specialvärdet * kan faktiska begäranden skicka valfritt sidhuvud. string[]
allowedMethods Tillåtna HTTP-metoder för begäranden mellan webbplatser. Det särskilda värdet * tillåter alla metoder. Om det inte anges GET tillåts och HEAD som standard. string[]
allowedOrigins Tillåtna ursprung för att göra begäranden mellan webbplatser. Det särskilda värdet * tillåter alla domäner. string[]
exposedHeaders HTTP-svarshuvuden som ska exponeras för begäranden mellan webbplatser. string[]
maxAge Hur länge, i sekunder, kan svaret från en begäran före förhandsversion cachelagras av klienter. int

GatewayResourceRequests

Name Beskrivning Värde
Cpu Processorn allokeras till varje Spring Cloud Gateway-instans. sträng
minne Minne allokerat till varje Spring Cloud Gateway-instans. sträng

SsoProperties

Name Beskrivning Värde
ClientID Den offentliga identifieraren för programmet sträng
clientSecret Hemligheten som endast är känd för programmet och auktoriseringsservern sträng
issuerUri URI för utfärdaridentifierare sträng
omfång Den definierar de specifika åtgärder som program kan tillåtas utföra för en användares räkning string[]

Sku

Name Beskrivning Värde
capacity Målresursens aktuella kapacitet int
name Namnet på SKU:n sträng
nivå Nivå för SKU:n sträng