Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. monitoring
  5. getIstioCanonicalService
Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.monitoring.getIstioCanonicalService

Explore with Pulumi AI

Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-gcp

A Monitoring Service is the root resource under which operational aspects of a generic service are accessible. A service is some discrete, autonomous, and network-accessible unit, designed to solve an individual concern

A monitoring Istio Canonical Service is automatically created by GCP to monitor Istio Canonical Services.

To get more information about Service, see:

Example Usage

Monitoring Istio Canonical Service

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

// Monitors the default MeshIstio service
const _default = gcp.monitoring.getIstioCanonicalService({
    meshUid: "proj-573164786102",
    canonicalServiceNamespace: "istio-system",
    canonicalService: "prometheus",
});
Copy
import pulumi
import pulumi_gcp as gcp

# Monitors the default MeshIstio service
default = gcp.monitoring.get_istio_canonical_service(mesh_uid="proj-573164786102",
    canonical_service_namespace="istio-system",
    canonical_service="prometheus")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Monitors the default MeshIstio service
		_, err := monitoring.GetIstioCanonicalService(ctx, &monitoring.GetIstioCanonicalServiceArgs{
			MeshUid:                   "proj-573164786102",
			CanonicalServiceNamespace: "istio-system",
			CanonicalService:          "prometheus",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    // Monitors the default MeshIstio service
    var @default = Gcp.Monitoring.GetIstioCanonicalService.Invoke(new()
    {
        MeshUid = "proj-573164786102",
        CanonicalServiceNamespace = "istio-system",
        CanonicalService = "prometheus",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.monitoring.MonitoringFunctions;
import com.pulumi.gcp.monitoring.inputs.GetIstioCanonicalServiceArgs;
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) {
        // Monitors the default MeshIstio service
        final var default = MonitoringFunctions.getIstioCanonicalService(GetIstioCanonicalServiceArgs.builder()
            .meshUid("proj-573164786102")
            .canonicalServiceNamespace("istio-system")
            .canonicalService("prometheus")
            .build());

    }
}
Copy
variables:
  # Monitors the default MeshIstio service
  default:
    fn::invoke:
      function: gcp:monitoring:getIstioCanonicalService
      arguments:
        meshUid: proj-573164786102
        canonicalServiceNamespace: istio-system
        canonicalService: prometheus
Copy

Using getIstioCanonicalService

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getIstioCanonicalService(args: GetIstioCanonicalServiceArgs, opts?: InvokeOptions): Promise<GetIstioCanonicalServiceResult>
function getIstioCanonicalServiceOutput(args: GetIstioCanonicalServiceOutputArgs, opts?: InvokeOptions): Output<GetIstioCanonicalServiceResult>
Copy
def get_istio_canonical_service(canonical_service: Optional[str] = None,
                                canonical_service_namespace: Optional[str] = None,
                                mesh_uid: Optional[str] = None,
                                project: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetIstioCanonicalServiceResult
def get_istio_canonical_service_output(canonical_service: Optional[pulumi.Input[str]] = None,
                                canonical_service_namespace: Optional[pulumi.Input[str]] = None,
                                mesh_uid: Optional[pulumi.Input[str]] = None,
                                project: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetIstioCanonicalServiceResult]
Copy
func GetIstioCanonicalService(ctx *Context, args *GetIstioCanonicalServiceArgs, opts ...InvokeOption) (*GetIstioCanonicalServiceResult, error)
func GetIstioCanonicalServiceOutput(ctx *Context, args *GetIstioCanonicalServiceOutputArgs, opts ...InvokeOption) GetIstioCanonicalServiceResultOutput
Copy

> Note: This function is named GetIstioCanonicalService in the Go SDK.

public static class GetIstioCanonicalService 
{
    public static Task<GetIstioCanonicalServiceResult> InvokeAsync(GetIstioCanonicalServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetIstioCanonicalServiceResult> Invoke(GetIstioCanonicalServiceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIstioCanonicalServiceResult> getIstioCanonicalService(GetIstioCanonicalServiceArgs args, InvokeOptions options)
public static Output<GetIstioCanonicalServiceResult> getIstioCanonicalService(GetIstioCanonicalServiceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: gcp:monitoring/getIstioCanonicalService:getIstioCanonicalService
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CanonicalService This property is required. string

The name of the canonical service underlying this service. Corresponds to the destination_canonical_service_name metric label in label in Istio metrics.

Other optional fields include:

CanonicalServiceNamespace This property is required. string
The namespace of the canonical service underlying this service. Corresponds to the destination_canonical_service_namespace metric label in Istio metrics.
MeshUid This property is required. string
Identifier for the mesh in which this Istio service is defined. Corresponds to the meshUid metric label in Istio metrics.
Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
CanonicalService This property is required. string

The name of the canonical service underlying this service. Corresponds to the destination_canonical_service_name metric label in label in Istio metrics.

Other optional fields include:

CanonicalServiceNamespace This property is required. string
The namespace of the canonical service underlying this service. Corresponds to the destination_canonical_service_namespace metric label in Istio metrics.
MeshUid This property is required. string
Identifier for the mesh in which this Istio service is defined. Corresponds to the meshUid metric label in Istio metrics.
Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
canonicalService This property is required. String

The name of the canonical service underlying this service. Corresponds to the destination_canonical_service_name metric label in label in Istio metrics.

Other optional fields include:

canonicalServiceNamespace This property is required. String
The namespace of the canonical service underlying this service. Corresponds to the destination_canonical_service_namespace metric label in Istio metrics.
meshUid This property is required. String
Identifier for the mesh in which this Istio service is defined. Corresponds to the meshUid metric label in Istio metrics.
project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
canonicalService This property is required. string

The name of the canonical service underlying this service. Corresponds to the destination_canonical_service_name metric label in label in Istio metrics.

Other optional fields include:

canonicalServiceNamespace This property is required. string
The namespace of the canonical service underlying this service. Corresponds to the destination_canonical_service_namespace metric label in Istio metrics.
meshUid This property is required. string
Identifier for the mesh in which this Istio service is defined. Corresponds to the meshUid metric label in Istio metrics.
project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
canonical_service This property is required. str

The name of the canonical service underlying this service. Corresponds to the destination_canonical_service_name metric label in label in Istio metrics.

Other optional fields include:

canonical_service_namespace This property is required. str
The namespace of the canonical service underlying this service. Corresponds to the destination_canonical_service_namespace metric label in Istio metrics.
mesh_uid This property is required. str
Identifier for the mesh in which this Istio service is defined. Corresponds to the meshUid metric label in Istio metrics.
project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
canonicalService This property is required. String

The name of the canonical service underlying this service. Corresponds to the destination_canonical_service_name metric label in label in Istio metrics.

Other optional fields include:

canonicalServiceNamespace This property is required. String
The namespace of the canonical service underlying this service. Corresponds to the destination_canonical_service_namespace metric label in Istio metrics.
meshUid This property is required. String
Identifier for the mesh in which this Istio service is defined. Corresponds to the meshUid metric label in Istio metrics.
project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

getIstioCanonicalService Result

The following output properties are available:

CanonicalService string
CanonicalServiceNamespace string
DisplayName string
Name used for UI elements listing this (Monitoring) Service.
Id string
The provider-assigned unique ID for this managed resource.
MeshUid string
Name string
The full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
ServiceId string
Telemetries List<GetIstioCanonicalServiceTelemetry>
Configuration for how to query telemetry on the Service. Structure is documented below.
UserLabels Dictionary<string, string>
Project string
CanonicalService string
CanonicalServiceNamespace string
DisplayName string
Name used for UI elements listing this (Monitoring) Service.
Id string
The provider-assigned unique ID for this managed resource.
MeshUid string
Name string
The full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
ServiceId string
Telemetries []GetIstioCanonicalServiceTelemetry
Configuration for how to query telemetry on the Service. Structure is documented below.
UserLabels map[string]string
Project string
canonicalService String
canonicalServiceNamespace String
displayName String
Name used for UI elements listing this (Monitoring) Service.
id String
The provider-assigned unique ID for this managed resource.
meshUid String
name String
The full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
serviceId String
telemetries List<GetIstioCanonicalServiceTelemetry>
Configuration for how to query telemetry on the Service. Structure is documented below.
userLabels Map<String,String>
project String
canonicalService string
canonicalServiceNamespace string
displayName string
Name used for UI elements listing this (Monitoring) Service.
id string
The provider-assigned unique ID for this managed resource.
meshUid string
name string
The full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
serviceId string
telemetries GetIstioCanonicalServiceTelemetry[]
Configuration for how to query telemetry on the Service. Structure is documented below.
userLabels {[key: string]: string}
project string
canonical_service str
canonical_service_namespace str
display_name str
Name used for UI elements listing this (Monitoring) Service.
id str
The provider-assigned unique ID for this managed resource.
mesh_uid str
name str
The full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
service_id str
telemetries Sequence[GetIstioCanonicalServiceTelemetry]
Configuration for how to query telemetry on the Service. Structure is documented below.
user_labels Mapping[str, str]
project str
canonicalService String
canonicalServiceNamespace String
displayName String
Name used for UI elements listing this (Monitoring) Service.
id String
The provider-assigned unique ID for this managed resource.
meshUid String
name String
The full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
serviceId String
telemetries List<Property Map>
Configuration for how to query telemetry on the Service. Structure is documented below.
userLabels Map<String>
project String

Supporting Types

GetIstioCanonicalServiceTelemetry

ResourceName This property is required. string
The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names.
ResourceName This property is required. string
The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names.
resourceName This property is required. String
The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names.
resourceName This property is required. string
The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names.
resource_name This property is required. str
The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names.
resourceName This property is required. String
The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names.

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.
Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-gcp