Dela via


API-specifikation för Application Gateway för containrar för Kubernetes

Paket

Package v1 är v1-versionen av API:et.

alb.networking.azure.io/v1

Det här dokumentet definierar var och en av resurstyperna för alb.networking.azure.io/v1.

Resurstyper:

AffinityType (string alias)

(Visas på:SessionAffinity)

AffinityType definierar tillhörighetstypen för tjänsten

Värde beskrivning

"application-cookie"

AffinityTypeApplicationCookie är en sessionstillhörighetstyp för en programcookie

"managed-cookie"

AffinityTypeManagedCookie är en sessionstillhörighetstyp för en hanterad cookie

AlbConditionReason (string alias)

AlbConditionReason definierar en uppsättning orsaker som förklarar varför en viss villkorstyp genereras av Resursen Application Gateway för containrar.

Värde beskrivning

"Accepterad"

AlbReasonAccepted anger att Application Gateway for Containers-resursen godkänns av kontrollanten.

Ready (Redo)

AlbReasonDeploymentReady anger resursdistributionsstatus för Application Gateway for Containers.

"InProgress"

AlbReasonInProgress anger om Application Gateway for Containers-resursen håller på att skapas, uppdateras eller tas bort.

AlbConditionType (string alias)

AlbConditionType är en typ av villkor som är associerat med en Application Gateway for Containers-resurs. Den här typen ska användas med fältet AlbStatus.Conditions.

Värde beskrivning

"Accepterad"

AlbConditionTypeAccepted anger om Application Gateway for Containers-resursen godkänns av kontrollanten.

"Distribution"

AlbConditionTypeDeployment anger distributionsstatusen för resursen Application Gateway for Containers.

AlbSpec

(Visas på:ApplicationLoadBalancer)

AlbSpec definierar specifikationerna för resursen Application Gateway for Containers.

Fält beskrivning
associations
[]sträng

Associationer är undernätsresurs-ID:t som Application Gateway for Containers-resursen är associerad med.

AlbStatus

(Visas på:ApplicationLoadBalancer)

AlbStatus definierar det observerade tillståndet för Application Gateway for Containers-resursen.

Fält beskrivning
conditions
[]Kubernetes meta/v1. Tillstånd
(Valfritt)

Kända villkorstyper är:

  • “Accepterad”
  • “Klar”

ApplicationLoadBalancer

ApplicationLoadBalancer är schemat för resursen Application Gateway for Containers.

Fält beskrivning
metadata
Kubernetes meta/v1. ObjectMeta
(Valfritt)

Objekts’metadata.

Se Kubernetes API-dokumentationen för fälten i metadata fältet.
spec
AlbSpec

Specifikationen är specifikationerna för Application Gateway for Containers-resursen.



associations
[]sträng

Associationer är undernätsresurs-ID:t som Application Gateway for Containers-resursen är associerad med.

status
AlbStatus

Status definierar det aktuella tillståndet för Application Gateway for Containers-resursen.

BackendLastbalanseringspolicy

BackendLoadBalancingPolicy representerar konfigurationen för belastningsutjämning för serverdelen.

Fält beskrivning
metadata
Kubernetes meta/v1. ObjectMeta
(Valfritt)

Objekts’metadata.

Se Kubernetes API-dokumentationen för fälten i metadata fältet.
spec
BackendLoadBalancingPolicySpec

Spec är BackendLoadBalancingPolicy-specifikationen.



targetRefs
[]TargetRefSpec

TargetRefs identifierar en lista över API-objekt som principen ska tillämpas på.

loadBalancing
LoadBalancingConfig
(Valfritt)

LoadBalancing definierar schemat för att konfigurera alternativ för belastningsutjämning

status
BackendLoadBalancingPolicyStatus

Status definierar det aktuella tillståndet för BackendLoadBalancingPolicy.

BackendbelastningsutjämningspolicyVillkorOrsak (string alias)

BackendLoadBalancingPolicyConditionReason definierar en uppsättning orsaker som förklarar varför en viss typ av BackendLoadBalancingPolicy-villkor har genererats.

Värde beskrivning

"Accepterad"

BackendLoadBalancingPolicyReasonAccepted används för att ange BackendLoadBalancingPolicyConditionReason till Godkänd när den angivna BackendLoadBalancingPolicy är korrekt konfigurerad

Konfliktfylld

BackendLoadBalancingPolicyReasonConflicted används när målreferensen står i konflikt med ett redan existerande policymål

OgiltigBackendLastbalanseringspolicy

BackendLoadBalancingPolicyReasonInvalid är orsaken till att BackendLoadBalancingPolicy’inte accepteras

"InvalidGroup"

BackendLoadBalancingPolicyReasonInvalidGroup används när gruppen är ogiltig

"InvalidKind"

BackendLoadBalancingPolicyReasonInvalidKind används när en typ eller en grupp är ogiltig

"InvalidName"

BackendLoadBalancingPolicyReasonInvalidName används när namnet är ogiltigt

"InvalidService"

BackendLoadBalancingPolicyReasonInvalidService används när tjänsten är ogiltig

"NoTargetReference"

BackendLoadBalancingPolicyReasonNoTargetReference används när det inte finns’någon målreferens

"RefNotPermitted"

BackendLoadBalancingPolicyReasonRefNotPermitted används när referensen inte tillåts’

"ResolvedRefs"

BackendLoadBalancingPolicyReasonResolvedRefs används för att ange BackendLoadBalancingPolicyConditionReason till ResolvedRefs när den angivna BackendLoadBalancingPolicy har rätt referenser

BackendLastbalanseringsPolicyVillkorTyp (string alias)

BackendLoadBalancingPolicyConditionType är en typ av villkor som är associerat med en BackendLoadBalancingPolicy. Den här typen ska användas med fältet BackendLoadBalancingPolicyStatus.Conditions.

Värde beskrivning

"Accepterad"

BackendLoadBalancingPolicyConditionAccepted används för att ange BackendLoadBalancingPolicyConditionType till Godkänd

"ResolvedRefs"

BackendLoadBalancingPolicyConditionResolvedRefs används för att ange BackendLoadBalancingPolicyCondition till ResolvedRefs

BackendLoadBalancingPolicyPort

(Visas på:TargetRefSpec)

BackendLoadBalancingPolicyPort definierar portkonfigurationen för serverdelsbelastningsutjämningsprincipen.

Fält beskrivning
port
int32

Port är den port som ska användas för anslutning till serverdelen

BackendLoadBalancingPolicySpec

(Visas på:BackendLoadBalancingPolicy, IngressBackendSettings)

BackendLoadBalancingPolicySpec definierar specifikationen för BackendLoadBalancingPolicy.

Fält beskrivning
targetRefs
[]TargetRefSpec

TargetRefs identifierar en lista över API-objekt som principen ska tillämpas på.

loadBalancing
LoadBalancingConfig
(Valfritt)

LoadBalancing definierar schemat för att konfigurera alternativ för belastningsutjämning

StatusFörBackendLastbalanseringspolicy

(Visas på:BackendLoadBalancingPolicy)

BackendLoadBalancingPolicyStatus definierar det observerade tillståndet för BackendLoadBalancingPolicy.

Fält beskrivning
targets
[]BackendLoadBalancingPolicyTargetStatus

StatusFörMålFörLastbalanseringspolicyPåBackend

(Visas på:BackendLoadBalancingPolicyStatus)

BackendLoadBalancingPolicyTargetStatus definierar den observerade statusen för en mål ref

Fält beskrivning
targetRef
CustomTargetRef
conditions
[]Kubernetes meta/v1. Tillstånd

BackendTLSPolicy

BackendTLSPolicy är schemat för Api:et BackendTLSPolicies.

Fält beskrivning
metadata
Kubernetes meta/v1. ObjectMeta
(Valfritt)

Objekts’metadata.

Se Kubernetes API-dokumentationen för fälten i metadata fältet.
spec
BackendTLSPolicySpec

Specifikationen är BackendTLSPolicy-specifikationen.



targetRef
CustomTargetRef

TargetRef identifierar ett API-objekt som principen ska tillämpas på.

override
BackendTLSPolicyConfig
(Valfritt)

Åsidosättning definierar principkonfiguration som ska åsidosätta principkonfigurationen som är kopplad under målresursen i hierarkin.

Obs! Åsidosättning stöds inte för närvarande och resulterar i ett valideringsfel. Stöd för åsidosättning läggs till i en framtida version.

default
BackendTLSPolicyConfig
(Valfritt)

Standard definierar standardprincipkonfigurationen för målresursen.

