Dela via

Microsoft.AppPlatform Spring/gateways 2023-03-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@2023-03-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    apiMetadataProperties: {
      description: 'string'
      documentation: 'string'
      serverUrl: 'string'
      title: 'string'
      version: 'string'
    }
    apmTypes: [
      'string'
    ]
    clientAuth: {
      certificates: [
        'string'
      ]
      certificateVerification: 'string'
    }
    corsProperties: {
      allowCredentials: bool
      allowedHeaders: [
        'string'
      ]
      allowedMethods: [
        'string'
      ]
      allowedOrigins: [
        'string'
      ]
      exposedHeaders: [
        'string'
      ]
      maxAge: int
    }
    environmentVariables: {
      properties: {
        {customized property}: 'string'
      }
      secrets: {
        {customized property}: 'string'
      }
    }
    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

GatewayApiMetadataEgenskaper

Namn 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
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 komma åt API:er på gatewayinstansen. sträng
titel 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

GatewayCorsProperties

Namn Beskrivning Värde
allowCredentials Om användarautentiseringsuppgifter stöds för begäranden mellan webbplatser. Giltiga värden: true, false. Bool
allowedHeaders Tillåtna rubriker i begäranden mellan webbplatser. Det särskilda värdet * tillåter att faktiska begäranden skickar valfritt huvud. string[]
allowedMethods Tillåtna HTTP-metoder på begäranden mellan webbplatser. Specialvärdet * tillåter alla metoder. Om det inte anges tillåts GET och HEAD 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 flygning cachelagras av klienter. Int

GatewayEgenskaper

Namn Beskrivning Värde
apiMetadataEgenskaper API-metadataegenskap för Spring Cloud Gateway GatewayApiMetadataEgenskaper
apmTypes Samling av APM-typ som används i Spring Cloud Gateway Strängmatris som innehåller något av:
"AppDynamics"
"ApplicationInsights"
"Dynatrace"
"ElasticAPM"
"NewRelic"
clientAuth Client-Certification autentisering. GatewayPropertiesClientAuth
corsProperties Resursdelningsegenskap för korsande ursprung GatewayCorsProperties
environmentVariables Miljövariabler för Spring Cloud Gateway GatewayPropertiesEnvironmentVariables
httpsOnly Ange om endast https tillåts. Bool
offentlig Anger om Spring Cloud Gateway exponerar slutpunkten. Bool
resourceRequests Den begärda resurskvantiteten för nödvändig processor och minne. GatewayResourceRequests
ssoProperties Konfiguration med enkel inloggning SsoProperties

GatewayPropertiesClientAuth

Namn Beskrivning Värde
certifikaten Samling certifikatresurs-ID:er i Azure Spring Apps. string[]
certificateVerification Om certifikatverifiering ska aktiveras eller inte "Inaktiverad"
"Aktiverad"

GatewayPropertiesEnvironmentVariables

Namn Beskrivning Värde
Egenskaper Icke-känsliga egenskaper GatewayPropertiesEnvironmentVariablesProperties
Hemligheter Känsliga egenskaper GatewayPropertiesEnvironmentVariablesSecrets

GatewayPropertiesEnvironmentVariablesProperties

Namn Beskrivning Värde

GatewayPropertiesEnvironmentVariablesSecrets

Namn Beskrivning Värde

GatewayResourceRequests

Namn Beskrivning Värde
processor Cpu allokerad till varje Spring Cloud Gateway-instans. sträng
minne Minne som allokerats till varje Spring Cloud Gateway-instans. sträng

Microsoft.AppPlatform/Spring/gateways

Namn Beskrivning Värde
Namn Resursnamnet sträng

Begränsningar:
Mönster = ^[a-z][a-z0-9]*$ (krävs)
förälder 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 den överordnade resursen.		 Symboliskt namn för resurs av typen: Spring
Egenskaper Nyttolast för Spring Cloud Gateway-egenskaper GatewayEgenskaper
Sku SKU för Spring Cloud Gateway-resursen Sku

Sku

Namn Beskrivning Värde
kapacitet Målresursens aktuella kapacitet Int
Namn SKU:ns namn sträng
Nivå Nivå för SKU:n sträng

SsoProperties

Namn 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
omfattning Den definierar de specifika åtgärder som program kan tillåtas utföra för en användares räkning string[]

Användningsexempel

Azure-snabbstartsexempel

Följande Azure-snabbstartsmallar innehålla Bicep-exempel för distribution av den här resurstypen.

