oci.Dns.getViews
Explore with Pulumi AI
This data source provides the list of Views in Oracle Cloud Infrastructure DNS service.
Gets a list of all views within a compartment.
The collection can be filtered by display name, id, or lifecycle state. It can be sorted on creation time or displayName both in ASC or DESC order. Note that when no lifecycleState query parameter is provided, the collection does not include views in the DELETED lifecycleState to be consistent with other operations of the API.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testViews = oci.Dns.getViews({
compartmentId: compartmentId,
scope: "PRIVATE",
displayName: viewDisplayName,
id: viewId,
state: viewState,
});
import pulumi
import pulumi_oci as oci
test_views = oci.Dns.get_views(compartment_id=compartment_id,
scope="PRIVATE",
display_name=view_display_name,
id=view_id,
state=view_state)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/dns"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := dns.GetViews(ctx, &dns.GetViewsArgs{
CompartmentId: compartmentId,
Scope: pulumi.StringRef("PRIVATE"),
DisplayName: pulumi.StringRef(viewDisplayName),
Id: pulumi.StringRef(viewId),
State: pulumi.StringRef(viewState),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testViews = Oci.Dns.GetViews.Invoke(new()
{
CompartmentId = compartmentId,
Scope = "PRIVATE",
DisplayName = viewDisplayName,
Id = viewId,
State = viewState,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Dns.DnsFunctions;
import com.pulumi.oci.Dns.inputs.GetViewsArgs;
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) {
final var testViews = DnsFunctions.getViews(GetViewsArgs.builder()
.compartmentId(compartmentId)
.scope("PRIVATE")
.displayName(viewDisplayName)
.id(viewId)
.state(viewState)
.build());
}
}
variables:
testViews:
fn::invoke:
function: oci:Dns:getViews
arguments:
compartmentId: ${compartmentId}
scope: PRIVATE
displayName: ${viewDisplayName}
id: ${viewId}
state: ${viewState}
Using getViews
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 getViews(args: GetViewsArgs, opts?: InvokeOptions): Promise<GetViewsResult>
function getViewsOutput(args: GetViewsOutputArgs, opts?: InvokeOptions): Output<GetViewsResult>
def get_views(compartment_id: Optional[str] = None,
display_name: Optional[str] = None,
filters: Optional[Sequence[_dns.GetViewsFilter]] = None,
id: Optional[str] = None,
scope: Optional[str] = None,
state: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetViewsResult
def get_views_output(compartment_id: Optional[pulumi.Input[str]] = None,
display_name: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[_dns.GetViewsFilterArgs]]]] = None,
id: Optional[pulumi.Input[str]] = None,
scope: Optional[pulumi.Input[str]] = None,
state: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetViewsResult]
func GetViews(ctx *Context, args *GetViewsArgs, opts ...InvokeOption) (*GetViewsResult, error)
func GetViewsOutput(ctx *Context, args *GetViewsOutputArgs, opts ...InvokeOption) GetViewsResultOutput
> Note: This function is named GetViews
in the Go SDK.
public static class GetViews
{
public static Task<GetViewsResult> InvokeAsync(GetViewsArgs args, InvokeOptions? opts = null)
public static Output<GetViewsResult> Invoke(GetViewsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetViewsResult> getViews(GetViewsArgs args, InvokeOptions options)
public static Output<GetViewsResult> getViews(GetViewsArgs args, InvokeOptions options)
fn::invoke:
function: oci:Dns/getViews:getViews
arguments:
# arguments dictionary
The following arguments are supported:
- Compartment
Id This property is required. string - The OCID of the compartment the resource belongs to.
- Display
Name string - The displayName of a resource.
- Filters
Changes to this property will trigger replacement.
Views Filter> - Id string
- The OCID of a resource.
- Scope string
- Value must be
PRIVATE
when listing private views. - State string
- The state of a resource.
- Compartment
Id This property is required. string - The OCID of the compartment the resource belongs to.
- Display
Name string - The displayName of a resource.
- Filters
Changes to this property will trigger replacement.
Views Filter - Id string
- The OCID of a resource.
- Scope string
- Value must be
PRIVATE
when listing private views. - State string
- The state of a resource.
- compartment
Id This property is required. String - The OCID of the compartment the resource belongs to.
- display
Name String - The displayName of a resource.
- filters
Changes to this property will trigger replacement.
Views Filter> - id String
- The OCID of a resource.
- scope String
- Value must be
PRIVATE
when listing private views. - state String
- The state of a resource.
- compartment
Id This property is required. string - The OCID of the compartment the resource belongs to.
- display
Name string - The displayName of a resource.
- filters
Changes to this property will trigger replacement.
Views Filter[] - id string
- The OCID of a resource.
- scope string
- Value must be
PRIVATE
when listing private views. - state string
- The state of a resource.
- compartment_
id This property is required. str - The OCID of the compartment the resource belongs to.
- display_
name str - The displayName of a resource.
- filters
Changes to this property will trigger replacement.
Get Views Filter] - id str
- The OCID of a resource.
- scope str
- Value must be
PRIVATE
when listing private views. - state str
- The state of a resource.
- compartment
Id This property is required. String - The OCID of the compartment the resource belongs to.
- display
Name String - The displayName of a resource.
- filters
Changes to this property will trigger replacement.
- id String
- The OCID of a resource.
- scope String
- Value must be
PRIVATE
when listing private views. - state String
- The state of a resource.
getViews Result
The following output properties are available:
- Compartment
Id string - The OCID of the owning compartment.
- Views
List<Get
Views View> - The list of views.
- Display
Name string - The display name of the view.
- Filters
List<Get
Views Filter> - Id string
- The OCID of the view.
- Scope string
- State string
- The current state of the resource.
- Compartment
Id string - The OCID of the owning compartment.
- Views
[]Get
Views View - The list of views.
- Display
Name string - The display name of the view.
- Filters
[]Get
Views Filter - Id string
- The OCID of the view.
- Scope string
- State string
- The current state of the resource.
- compartment
Id String - The OCID of the owning compartment.
- views
List<Get
Views View> - The list of views.
- display
Name String - The display name of the view.
- filters
List<Get
Views Filter> - id String
- The OCID of the view.
- scope String
- state String
- The current state of the resource.
- compartment
Id string - The OCID of the owning compartment.
- views
Get
Views View[] - The list of views.
- display
Name string - The display name of the view.
- filters
Get
Views Filter[] - id string
- The OCID of the view.
- scope string
- state string
- The current state of the resource.
- compartment_
id str - The OCID of the owning compartment.
- views
Sequence[dns.
Get Views View] - The list of views.
- display_
name str - The display name of the view.
- filters
Sequence[dns.
Get Views Filter] - id str
- The OCID of the view.
- scope str
- state str
- The current state of the resource.
- compartment
Id String - The OCID of the owning compartment.
- views List<Property Map>
- The list of views.
- display
Name String - The display name of the view.
- filters List<Property Map>
- id String
- The OCID of the view.
- scope String
- state String
- The current state of the resource.
Supporting Types
GetViewsFilter
GetViewsView
- Compartment
Id This property is required. string - The OCID of the compartment the resource belongs to.
This property is required. Dictionary<string, string>- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Display
Name This property is required. string - The displayName of a resource.
This property is required. Dictionary<string, string>- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
- Id
This property is required. string - The OCID of a resource.
- Is
Protected This property is required. bool - A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.
- Scope
This property is required. string - Value must be
PRIVATE
when listing private views. - Self
This property is required. string - The canonical absolute URL of the resource.
- State
This property is required. string - The state of a resource.
- Time
Created This property is required. string - The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.
- Time
Updated This property is required. string - The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.
- Compartment
Id This property is required. string - The OCID of the compartment the resource belongs to.
This property is required. map[string]string- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Display
Name This property is required. string - The displayName of a resource.
This property is required. map[string]string- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
- Id
This property is required. string - The OCID of a resource.
- Is
Protected This property is required. bool - A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.
- Scope
This property is required. string - Value must be
PRIVATE
when listing private views. - Self
This property is required. string - The canonical absolute URL of the resource.
- State
This property is required. string - The state of a resource.
- Time
Created This property is required. string - The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.
- Time
Updated This property is required. string - The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.
- compartment
Id This property is required. String - The OCID of the compartment the resource belongs to.
This property is required. Map<String,String>- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- display
Name This property is required. String - The displayName of a resource.
This property is required. Map<String,String>- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
- id
This property is required. String - The OCID of a resource.
- is
Protected This property is required. Boolean - A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.
- scope
This property is required. String - Value must be
PRIVATE
when listing private views. - self
This property is required. String - The canonical absolute URL of the resource.
- state
This property is required. String - The state of a resource.
- time
Created This property is required. String - The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.
- time
Updated This property is required. String - The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.
- compartment
Id This property is required. string - The OCID of the compartment the resource belongs to.
This property is required. {[key: string]: string}- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- display
Name This property is required. string - The displayName of a resource.
This property is required. {[key: string]: string}- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
- id
This property is required. string - The OCID of a resource.
- is
Protected This property is required. boolean - A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.
- scope
This property is required. string - Value must be
PRIVATE
when listing private views. - self
This property is required. string - The canonical absolute URL of the resource.
- state
This property is required. string - The state of a resource.
- time
Created This property is required. string - The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.
- time
Updated This property is required. string - The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.
- compartment_
id This property is required. str - The OCID of the compartment the resource belongs to.
This property is required. Mapping[str, str]- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- display_
name This property is required. str - The displayName of a resource.
This property is required. Mapping[str, str]- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
- id
This property is required. str - The OCID of a resource.
- is_
protected This property is required. bool - A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.
- scope
This property is required. str - Value must be
PRIVATE
when listing private views. - self
This property is required. str - The canonical absolute URL of the resource.
- state
This property is required. str - The state of a resource.
- time_
created This property is required. str - The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.
- time_
updated This property is required. str - The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.
- compartment
Id This property is required. String - The OCID of the compartment the resource belongs to.
This property is required. Map<String>- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- display
Name This property is required. String - The displayName of a resource.
This property is required. Map<String>- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
- id
This property is required. String - The OCID of a resource.
- is
Protected This property is required. Boolean - A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.
- scope
This property is required. String - Value must be
PRIVATE
when listing private views. - self
This property is required. String - The canonical absolute URL of the resource.
- state
This property is required. String - The state of a resource.
- time
Created This property is required. String - The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.
- time
Updated This property is required. String - The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.