status
BackendTLSPolicyStatus

Status definierar det aktuella tillståndet för BackendTLSPolicy.

BackendTLSPolicyConfig

(Visas på:BackendTLSPolicySpec)

BackendTLSPolicyConfig definierar principspecifikationen för serverdels-TLS-principen.

Fält beskrivning
CommonTLSPolicy
CommonTLSPolicy

(Medlemmar i CommonTLSPolicy är inbäddade i den här typen.)

sni
sträng
(Valfritt)

Sni är det servernamn som ska användas för TLS-anslutningen till serverdelen.

ports
[]BackendTLSPolicyPort

Portar anger listan över portar där principen tillämpas.

clientCertificateRef
Gateway-API . SecretObjectReference
(Valfritt)

ClientCertificateRef är referensen till klientcertifikatet som ska användas för TLS-anslutningen till serverdelen.

BackendTLSPolicyPort

(Visas på:BackendTLSPolicyConfig)

BackendTLSPolicyPort definierar porten som ska användas för TLS-anslutningen till serverdelen

Fält beskrivning
port
Int

Port är porten som ska användas för TLS-anslutningen till serverdelen

BackendTLSPolicySpec

(Visas på:BackendTLSPolicy)

BackendTLSPolicySpec definierar önskat tillstånd för BackendTLSPolicy.

Fält beskrivning
targetRef
CustomTargetRef

TargetRef identifierar ett API-objekt som principen ska tillämpas på.

override
BackendTLSPolicyConfig
(Valfritt)

Åsidosättning definierar principkonfiguration som ska åsidosätta principkonfigurationen som är kopplad under målresursen i hierarkin.

Obs! Åsidosättning stöds inte för närvarande och resulterar i ett valideringsfel. Stöd för åsidosättning läggs till i en framtida version.

default
BackendTLSPolicyConfig
(Valfritt)

Standard definierar standardprincipkonfigurationen för målresursen.

BackendTLSPolicyStatus

(Visas på:BackendTLSPolicy)

BackendTLSPolicyStatus definierar det observerade tillståndet backendTLSPolicy.

Fält beskrivning
conditions
[]Kubernetes meta/v1. Tillstånd
(Valfritt)

Villkor beskriver de aktuella villkoren för BackendTLSPolicy.

Implementeringar bör föredra att uttrycka BackendTLSPolicy-villkor med hjälp av BackendTLSPolicyConditionType konstanterna och BackendTLSPolicyConditionReason så att operatorer och verktyg kan konvergera i ett gemensamt ordförråd för att beskriva BackendTLSPolicy-tillstånd.

Kända villkorstyper är:

  • “Accepterad”
  • “ResolvedRefs”

CommonTLSPolicy

(Visas på:BackendTLSPolicyConfig)

CommonTLSPolicy är schemat för CommonTLSPolicy-API:et.

Fält beskrivning
verify
CommonTLSPolicyVerify
(Valfritt)

Verifiera innehåller alternativ för att verifiera peer-certifikatet.

CommonTLSPolicyVerify

(Visas på:CommonTLSPolicy)

CommonTLSPolicyVerify definierar schemat för CommonTLSPolicyVerify-API:et.

Fält beskrivning
caCertificateRef
Gateway-API . SecretObjectReference

CaCertificateRef är certifikatutfärdarcertifikatet som används för att verifiera peer-certifikatet.

subjectAltName
sträng
(Valfritt)

SubjectAltName är det alternativa ämnesnamnet som används för att verifiera peer-certifikatet.

CustomTargetRef

(Visas på:BackendLoadBalancingPolicyTargetStatus, BackendTLSPolicySpec, FrontendTLSPolicySpec, HealthCheckPolicySpec, PolicyRefStatus, RoutePolicySpec, TargetRefSpec, WebApplicationFirewallPolicySpec)

CustomTargetRef är en referens till en anpassad resurs som inte ingår’i Kubernetes-kärn-API:et.

Fält beskrivning
NamespacedPolicyTargetReference
Gateway-API:et alpha2. NamespacedPolicyTargetReference

(Medlemmar i NamespacedPolicyTargetReference är inbäddade i den här typen.)

sectionNames
[]sträng
(Valfritt)

