1. Packages
  2. Google Cloud Native
  3. API Docs
  4. bigquerydatapolicy
  5. bigquerydatapolicy/v1
  6. getDataPolicy

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.bigquerydatapolicy/v1.getDataPolicy

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

Gets the data policy specified by its resource name.

Using getDataPolicy

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 getDataPolicy(args: GetDataPolicyArgs, opts?: InvokeOptions): Promise<GetDataPolicyResult>
function getDataPolicyOutput(args: GetDataPolicyOutputArgs, opts?: InvokeOptions): Output<GetDataPolicyResult>
Copy
def get_data_policy(data_policy_id: Optional[str] = None,
                    location: Optional[str] = None,
                    project: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetDataPolicyResult
def get_data_policy_output(data_policy_id: Optional[pulumi.Input[str]] = None,
                    location: Optional[pulumi.Input[str]] = None,
                    project: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetDataPolicyResult]
Copy
func LookupDataPolicy(ctx *Context, args *LookupDataPolicyArgs, opts ...InvokeOption) (*LookupDataPolicyResult, error)
func LookupDataPolicyOutput(ctx *Context, args *LookupDataPolicyOutputArgs, opts ...InvokeOption) LookupDataPolicyResultOutput
Copy

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

public static class GetDataPolicy 
{
    public static Task<GetDataPolicyResult> InvokeAsync(GetDataPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetDataPolicyResult> Invoke(GetDataPolicyInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDataPolicyResult> getDataPolicy(GetDataPolicyArgs args, InvokeOptions options)
public static Output<GetDataPolicyResult> getDataPolicy(GetDataPolicyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:bigquerydatapolicy/v1:getDataPolicy
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DataPolicyId This property is required. string
Location This property is required. string
Project string
DataPolicyId This property is required. string
Location This property is required. string
Project string
dataPolicyId This property is required. String
location This property is required. String
project String
dataPolicyId This property is required. string
location This property is required. string
project string
data_policy_id This property is required. str
location This property is required. str
project str
dataPolicyId This property is required. String
location This property is required. String
project String

getDataPolicy Result

The following output properties are available:

DataMaskingPolicy Pulumi.GoogleNative.BigQueryDataPolicy.V1.Outputs.DataMaskingPolicyResponse
The data masking policy that specifies the data masking rule to use.
DataPolicyId string
User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
DataPolicyType string
Type of data policy.
Name string
Resource name of this data policy, in the format of projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}.
PolicyTag string
Policy tag resource name, in the format of projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}.
DataMaskingPolicy DataMaskingPolicyResponse
The data masking policy that specifies the data masking rule to use.
DataPolicyId string
User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
DataPolicyType string
Type of data policy.
Name string
Resource name of this data policy, in the format of projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}.
PolicyTag string
Policy tag resource name, in the format of projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}.
dataMaskingPolicy DataMaskingPolicyResponse
The data masking policy that specifies the data masking rule to use.
dataPolicyId String
User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
dataPolicyType String
Type of data policy.
name String
Resource name of this data policy, in the format of projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}.
policyTag String
Policy tag resource name, in the format of projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}.
dataMaskingPolicy DataMaskingPolicyResponse
The data masking policy that specifies the data masking rule to use.
dataPolicyId string
User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
dataPolicyType string
Type of data policy.
name string
Resource name of this data policy, in the format of projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}.
policyTag string
Policy tag resource name, in the format of projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}.
data_masking_policy DataMaskingPolicyResponse
The data masking policy that specifies the data masking rule to use.
data_policy_id str
User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
data_policy_type str
Type of data policy.
name str
Resource name of this data policy, in the format of projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}.
policy_tag str
Policy tag resource name, in the format of projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}.
dataMaskingPolicy Property Map
The data masking policy that specifies the data masking rule to use.
dataPolicyId String
User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
dataPolicyType String
Type of data policy.
name String
Resource name of this data policy, in the format of projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}.
policyTag String
Policy tag resource name, in the format of projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}.

Supporting Types

DataMaskingPolicyResponse

PredefinedExpression This property is required. string
A predefined masking expression.
Routine This property is required. string
The name of the BigQuery routine that contains the custom masking routine, in the format of projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}.
PredefinedExpression This property is required. string
A predefined masking expression.
Routine This property is required. string
The name of the BigQuery routine that contains the custom masking routine, in the format of projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}.
predefinedExpression This property is required. String
A predefined masking expression.
routine This property is required. String
The name of the BigQuery routine that contains the custom masking routine, in the format of projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}.
predefinedExpression This property is required. string
A predefined masking expression.
routine This property is required. string
The name of the BigQuery routine that contains the custom masking routine, in the format of projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}.
predefined_expression This property is required. str
A predefined masking expression.
routine This property is required. str
The name of the BigQuery routine that contains the custom masking routine, in the format of projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}.
predefinedExpression This property is required. String
A predefined masking expression.
routine This property is required. String
The name of the BigQuery routine that contains the custom masking routine, in the format of projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi