Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. networkservices
  5. AuthzExtension
Google Cloud v8.13.1 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.networkservices.AuthzExtension

Explore with Pulumi AI

gcp logo
Google Cloud v8.13.1 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-gcp

    AuthzExtension is a resource that allows traffic forwarding to a callout backend service to make an authorization decision.

    To get more information about AuthzExtension, see:

    Example Usage

    Network Services Authz Extension Basic

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const _default = new gcp.compute.RegionBackendService("default", {
    name: "authz-service",
    project: "my-project-name",
    region: "us-west1",
    protocol: "HTTP2",
    loadBalancingScheme: "INTERNAL_MANAGED",
    portName: "grpc",
});
const defaultAuthzExtension = new gcp.networkservices.AuthzExtension("default", {
    name: "my-authz-ext",
    project: "my-project-name",
    location: "us-west1",
    description: "my description",
    loadBalancingScheme: "INTERNAL_MANAGED",
    authority: "ext11.com",
    service: _default.selfLink,
    timeout: "0.1s",
    failOpen: false,
    forwardHeaders: ["Authorization"],
});

    import pulumi
import pulumi_gcp as gcp

default = gcp.compute.RegionBackendService("default",
    name="authz-service",
    project="my-project-name",
    region="us-west1",
    protocol="HTTP2",
    load_balancing_scheme="INTERNAL_MANAGED",
    port_name="grpc")
default_authz_extension = gcp.networkservices.AuthzExtension("default",
    name="my-authz-ext",
    project="my-project-name",
    location="us-west1",
    description="my description",
    load_balancing_scheme="INTERNAL_MANAGED",
    authority="ext11.com",
    service=default.self_link,
    timeout="0.1s",
    fail_open=False,
    forward_headers=["Authorization"])

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/networkservices"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewRegionBackendService(ctx, "default", &compute.RegionBackendServiceArgs{
			Name:                pulumi.String("authz-service"),
			Project:             pulumi.String("my-project-name"),
			Region:              pulumi.String("us-west1"),
			Protocol:            pulumi.String("HTTP2"),
			LoadBalancingScheme: pulumi.String("INTERNAL_MANAGED"),
			PortName:            pulumi.String("grpc"),
		})
		if err != nil {
			return err
		}
		_, err = networkservices.NewAuthzExtension(ctx, "default", &networkservices.AuthzExtensionArgs{
			Name:                pulumi.String("my-authz-ext"),
			Project:             pulumi.String("my-project-name"),
			Location:            pulumi.String("us-west1"),
			Description:         pulumi.String("my description"),
			LoadBalancingScheme: pulumi.String("INTERNAL_MANAGED"),
			Authority:           pulumi.String("ext11.com"),
			Service:             _default.SelfLink,
			Timeout:             pulumi.String("0.1s"),
			FailOpen:            pulumi.Bool(false),
			ForwardHeaders: pulumi.StringArray{
				pulumi.String("Authorization"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var @default = new Gcp.Compute.RegionBackendService("default", new()
    {
        Name = "authz-service",
        Project = "my-project-name",
        Region = "us-west1",
        Protocol = "HTTP2",
        LoadBalancingScheme = "INTERNAL_MANAGED",
        PortName = "grpc",
    });

    var defaultAuthzExtension = new Gcp.NetworkServices.AuthzExtension("default", new()
    {
        Name = "my-authz-ext",
        Project = "my-project-name",
        Location = "us-west1",
        Description = "my description",
        LoadBalancingScheme = "INTERNAL_MANAGED",
        Authority = "ext11.com",
        Service = @default.SelfLink,
        Timeout = "0.1s",
        FailOpen = false,
        ForwardHeaders = new[]
        {
            "Authorization",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.RegionBackendService;
import com.pulumi.gcp.compute.RegionBackendServiceArgs;
import com.pulumi.gcp.networkservices.AuthzExtension;
import com.pulumi.gcp.networkservices.AuthzExtensionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new RegionBackendService("default", RegionBackendServiceArgs.builder()
            .name("authz-service")
            .project("my-project-name")
            .region("us-west1")
            .protocol("HTTP2")
            .loadBalancingScheme("INTERNAL_MANAGED")
            .portName("grpc")
            .build());

        var defaultAuthzExtension = new AuthzExtension("defaultAuthzExtension", AuthzExtensionArgs.builder()
            .name("my-authz-ext")
            .project("my-project-name")
            .location("us-west1")
            .description("my description")
            .loadBalancingScheme("INTERNAL_MANAGED")
            .authority("ext11.com")
            .service(default_.selfLink())
            .timeout("0.1s")
            .failOpen(false)
            .forwardHeaders("Authorization")
            .build());

    }
}

    resources:
  default:
    type: gcp:compute:RegionBackendService
    properties:
      name: authz-service
      project: my-project-name
      region: us-west1
      protocol: HTTP2
      loadBalancingScheme: INTERNAL_MANAGED
      portName: grpc
  defaultAuthzExtension:
    type: gcp:networkservices:AuthzExtension
    name: default
    properties:
      name: my-authz-ext
      project: my-project-name
      location: us-west1
      description: my description
      loadBalancingScheme: INTERNAL_MANAGED
      authority: ext11.com
      service: ${default.selfLink}
      timeout: 0.1s
      failOpen: false
      forwardHeaders:
        - Authorization

    Create AuthzExtension Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AuthzExtension(name: string, args: AuthzExtensionArgs, opts?: CustomResourceOptions);
    @overload
def AuthzExtension(resource_name: str,
                   args: AuthzExtensionArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def AuthzExtension(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   load_balancing_scheme: Optional[str] = None,
                   timeout: Optional[str] = None,
                   service: Optional[str] = None,
                   authority: Optional[str] = None,
                   location: Optional[str] = None,
                   forward_headers: Optional[Sequence[str]] = None,
                   labels: Optional[Mapping[str, str]] = None,
                   metadata: Optional[Mapping[str, str]] = None,
                   name: Optional[str] = None,
                   project: Optional[str] = None,
                   fail_open: Optional[bool] = None,
                   description: Optional[str] = None,
                   wire_format: Optional[str] = None)
    func NewAuthzExtension(ctx *Context, name string, args AuthzExtensionArgs, opts ...ResourceOption) (*AuthzExtension, error)
    public AuthzExtension(string name, AuthzExtensionArgs args, CustomResourceOptions? opts = null)
    public AuthzExtension(String name, AuthzExtensionArgs args)
public AuthzExtension(String name, AuthzExtensionArgs args, CustomResourceOptions options)

    type: gcp:networkservices:AuthzExtension
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AuthzExtensionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AuthzExtensionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AuthzExtensionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthzExtensionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthzExtensionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var authzExtensionResource = new Gcp.NetworkServices.AuthzExtension("authzExtensionResource", new()
{
    LoadBalancingScheme = "string",
    Timeout = "string",
    Service = "string",
    Authority = "string",
    Location = "string",
    ForwardHeaders = new[]
    {
        "string",
    },
    Labels = 
    {
        { "string", "string" },
    },
    Metadata = 
    {
        { "string", "string" },
    },
    Name = "string",
    Project = "string",
    FailOpen = false,
    Description = "string",
    WireFormat = "string",
});

    example, err := networkservices.NewAuthzExtension(ctx, "authzExtensionResource", &networkservices.AuthzExtensionArgs{
	LoadBalancingScheme: pulumi.String("string"),
	Timeout:             pulumi.String("string"),
	Service:             pulumi.String("string"),
	Authority:           pulumi.String("string"),
	Location:            pulumi.String("string"),
	ForwardHeaders: pulumi.StringArray{
		pulumi.String("string"),
	},
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:        pulumi.String("string"),
	Project:     pulumi.String("string"),
	FailOpen:    pulumi.Bool(false),
	Description: pulumi.String("string"),
	WireFormat:  pulumi.String("string"),
})

    var authzExtensionResource = new AuthzExtension("authzExtensionResource", AuthzExtensionArgs.builder()
    .loadBalancingScheme("string")
    .timeout("string")
    .service("string")
    .authority("string")
    .location("string")
    .forwardHeaders("string")
    .labels(Map.of("string", "string"))
    .metadata(Map.of("string", "string"))
    .name("string")
    .project("string")
    .failOpen(false)
    .description("string")
    .wireFormat("string")
    .build());

    authz_extension_resource = gcp.networkservices.AuthzExtension("authzExtensionResource",
    load_balancing_scheme="string",
    timeout="string",
    service="string",
    authority="string",
    location="string",
    forward_headers=["string"],
    labels={
        "string": "string",
    },
    metadata={
        "string": "string",
    },
    name="string",
    project="string",
    fail_open=False,
    description="string",
    wire_format="string")

    const authzExtensionResource = new gcp.networkservices.AuthzExtension("authzExtensionResource", {
    loadBalancingScheme: "string",
    timeout: "string",
    service: "string",
    authority: "string",
    location: "string",
    forwardHeaders: ["string"],
    labels: {
        string: "string",
    },
    metadata: {
        string: "string",
    },
    name: "string",
    project: "string",
    failOpen: false,
    description: "string",
    wireFormat: "string",
});

    type: gcp:networkservices:AuthzExtension
properties:
    authority: string
    description: string
    failOpen: false
    forwardHeaders:
        - string
    labels:
        string: string
    loadBalancingScheme: string
    location: string
    metadata:
        string: string
    name: string
    project: string
    service: string
    timeout: string
    wireFormat: string

    AuthzExtension Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AuthzExtension resource accepts the following input properties:

    Authority string
    The :authority header in the gRPC request sent from Envoy to the extension service.
    LoadBalancingScheme string
    All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. For more information, refer to Backend services overview. Possible values are: INTERNAL_MANAGED, EXTERNAL_MANAGED.
    Location string
    The location of the resource.

    Service string
    The reference to the service that runs the extension. To configure a callout extension, service must be a fully-qualified reference to a backend service in the format: https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService} or https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}.
    Timeout string
    Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds.
    Description string
    A human-readable description of the resource.
    FailOpen bool
    Determines how the proxy behaves if the call to the extension fails or times out. When set to TRUE, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to FALSE or the default setting of FALSE is used, one of the following happens:

    • If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer.
    • If response headers have been delivered, then the HTTP stream to the downstream client is reset.
    ForwardHeaders List<string>
    List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name.
    Labels Dictionary<string, string>

    Set of labels associated with the AuthzExtension resource.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    Metadata Dictionary<string, string>
    The metadata provided here is included as part of the metadata_context (of type google.protobuf.Struct) in the ProcessingRequest message sent to the extension server. The metadata is available under the namespace com.google.authz_extension.. The following variables are supported in the metadata Struct: {forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name.
    Name string
    Identifier. Name of the AuthzExtension resource.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    WireFormat string
    The format of communication supported by the callout extension. Default value is EXT_PROC_GRPC. Possible values are: WIRE_FORMAT_UNSPECIFIED, EXT_PROC_GRPC.
    Authority string
    The :authority header in the gRPC request sent from Envoy to the extension service.
    LoadBalancingScheme string
    All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. For more information, refer to Backend services overview. Possible values are: INTERNAL_MANAGED, EXTERNAL_MANAGED.
    Location string
    The location of the resource.

    Service string
    The reference to the service that runs the extension. To configure a callout extension, service must be a fully-qualified reference to a backend service in the format: https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService} or https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}.
    Timeout string
    Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds.
    Description string
    A human-readable description of the resource.
    FailOpen bool
    Determines how the proxy behaves if the call to the extension fails or times out. When set to TRUE, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to FALSE or the default setting of FALSE is used, one of the following happens:

    • If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer.
    • If response headers have been delivered, then the HTTP stream to the downstream client is reset.
    ForwardHeaders []string
    List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name.
    Labels map[string]string

    Set of labels associated with the AuthzExtension resource.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    Metadata map[string]string
    The metadata provided here is included as part of the metadata_context (of type google.protobuf.Struct) in the ProcessingRequest message sent to the extension server. The metadata is available under the namespace com.google.authz_extension.. The following variables are supported in the metadata Struct: {forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name.
    Name string
    Identifier. Name of the AuthzExtension resource.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    WireFormat string
    The format of communication supported by the callout extension. Default value is EXT_PROC_GRPC. Possible values are: WIRE_FORMAT_UNSPECIFIED, EXT_PROC_GRPC.
    authority String
    The :authority header in the gRPC request sent from Envoy to the extension service.
    loadBalancingScheme String
    All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. For more information, refer to Backend services overview. Possible values are: INTERNAL_MANAGED, EXTERNAL_MANAGED.
    location String
    The location of the resource.

    service String
    The reference to the service that runs the extension. To configure a callout extension, service must be a fully-qualified reference to a backend service in the format: https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService} or https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}.
    timeout String
    Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds.
    description String
    A human-readable description of the resource.
    failOpen Boolean
    Determines how the proxy behaves if the call to the extension fails or times out. When set to TRUE, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to FALSE or the default setting of FALSE is used, one of the following happens:

    • If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer.
    • If response headers have been delivered, then the HTTP stream to the downstream client is reset.
    forwardHeaders List<String>
    List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name.
    labels Map<String,String>

    Set of labels associated with the AuthzExtension resource.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    metadata Map<String,String>
    The metadata provided here is included as part of the metadata_context (of type google.protobuf.Struct) in the ProcessingRequest message sent to the extension server. The metadata is available under the namespace com.google.authz_extension.. The following variables are supported in the metadata Struct: {forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name.
    name String
    Identifier. Name of the AuthzExtension resource.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    wireFormat String
    The format of communication supported by the callout extension. Default value is EXT_PROC_GRPC. Possible values are: WIRE_FORMAT_UNSPECIFIED, EXT_PROC_GRPC.
    authority string
    The :authority header in the gRPC request sent from Envoy to the extension service.
    loadBalancingScheme string
    All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. For more information, refer to Backend services overview. Possible values are: INTERNAL_MANAGED, EXTERNAL_MANAGED.
    location string
    The location of the resource.

    service string
    The reference to the service that runs the extension. To configure a callout extension, service must be a fully-qualified reference to a backend service in the format: https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService} or https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}.
    timeout string
    Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds.
    description string
    A human-readable description of the resource.
    failOpen boolean
    Determines how the proxy behaves if the call to the extension fails or times out. When set to TRUE, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to FALSE or the default setting of FALSE is used, one of the following happens:

    • If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer.
    • If response headers have been delivered, then the HTTP stream to the downstream client is reset.
    forwardHeaders string[]
    List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name.
    labels {[key: string]: string}

    Set of labels associated with the AuthzExtension resource.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    metadata {[key: string]: string}
    The metadata provided here is included as part of the metadata_context (of type google.protobuf.Struct) in the ProcessingRequest message sent to the extension server. The metadata is available under the namespace com.google.authz_extension.. The following variables are supported in the metadata Struct: {forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name.
    name string
    Identifier. Name of the AuthzExtension resource.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    wireFormat string
    The format of communication supported by the callout extension. Default value is EXT_PROC_GRPC. Possible values are: WIRE_FORMAT_UNSPECIFIED, EXT_PROC_GRPC.
    authority str
    The :authority header in the gRPC request sent from Envoy to the extension service.
    load_balancing_scheme str
    All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. For more information, refer to Backend services overview. Possible values are: INTERNAL_MANAGED, EXTERNAL_MANAGED.
    location str
    The location of the resource.

    service str
    The reference to the service that runs the extension. To configure a callout extension, service must be a fully-qualified reference to a backend service in the format: https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService} or https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}.
    timeout str
    Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds.
    description str
    A human-readable description of the resource.
    fail_open bool
    Determines how the proxy behaves if the call to the extension fails or times out. When set to TRUE, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to FALSE or the default setting of FALSE is used, one of the following happens:

    • If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer.
    • If response headers have been delivered, then the HTTP stream to the downstream client is reset.
    forward_headers Sequence[str]
    List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name.
    labels Mapping[str, str]

    Set of labels associated with the AuthzExtension resource.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    metadata Mapping[str, str]
    The metadata provided here is included as part of the metadata_context (of type google.protobuf.Struct) in the ProcessingRequest message sent to the extension server. The metadata is available under the namespace com.google.authz_extension.. The following variables are supported in the metadata Struct: {forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name.
    name str
    Identifier. Name of the AuthzExtension resource.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    wire_format str
    The format of communication supported by the callout extension. Default value is EXT_PROC_GRPC. Possible values are: WIRE_FORMAT_UNSPECIFIED, EXT_PROC_GRPC.
    authority String
    The :authority header in the gRPC request sent from Envoy to the extension service.
    loadBalancingScheme String
    All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. For more information, refer to Backend services overview. Possible values are: INTERNAL_MANAGED, EXTERNAL_MANAGED.
    location String
    The location of the resource.

    service String
    The reference to the service that runs the extension. To configure a callout extension, service must be a fully-qualified reference to a backend service in the format: https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService} or https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}.
    timeout String
    Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds.
    description String
    A human-readable description of the resource.
    failOpen Boolean
    Determines how the proxy behaves if the call to the extension fails or times out. When set to TRUE, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to FALSE or the default setting of FALSE is used, one of the following happens:

    • If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer.
    • If response headers have been delivered, then the HTTP stream to the downstream client is reset.
    forwardHeaders List<String>
    List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name.
    labels Map<String>

    Set of labels associated with the AuthzExtension resource.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    metadata Map<String>
    The metadata provided here is included as part of the metadata_context (of type google.protobuf.Struct) in the ProcessingRequest message sent to the extension server. The metadata is available under the namespace com.google.authz_extension.. The following variables are supported in the metadata Struct: {forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name.
    name String
    Identifier. Name of the AuthzExtension resource.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    wireFormat String
    The format of communication supported by the callout extension. Default value is EXT_PROC_GRPC. Possible values are: WIRE_FORMAT_UNSPECIFIED, EXT_PROC_GRPC.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AuthzExtension resource produces the following output properties:

    CreateTime string
    The timestamp when the resource was created.
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Id string
    The provider-assigned unique ID for this managed resource.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    UpdateTime string
    The timestamp when the resource was updated.
    CreateTime string
    The timestamp when the resource was created.
    EffectiveLabels map[string]string
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Id string
    The provider-assigned unique ID for this managed resource.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    UpdateTime string
    The timestamp when the resource was updated.
    createTime String
    The timestamp when the resource was created.
    effectiveLabels Map<String,String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id String
    The provider-assigned unique ID for this managed resource.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    updateTime String
    The timestamp when the resource was updated.
    createTime string
    The timestamp when the resource was created.
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id string
    The provider-assigned unique ID for this managed resource.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    updateTime string
    The timestamp when the resource was updated.
    create_time str
    The timestamp when the resource was created.
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id str
    The provider-assigned unique ID for this managed resource.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    update_time str
    The timestamp when the resource was updated.
    createTime String
    The timestamp when the resource was created.
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id String
    The provider-assigned unique ID for this managed resource.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    updateTime String
    The timestamp when the resource was updated.

    Look up Existing AuthzExtension Resource

    Get an existing AuthzExtension resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AuthzExtensionState, opts?: CustomResourceOptions): AuthzExtension
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authority: Optional[str] = None,
        create_time: Optional[str] = None,
        description: Optional[str] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        fail_open: Optional[bool] = None,
        forward_headers: Optional[Sequence[str]] = None,
        labels: Optional[Mapping[str, str]] = None,
        load_balancing_scheme: Optional[str] = None,
        location: Optional[str] = None,
        metadata: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        service: Optional[str] = None,
        timeout: Optional[str] = None,
        update_time: Optional[str] = None,
        wire_format: Optional[str] = None) -> AuthzExtension
    func GetAuthzExtension(ctx *Context, name string, id IDInput, state *AuthzExtensionState, opts ...ResourceOption) (*AuthzExtension, error)
    public static AuthzExtension Get(string name, Input<string> id, AuthzExtensionState? state, CustomResourceOptions? opts = null)
    public static AuthzExtension get(String name, Output<String> id, AuthzExtensionState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Authority string
    The :authority header in the gRPC request sent from Envoy to the extension service.
    CreateTime string
    The timestamp when the resource was created.
    Description string
    A human-readable description of the resource.
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    FailOpen bool
    Determines how the proxy behaves if the call to the extension fails or times out. When set to TRUE, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to FALSE or the default setting of FALSE is used, one of the following happens:

    • If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer.
    • If response headers have been delivered, then the HTTP stream to the downstream client is reset.
    ForwardHeaders List<string>
    List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name.
    Labels Dictionary<string, string>

    Set of labels associated with the AuthzExtension resource.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    LoadBalancingScheme string
    All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. For more information, refer to Backend services overview. Possible values are: INTERNAL_MANAGED, EXTERNAL_MANAGED.
    Location string
    The location of the resource.

    Metadata Dictionary<string, string>
    The metadata provided here is included as part of the metadata_context (of type google.protobuf.Struct) in the ProcessingRequest message sent to the extension server. The metadata is available under the namespace com.google.authz_extension.. The following variables are supported in the metadata Struct: {forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name.
    Name string
    Identifier. Name of the AuthzExtension resource.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Service string
    The reference to the service that runs the extension. To configure a callout extension, service must be a fully-qualified reference to a backend service in the format: https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService} or https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}.
    Timeout string
    Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds.
    UpdateTime string
    The timestamp when the resource was updated.
    WireFormat string
    The format of communication supported by the callout extension. Default value is EXT_PROC_GRPC. Possible values are: WIRE_FORMAT_UNSPECIFIED, EXT_PROC_GRPC.
    Authority string
    The :authority header in the gRPC request sent from Envoy to the extension service.
    CreateTime string
    The timestamp when the resource was created.
    Description string
    A human-readable description of the resource.
    EffectiveLabels map[string]string
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    FailOpen bool
    Determines how the proxy behaves if the call to the extension fails or times out. When set to TRUE, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to FALSE or the default setting of FALSE is used, one of the following happens:

    • If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer.
    • If response headers have been delivered, then the HTTP stream to the downstream client is reset.
    ForwardHeaders []string
    List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name.
    Labels map[string]string

    Set of labels associated with the AuthzExtension resource.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    LoadBalancingScheme string
    All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. For more information, refer to Backend services overview. Possible values are: INTERNAL_MANAGED, EXTERNAL_MANAGED.
    Location string
    The location of the resource.

    Metadata map[string]string
    The metadata provided here is included as part of the metadata_context (of type google.protobuf.Struct) in the ProcessingRequest message sent to the extension server. The metadata is available under the namespace com.google.authz_extension.. The following variables are supported in the metadata Struct: {forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name.
    Name string
    Identifier. Name of the AuthzExtension resource.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Service string
    The reference to the service that runs the extension. To configure a callout extension, service must be a fully-qualified reference to a backend service in the format: https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService} or https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}.
    Timeout string
    Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds.
    UpdateTime string
    The timestamp when the resource was updated.
    WireFormat string
    The format of communication supported by the callout extension. Default value is EXT_PROC_GRPC. Possible values are: WIRE_FORMAT_UNSPECIFIED, EXT_PROC_GRPC.
    authority String
    The :authority header in the gRPC request sent from Envoy to the extension service.
    createTime String
    The timestamp when the resource was created.
    description String
    A human-readable description of the resource.
    effectiveLabels Map<String,String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    failOpen Boolean
    Determines how the proxy behaves if the call to the extension fails or times out. When set to TRUE, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to FALSE or the default setting of FALSE is used, one of the following happens:

    • If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer.
    • If response headers have been delivered, then the HTTP stream to the downstream client is reset.
    forwardHeaders List<String>
    List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name.
    labels Map<String,String>

    Set of labels associated with the AuthzExtension resource.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    loadBalancingScheme String
    All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. For more information, refer to Backend services overview. Possible values are: INTERNAL_MANAGED, EXTERNAL_MANAGED.
    location String
    The location of the resource.

    metadata Map<String,String>
    The metadata provided here is included as part of the metadata_context (of type google.protobuf.Struct) in the ProcessingRequest message sent to the extension server. The metadata is available under the namespace com.google.authz_extension.. The following variables are supported in the metadata Struct: {forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name.
    name String
    Identifier. Name of the AuthzExtension resource.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    service String
    The reference to the service that runs the extension. To configure a callout extension, service must be a fully-qualified reference to a backend service in the format: https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService} or https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}.
    timeout String
    Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds.
    updateTime String
    The timestamp when the resource was updated.
    wireFormat String
    The format of communication supported by the callout extension. Default value is EXT_PROC_GRPC. Possible values are: WIRE_FORMAT_UNSPECIFIED, EXT_PROC_GRPC.
    authority string
    The :authority header in the gRPC request sent from Envoy to the extension service.
    createTime string
    The timestamp when the resource was created.
    description string
    A human-readable description of the resource.
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    failOpen boolean
    Determines how the proxy behaves if the call to the extension fails or times out. When set to TRUE, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to FALSE or the default setting of FALSE is used, one of the following happens:

    • If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer.
    • If response headers have been delivered, then the HTTP stream to the downstream client is reset.
    forwardHeaders string[]
    List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name.
    labels {[key: string]: string}

    Set of labels associated with the AuthzExtension resource.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    loadBalancingScheme string
    All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. For more information, refer to Backend services overview. Possible values are: INTERNAL_MANAGED, EXTERNAL_MANAGED.
    location string
    The location of the resource.

    metadata {[key: string]: string}
    The metadata provided here is included as part of the metadata_context (of type google.protobuf.Struct) in the ProcessingRequest message sent to the extension server. The metadata is available under the namespace com.google.authz_extension.. The following variables are supported in the metadata Struct: {forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name.
    name string
    Identifier. Name of the AuthzExtension resource.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    service string
    The reference to the service that runs the extension. To configure a callout extension, service must be a fully-qualified reference to a backend service in the format: https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService} or https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}.
    timeout string
    Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds.
    updateTime string
    The timestamp when the resource was updated.
    wireFormat string
    The format of communication supported by the callout extension. Default value is EXT_PROC_GRPC. Possible values are: WIRE_FORMAT_UNSPECIFIED, EXT_PROC_GRPC.
    authority str
    The :authority header in the gRPC request sent from Envoy to the extension service.
    create_time str
    The timestamp when the resource was created.
    description str
    A human-readable description of the resource.
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    fail_open bool
    Determines how the proxy behaves if the call to the extension fails or times out. When set to TRUE, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to FALSE or the default setting of FALSE is used, one of the following happens:

    • If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer.
    • If response headers have been delivered, then the HTTP stream to the downstream client is reset.
    forward_headers Sequence[str]
    List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name.
    labels Mapping[str, str]

    Set of labels associated with the AuthzExtension resource.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    load_balancing_scheme str
    All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. For more information, refer to Backend services overview. Possible values are: INTERNAL_MANAGED, EXTERNAL_MANAGED.
    location str
    The location of the resource.

    metadata Mapping[str, str]
    The metadata provided here is included as part of the metadata_context (of type google.protobuf.Struct) in the ProcessingRequest message sent to the extension server. The metadata is available under the namespace com.google.authz_extension.. The following variables are supported in the metadata Struct: {forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name.
    name str
    Identifier. Name of the AuthzExtension resource.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    service str
    The reference to the service that runs the extension. To configure a callout extension, service must be a fully-qualified reference to a backend service in the format: https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService} or https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}.
    timeout str
    Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds.
    update_time str
    The timestamp when the resource was updated.
    wire_format str
    The format of communication supported by the callout extension. Default value is EXT_PROC_GRPC. Possible values are: WIRE_FORMAT_UNSPECIFIED, EXT_PROC_GRPC.
    authority String
    The :authority header in the gRPC request sent from Envoy to the extension service.
    createTime String
    The timestamp when the resource was created.
    description String
    A human-readable description of the resource.
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    failOpen Boolean
    Determines how the proxy behaves if the call to the extension fails or times out. When set to TRUE, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to FALSE or the default setting of FALSE is used, one of the following happens:

    • If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer.
    • If response headers have been delivered, then the HTTP stream to the downstream client is reset.
    forwardHeaders List<String>
    List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name.
    labels Map<String>

    Set of labels associated with the AuthzExtension resource.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    loadBalancingScheme String
    All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. For more information, refer to Backend services overview. Possible values are: INTERNAL_MANAGED, EXTERNAL_MANAGED.
    location String
    The location of the resource.

    metadata Map<String>
    The metadata provided here is included as part of the metadata_context (of type google.protobuf.Struct) in the ProcessingRequest message sent to the extension server. The metadata is available under the namespace com.google.authz_extension.. The following variables are supported in the metadata Struct: {forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name.
    name String
    Identifier. Name of the AuthzExtension resource.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    service String
    The reference to the service that runs the extension. To configure a callout extension, service must be a fully-qualified reference to a backend service in the format: https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService} or https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}.
    timeout String
    Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds.
    updateTime String
    The timestamp when the resource was updated.
    wireFormat String
    The format of communication supported by the callout extension. Default value is EXT_PROC_GRPC. Possible values are: WIRE_FORMAT_UNSPECIFIED, EXT_PROC_GRPC.

    Import

    AuthzExtension can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/authzExtensions/{{name}}

    • {{project}}/{{location}}/{{name}}

    • {{location}}/{{name}}

    • {{name}}

    When using the pulumi import command, AuthzExtension can be imported using one of the formats above. For example:

    $ pulumi import gcp:networkservices/authzExtension:AuthzExtension default projects/{{project}}/locations/{{location}}/authzExtensions/{{name}}

    $ pulumi import gcp:networkservices/authzExtension:AuthzExtension default {{project}}/{{location}}/{{name}}

    $ pulumi import gcp:networkservices/authzExtension:AuthzExtension default {{location}}/{{name}}

    $ pulumi import gcp:networkservices/authzExtension:AuthzExtension default {{name}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v8.13.1 published on Friday, Jan 10, 2025 by Pulumi
    pulumi/pulumi-gcp