SectionNames är namnet på avsnittet i målresursen. När den är ospecificerad riktar sig denna targetRef mot hela resursen. I följande resurser tolkas SectionNames som följande:

  • Gateway: Lyssnarnamn
  • Tjänst: Portnamn

Om ett SectionNames har angetts, men’inte finns på målobjektet, kan principen inte kopplas och principimplementeringen registrerar ett ResolvedRefs eller liknande villkor i principens’status.

FrontendTLSPolicy

FrontendTLSPolicy är schemat för Api:et FrontendTLSPolicy

Fält beskrivning
metadata
Kubernetes meta/v1. ObjectMeta
(Valfritt)

Objekts’metadata.

Se Kubernetes API-dokumentationen för fälten i metadata fältet.
spec
FrontendTLSPolicySpec

Specifikationen är FrontendTLSPolicy-specifikationen.



targetRef
CustomTargetRef

TargetRef identifierar ett API-objekt som principen ska tillämpas på.

default
FrontendTLSPolicyConfig
(Valfritt)

Standard definierar standardprincipkonfigurationen för målresursen.

override
FrontendTLSPolicyConfig
(Valfritt)

Åsidosättning definierar principkonfiguration som ska åsidosätta principkonfigurationen som är kopplad under målresursen i hierarkin.

Obs! Åsidosättning stöds inte för närvarande och resulterar i ett valideringsfel. Stöd för åsidosättning läggs till i en framtida version.

status
FrontendTLSPolicyStatus

Status definierar det aktuella tillståndet för FrontendTLSPolicy.

FrontendTLSPolicyConfig

(Visas på:FrontendTLSPolicySpec)

FrontendTLSPolicyConfig definierar principspecifikationen för klientdels-TLS-principen.

Fält beskrivning
verify
MTLSPolicyVerify
(Valfritt)

Verifiera innehåller alternativ för att verifiera peer-certifikatet.

policyType
PolicyType
(Valfritt)

Typ är principens typ.

FrontendTLSPolicySpec

(Visas på:FrontendTLSPolicy)

FrontendTLSPolicySpec definierar önskat tillstånd för FrontendTLSPolicy

Fält beskrivning
targetRef
CustomTargetRef

TargetRef identifierar ett API-objekt som principen ska tillämpas på.

default
FrontendTLSPolicyConfig
(Valfritt)

Standard definierar standardprincipkonfigurationen för målresursen.

override
FrontendTLSPolicyConfig
(Valfritt)

Åsidosättning definierar principkonfiguration som ska åsidosätta principkonfigurationen som är kopplad under målresursen i hierarkin.

Obs! Åsidosättning stöds inte för närvarande och resulterar i ett valideringsfel. Stöd för åsidosättning läggs till i en framtida version.

FrontendTLSPolicyStatus

(Visas på:FrontendTLSPolicy)

FrontendTLSPolicyStatus definierar det observerade tillståndet för FrontendTLSPolicy.

Fält beskrivning
conditions
[]Kubernetes meta/v1. Tillstånd
(Valfritt)

Villkor beskriver de aktuella villkoren för FrontendTLSPolicy.

Implementeringar bör föredra att uttrycka FrontendTLSPolicy-villkor med hjälp av FrontendTLSPolicyConditionType konstanterna och FrontendTLSPolicyConditionReason så att operatorer och verktyg kan konvergera i ett gemensamt ordförråd för att beskriva FrontendTLSPolicy-tillstånd.

Kända villkorstyper är:

  • “Accepterad”

FrontendTLSPolicyType (string alias)

(Visas på:PolicyType)

FrontendTLSPolicyType är typen av klientdels-TLS-princip.

Värde beskrivning

"fördefinierad"

PredefinedFrontendTLSPolicyType är typen av den fördefinierade TLS-principen för klientdelen.

FrontendTLSPolicyTypeName (string alias)

(Visas på:PolicyType)

FrontendTLSPolicyTypeName är namnet på klientdelens TLS-princip.

Värde beskrivning

"2023-06"

PredefinedPolicy202306 är namnet på den fördefinierade klientdels-TLS-principen för principen “2023-06”.

"2023-06-S"

PredefinedPolicy202306Strict är namnet på den fördefinierade klientdels-TLS-principen för principen “2023-06-S”. Detta är en strikt version av policyn “2023-06”.

GRPCSpecifiers

(Visas på:HealthCheckPolicyConfig)