Bicep-fil Beskrivning
Distribuera ett enkelt Azure Spring Apps-mikrotjänstprogram Den här mallen distribuerar ett enkelt Azure Spring Apps-mikrotjänstprogram som ska köras i Azure.

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": "2023-03-01-preview",
  "name": "string",
  "properties": {
    "apiMetadataProperties": {
      "description": "string",
      "documentation": "string",
      "serverUrl": "string",
      "title": "string",
      "version": "string"
    },
    "apmTypes": [ "string" ],
    "clientAuth": {
      "certificates": [ "string" ],
      "certificateVerification": "string"
    },
    "corsProperties": {
      "allowCredentials": "bool",
      "allowedHeaders": [ "string" ],
      "allowedMethods": [ "string" ],
      "allowedOrigins": [ "string" ],
      "exposedHeaders": [ "string" ],
      "maxAge": "int"
    },
    "environmentVariables": {
      "properties": {
        "{customized property}": "string"
      },
      "secrets": {
        "{customized property}": "string"
      }
    },
    "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

GatewayApiMetadataEgenskaper

Namn 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
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 komma åt API:er på gatewayinstansen. sträng
titel 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

GatewayCorsProperties

Namn Beskrivning Värde
allowCredentials Om användarautentiseringsuppgifter stöds för begäranden mellan webbplatser. Giltiga värden: true, false. Bool
allowedHeaders Tillåtna rubriker i begäranden mellan webbplatser. Det särskilda värdet * tillåter att faktiska begäranden skickar valfritt huvud. string[]
allowedMethods Tillåtna HTTP-metoder på begäranden mellan webbplatser. Specialvärdet * tillåter alla metoder. Om det inte anges tillåts GET och HEAD 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 flygning cachelagras av klienter. Int

GatewayEgenskaper

Namn Beskrivning Värde
apiMetadataEgenskaper API-metadataegenskap för Spring Cloud Gateway GatewayApiMetadataEgenskaper
apmTypes Samling av APM-typ som används i Spring Cloud Gateway Strängmatris som innehåller något av:
"AppDynamics"
"ApplicationInsights"
"Dynatrace"
"ElasticAPM"
"NewRelic"
clientAuth Client-Certification autentisering. GatewayPropertiesClientAuth
corsProperties Resursdelningsegenskap för korsande ursprung GatewayCorsProperties
environmentVariables Miljövariabler för Spring Cloud Gateway GatewayPropertiesEnvironmentVariables
httpsOnly Ange om endast https tillåts. Bool
offentlig Anger om Spring Cloud Gateway exponerar slutpunkten. Bool
resourceRequests Den begärda resurskvantiteten för nödvändig processor och minne. GatewayResourceRequests
ssoProperties Konfiguration med enkel inloggning SsoProperties

GatewayPropertiesClientAuth

Namn Beskrivning Värde
certifikaten Samling certifikatresurs-ID:er i Azure Spring Apps. string[]
certificateVerification Om certifikatverifiering ska aktiveras eller inte "Inaktiverad"
"Aktiverad"

GatewayPropertiesEnvironmentVariables

Namn Beskrivning Värde
Egenskaper Icke-känsliga egenskaper GatewayPropertiesEnvironmentVariablesProperties
Hemligheter Känsliga egenskaper GatewayPropertiesEnvironmentVariablesSecrets

GatewayPropertiesEnvironmentVariablesProperties

Namn Beskrivning Värde

GatewayPropertiesEnvironmentVariablesSecrets

Namn Beskrivning Värde

GatewayResourceRequests

Namn Beskrivning Värde
processor Cpu allokerad till varje Spring Cloud Gateway-instans. sträng
minne Minne som allokerats till varje Spring Cloud Gateway-instans. sträng

Microsoft.AppPlatform/Spring/gateways

Namn Beskrivning Värde
apiVersion API-versionen "2023-03-01-preview"
Namn Resursnamnet sträng

Begränsningar:
Mönster = ^[a-z][a-z0-9]*$ (krävs)
Egenskaper Nyttolast för Spring Cloud Gateway-egenskaper GatewayEgenskaper
Sku SKU för Spring Cloud Gateway-resursen Sku
typ Resurstypen "Microsoft.AppPlatform/Spring/gateways"

Sku

Namn Beskrivning Värde
kapacitet Målresursens aktuella kapacitet Int
Namn SKU:ns namn sträng
Nivå Nivå för SKU:n sträng

SsoProperties

Namn 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
omfattning Den definierar de specifika åtgärder som program kan tillåtas utföra för en användares räkning string[]

Användningsexempel

Azure-snabbstartsmallar

Följande Azure-snabbstartsmallar distribuera den här resurstypen.

Mall Beskrivning
Distribuera ett enkelt Azure Spring Apps-mikrotjänstprogram

Distribuera till Azure 		Den här mallen distribuerar ett enkelt Azure Spring Apps-mikrotjänstprogram som ska köras i Azure.

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 Microsoft.AppPlatform/Spring/gateways-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AppPlatform/Spring/gateways@2023-03-01-preview"
  name = "string"
  body = {
    properties = {
      apiMetadataProperties = {
        description = "string"
        documentation = "string"
        serverUrl = "string"
        title = "string"
        version = "string"
      }
      apmTypes = [
        "string"
      ]
      clientAuth = {
        certificates = [
          "string"
        ]
        certificateVerification = "string"
      }
      corsProperties = {
        allowCredentials = bool
        allowedHeaders = [
          "string"
        ]
        allowedMethods = [
          "string"
        ]
        allowedOrigins = [
          "string"
        ]
        exposedHeaders = [
          "string"
        ]
        maxAge = int
      }
      environmentVariables = {
        properties = {
          {customized property} = "string"
        }
        secrets = {
          {customized property} = "string"
        }
      }
      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

GatewayApiMetadataEgenskaper

Namn 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
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 komma åt API:er på gatewayinstansen. sträng
titel 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

GatewayCorsProperties

Namn Beskrivning Värde
allowCredentials Om användarautentiseringsuppgifter stöds för begäranden mellan webbplatser. Giltiga värden: true, false. Bool
allowedHeaders Tillåtna rubriker i begäranden mellan webbplatser. Det särskilda värdet * tillåter att faktiska begäranden skickar valfritt huvud. string[]
allowedMethods Tillåtna HTTP-metoder på begäranden mellan webbplatser. Specialvärdet * tillåter alla metoder. Om det inte anges tillåts GET och HEAD 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 flygning cachelagras av klienter. Int

GatewayEgenskaper

Namn Beskrivning Värde
apiMetadataEgenskaper API-metadataegenskap för Spring Cloud Gateway GatewayApiMetadataEgenskaper
apmTypes Samling av APM-typ som används i Spring Cloud Gateway Strängmatris som innehåller något av:
"AppDynamics"
"ApplicationInsights"
"Dynatrace"
"ElasticAPM"
"NewRelic"
clientAuth Client-Certification autentisering. GatewayPropertiesClientAuth
corsProperties Resursdelningsegenskap för korsande ursprung GatewayCorsProperties
environmentVariables Miljövariabler för Spring Cloud Gateway GatewayPropertiesEnvironmentVariables
httpsOnly Ange om endast https tillåts. Bool
offentlig Anger om Spring Cloud Gateway exponerar slutpunkten. Bool
resourceRequests Den begärda resurskvantiteten för nödvändig processor och minne. GatewayResourceRequests
ssoProperties Konfiguration med enkel inloggning SsoProperties

GatewayPropertiesClientAuth

Namn Beskrivning Värde
certifikaten Samling certifikatresurs-ID:er i Azure Spring Apps. string[]
certificateVerification Om certifikatverifiering ska aktiveras eller inte "Inaktiverad"
"Aktiverad"

GatewayPropertiesEnvironmentVariables

Namn Beskrivning Värde
Egenskaper Icke-känsliga egenskaper GatewayPropertiesEnvironmentVariablesProperties
Hemligheter Känsliga egenskaper GatewayPropertiesEnvironmentVariablesSecrets

GatewayPropertiesEnvironmentVariablesProperties

Namn Beskrivning Värde

GatewayPropertiesEnvironmentVariablesSecrets

Namn Beskrivning Värde

GatewayResourceRequests

Namn Beskrivning Värde
processor Cpu allokerad till varje Spring Cloud Gateway-instans. sträng
minne Minne som allokerats till varje Spring Cloud Gateway-instans. sträng

Microsoft.AppPlatform/Spring/gateways

Namn Beskrivning Värde
Namn Resursnamnet sträng

Begränsningar:
Mönster = ^[a-z][a-z0-9]*$ (krävs)
parent_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: Spring
Egenskaper Nyttolast för Spring Cloud Gateway-egenskaper GatewayEgenskaper
Sku SKU för Spring Cloud Gateway-resursen Sku
typ Resurstypen "Microsoft.AppPlatform/Spring/gateways@2023-03-01-preview"

Sku

Namn Beskrivning Värde
kapacitet Målresursens aktuella kapacitet Int
Namn SKU:ns namn sträng
Nivå Nivå för SKU:n sträng

SsoProperties

Namn 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
omfattning Den definierar de specifika åtgärder som program kan tillåtas utföra för en användares räkning string[]