GRPCSpecifiers definierar schemat för GRPC HealthCheck.

Fält beskrivning
authority
sträng
(Valfritt)

Utfärdare om den finns används som värdet för utfärdarhuvudet i hälsokontrollen.

service
sträng
(Valfritt)

Tjänsten tillåter konfiguration av en hälsokontroll som registrerats under ett annat tjänstnamn.

HTTPHeader

(Visas på:HeaderFilter)

HTTPHeader representerar ett HTTP-huvudnamn och -värde enligt definitionen i RFC 7230.

Fält beskrivning
name
HTTPHeaderName

Namnet är namnet på HTTP-huvudet som ska matchas. Namnmatchning MÅSTE vara skiftlägesokänsligt. (Se https://tools.ietf.org/html/rfc7230#section-3.2).

Om flera poster anger motsvarande rubriknamn måste den första posten med motsvarande namn beaktas för en matchning. Efterföljande poster med motsvarande rubriknamn MÅSTE ignoreras. På grund av skiftlägeskänsligheten för rubriknamn “anses foo” och “Foo” vara likvärdiga.

value
sträng

Värdet är värdet för HTTP-huvudet som ska matchas.

HTTPHeaderName (string alias)

(Visas på:HTTPHeader)

HTTPHeaderName är namnet på ett HTTP-huvud.

Giltiga värden:

  • “Auktorisering”
  • “Set-Cookie”

Ogiltiga värden är:

  • ”:method” – “:” är ett ogiltigt tecken. Det innebär att HTTP/2 pseudohuvuden’för närvarande inte stöds av den här typen.
  • ”/invalid” - “/ ” är ett ogiltigt tecken

HTTPMatch

(Visas på:HTTPSpecifierare)

HTTPMatch definierar de HTTP-matchare som ska användas för HealthCheck-kontroller.

Fält beskrivning
body
sträng
(Valfritt)

Brödtext definierar HTTP-brödtextmatchare som ska användas för HealthCheck-kontroller.

statusCodes
[]StatusCodes
(Valfritt)

StatusCodes definierar HTTP-statuskoden matchare som ska användas för HealthCheck-kontroller.

HTTPPathModifier

(Visas på:Redirect, URLRewriteFilter)

HTTPPathModifier definierar konfiguration för sökvägsmodifierare.

Fält beskrivning
type
HTTPPathModifierType

Typ definierar typen av sökvägsmodifierare. Fler typer kan läggas till i en framtida version av API:et.

Värden kan läggas till i den här uppräkningen, implementeringar måste se till att okända värden’inte orsakar en krasch.

Okända värden här måste resultera i implementeringsinställningen Godkända villkor för att regeln ska vara false

replaceFullPath
sträng
(Valfritt)

ReplaceFullPath anger det värde som du vill ersätta den fullständiga sökvägen för en begäran med under en omskrivning eller omdirigering.

replacePrefixMatch
sträng
(Valfritt)

ReplacePrefixMatch anger det värde som prefixmatchningen för en begäran ska ersättas med under en omskrivning eller omdirigering. En begäran till “/foo/bar” med prefixmatchningen “/foo” och ReplacePrefixMatch för “/xyz” ändras till “/xyz/bar”.

Detta matchar beteendet för PathPrefix-matchningstypen. Detta matchar fullständiga sökvägselement. Ett sökvägselement refererar till listan över etiketter i sökvägen som delas av / avgränsaren. När det anges ignoreras en avslutande / . Sökvägarna /abc, /abc/och /abc/def skulle till exempel matcha prefixet /abc, men sökvägen /abcd skulle’inte göra det.

ReplacePrefixMatch är endast kompatibelt med en PathPrefix HTTPRouteMatch. Om du använder någon annan HTTPRouteMatch-typ på samma HTTPRouteRule resulterar det i implementeringsinställningen Godkända villkor för vägen till status: False.

Sökväg för begäran Prefixmatchning Ersätt prefix Ändrad sökväg
/foo/bar /Foo /Xyz /xyz/bar
/foo/bar /Foo /Xyz/ /xyz/bar
/foo/bar /Foo/ /Xyz /xyz/bar
/foo/bar /Foo/ /Xyz/ /xyz/bar
/Foo /Foo /Xyz /Xyz
/Foo/ /Foo /Xyz /Xyz/
/foo/bar /Foo