Google Native

v0.27.0 published on Friday, Oct 21, 2022 by Pulumi

getEntitlement

Returns the requested Entitlement resource. Possible error codes: * PERMISSION_DENIED: The customer doesn’t belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer entitlement was not found. Return value: The requested Entitlement resource.

Using getEntitlement

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 getEntitlement(args: GetEntitlementArgs, opts?: InvokeOptions): Promise<GetEntitlementResult>
function getEntitlementOutput(args: GetEntitlementOutputArgs, opts?: InvokeOptions): Output<GetEntitlementResult>
def get_entitlement(account_id: Optional[str] = None,
                    customer_id: Optional[str] = None,
                    entitlement_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetEntitlementResult
def get_entitlement_output(account_id: Optional[pulumi.Input[str]] = None,
                    customer_id: Optional[pulumi.Input[str]] = None,
                    entitlement_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetEntitlementResult]
func LookupEntitlement(ctx *Context, args *LookupEntitlementArgs, opts ...InvokeOption) (*LookupEntitlementResult, error)
func LookupEntitlementOutput(ctx *Context, args *LookupEntitlementOutputArgs, opts ...InvokeOption) LookupEntitlementResultOutput

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

public static class GetEntitlement 
{
    public static Task<GetEntitlementResult> InvokeAsync(GetEntitlementArgs args, InvokeOptions? opts = null)
    public static Output<GetEntitlementResult> Invoke(GetEntitlementInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetEntitlementResult> getEntitlement(GetEntitlementArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: google-native:cloudchannel/v1:getEntitlement
  arguments:
    # arguments dictionary

The following arguments are supported:

getEntitlement Result

The following output properties are available:

AssociationInfo Pulumi.GoogleNative.CloudChannel.V1.Outputs.GoogleCloudChannelV1AssociationInfoResponse

Association information to other entitlements.

CommitmentSettings Pulumi.GoogleNative.CloudChannel.V1.Outputs.GoogleCloudChannelV1CommitmentSettingsResponse

Commitment settings for a commitment-based Offer. Required for commitment based offers.

CreateTime string

The time at which the entitlement is created.

Name string

Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.

Offer string

The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}.

Parameters List<Pulumi.GoogleNative.CloudChannel.V1.Outputs.GoogleCloudChannelV1ParameterResponse>

Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. The response may include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. - max_units: The maximum assignable units for a flexible offer. - num_units: The total commitment for commitment-based offers.

ProvisionedService Pulumi.GoogleNative.CloudChannel.V1.Outputs.GoogleCloudChannelV1ProvisionedServiceResponse

Service provisioning details for the entitlement.

ProvisioningState string

Current provisioning state of the entitlement.

PurchaseOrderId string

Optional. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given, it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. This is only supported for Google Workspace entitlements.

SuspensionReasons List<string>

Enumerable of all current suspension reasons for an entitlement.

TrialSettings Pulumi.GoogleNative.CloudChannel.V1.Outputs.GoogleCloudChannelV1TrialSettingsResponse

Settings for trial offers.

UpdateTime string

The time at which the entitlement is updated.

AssociationInfo GoogleCloudChannelV1AssociationInfoResponse

Association information to other entitlements.

CommitmentSettings GoogleCloudChannelV1CommitmentSettingsResponse

Commitment settings for a commitment-based Offer. Required for commitment based offers.

CreateTime string

The time at which the entitlement is created.

Name string

Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.

Offer string

The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}.

Parameters []GoogleCloudChannelV1ParameterResponse

Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. The response may include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. - max_units: The maximum assignable units for a flexible offer. - num_units: The total commitment for commitment-based offers.

ProvisionedService GoogleCloudChannelV1ProvisionedServiceResponse

Service provisioning details for the entitlement.

ProvisioningState string

Current provisioning state of the entitlement.

PurchaseOrderId string

Optional. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given, it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. This is only supported for Google Workspace entitlements.

SuspensionReasons []string

Enumerable of all current suspension reasons for an entitlement.

TrialSettings GoogleCloudChannelV1TrialSettingsResponse

Settings for trial offers.

UpdateTime string

The time at which the entitlement is updated.

associationInfo GoogleCloudChannelV1AssociationInfoResponse

Association information to other entitlements.

commitmentSettings GoogleCloudChannelV1CommitmentSettingsResponse

Commitment settings for a commitment-based Offer. Required for commitment based offers.

createTime String

The time at which the entitlement is created.

name String

Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.

offer String

The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}.

parameters List<GoogleCloudChannelV1ParameterResponse>

Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. The response may include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. - max_units: The maximum assignable units for a flexible offer. - num_units: The total commitment for commitment-based offers.

provisionedService GoogleCloudChannelV1ProvisionedServiceResponse

Service provisioning details for the entitlement.

provisioningState String

Current provisioning state of the entitlement.

purchaseOrderId String

Optional. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given, it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. This is only supported for Google Workspace entitlements.

suspensionReasons List<String>

Enumerable of all current suspension reasons for an entitlement.

trialSettings GoogleCloudChannelV1TrialSettingsResponse

Settings for trial offers.

updateTime String

The time at which the entitlement is updated.

associationInfo GoogleCloudChannelV1AssociationInfoResponse

Association information to other entitlements.

commitmentSettings GoogleCloudChannelV1CommitmentSettingsResponse

Commitment settings for a commitment-based Offer. Required for commitment based offers.

createTime string

The time at which the entitlement is created.

name string

Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.

offer string

The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}.

parameters GoogleCloudChannelV1ParameterResponse[]

Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. The response may include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. - max_units: The maximum assignable units for a flexible offer. - num_units: The total commitment for commitment-based offers.

provisionedService GoogleCloudChannelV1ProvisionedServiceResponse

Service provisioning details for the entitlement.

provisioningState string

Current provisioning state of the entitlement.

purchaseOrderId string

Optional. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given, it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. This is only supported for Google Workspace entitlements.

suspensionReasons string[]

Enumerable of all current suspension reasons for an entitlement.

trialSettings GoogleCloudChannelV1TrialSettingsResponse

Settings for trial offers.

updateTime string

The time at which the entitlement is updated.

association_info GoogleCloudChannelV1AssociationInfoResponse

Association information to other entitlements.

commitment_settings GoogleCloudChannelV1CommitmentSettingsResponse

Commitment settings for a commitment-based Offer. Required for commitment based offers.

create_time str

The time at which the entitlement is created.

name str

Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.

offer str

The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}.

parameters Sequence[GoogleCloudChannelV1ParameterResponse]

Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. The response may include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. - max_units: The maximum assignable units for a flexible offer. - num_units: The total commitment for commitment-based offers.

provisioned_service GoogleCloudChannelV1ProvisionedServiceResponse

Service provisioning details for the entitlement.

provisioning_state str

Current provisioning state of the entitlement.

purchase_order_id str

Optional. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given, it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. This is only supported for Google Workspace entitlements.

suspension_reasons Sequence[str]

Enumerable of all current suspension reasons for an entitlement.

trial_settings GoogleCloudChannelV1TrialSettingsResponse

Settings for trial offers.

update_time str

The time at which the entitlement is updated.

associationInfo Property Map

Association information to other entitlements.

commitmentSettings Property Map

Commitment settings for a commitment-based Offer. Required for commitment based offers.

createTime String

The time at which the entitlement is created.

name String

Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.

offer String

The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}.

parameters List<Property Map>

Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. The response may include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. - max_units: The maximum assignable units for a flexible offer. - num_units: The total commitment for commitment-based offers.

provisionedService Property Map

Service provisioning details for the entitlement.

provisioningState String

Current provisioning state of the entitlement.

purchaseOrderId String

Optional. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given, it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. This is only supported for Google Workspace entitlements.

suspensionReasons List<String>

Enumerable of all current suspension reasons for an entitlement.

trialSettings Property Map

Settings for trial offers.

updateTime String

The time at which the entitlement is updated.

Supporting Types

GoogleCloudChannelV1AssociationInfoResponse

BaseEntitlement string

The name of the base entitlement, for which this entitlement is an add-on.

BaseEntitlement string

The name of the base entitlement, for which this entitlement is an add-on.

baseEntitlement String

The name of the base entitlement, for which this entitlement is an add-on.

baseEntitlement string

The name of the base entitlement, for which this entitlement is an add-on.

base_entitlement str

The name of the base entitlement, for which this entitlement is an add-on.

baseEntitlement String

The name of the base entitlement, for which this entitlement is an add-on.

GoogleCloudChannelV1CommitmentSettingsResponse

EndTime string

Commitment end timestamp.

RenewalSettings Pulumi.GoogleNative.CloudChannel.V1.Inputs.GoogleCloudChannelV1RenewalSettingsResponse

Optional. Renewal settings applicable for a commitment-based Offer.

StartTime string

Commitment start timestamp.

EndTime string

Commitment end timestamp.

RenewalSettings GoogleCloudChannelV1RenewalSettingsResponse

Optional. Renewal settings applicable for a commitment-based Offer.

StartTime string

Commitment start timestamp.

endTime String

Commitment end timestamp.

renewalSettings GoogleCloudChannelV1RenewalSettingsResponse

Optional. Renewal settings applicable for a commitment-based Offer.

startTime String

Commitment start timestamp.

endTime string

Commitment end timestamp.

renewalSettings GoogleCloudChannelV1RenewalSettingsResponse

Optional. Renewal settings applicable for a commitment-based Offer.

startTime string

Commitment start timestamp.

end_time str

Commitment end timestamp.

renewal_settings GoogleCloudChannelV1RenewalSettingsResponse

Optional. Renewal settings applicable for a commitment-based Offer.

start_time str

Commitment start timestamp.

endTime String

Commitment end timestamp.

renewalSettings Property Map

Optional. Renewal settings applicable for a commitment-based Offer.

startTime String

Commitment start timestamp.

GoogleCloudChannelV1ParameterResponse

Editable bool

Specifies whether this parameter is allowed to be changed. For example, for a Google Workspace Business Starter entitlement in commitment plan, num_units is editable when entitlement is active.

Name string

Name of the parameter.

Value Pulumi.GoogleNative.CloudChannel.V1.Inputs.GoogleCloudChannelV1ValueResponse

Value of the parameter.

Editable bool

Specifies whether this parameter is allowed to be changed. For example, for a Google Workspace Business Starter entitlement in commitment plan, num_units is editable when entitlement is active.

Name string

Name of the parameter.

Value GoogleCloudChannelV1ValueResponse

Value of the parameter.

editable Boolean

Specifies whether this parameter is allowed to be changed. For example, for a Google Workspace Business Starter entitlement in commitment plan, num_units is editable when entitlement is active.

name String

Name of the parameter.

value GoogleCloudChannelV1ValueResponse

Value of the parameter.

editable boolean

Specifies whether this parameter is allowed to be changed. For example, for a Google Workspace Business Starter entitlement in commitment plan, num_units is editable when entitlement is active.

name string

Name of the parameter.

value GoogleCloudChannelV1ValueResponse

Value of the parameter.

editable bool

Specifies whether this parameter is allowed to be changed. For example, for a Google Workspace Business Starter entitlement in commitment plan, num_units is editable when entitlement is active.

name str

Name of the parameter.

value GoogleCloudChannelV1ValueResponse

Value of the parameter.

editable Boolean

Specifies whether this parameter is allowed to be changed. For example, for a Google Workspace Business Starter entitlement in commitment plan, num_units is editable when entitlement is active.

name String

Name of the parameter.

value Property Map

Value of the parameter.

GoogleCloudChannelV1PeriodResponse

Duration int

Total duration of Period Type defined.

PeriodType string

Period Type.

Duration int

Total duration of Period Type defined.

PeriodType string

Period Type.

duration Integer

Total duration of Period Type defined.

periodType String

Period Type.

duration number

Total duration of Period Type defined.

periodType string

Period Type.

duration int

Total duration of Period Type defined.

period_type str

Period Type.

duration Number

Total duration of Period Type defined.

periodType String

Period Type.

GoogleCloudChannelV1ProvisionedServiceResponse

ProductId string

The product pertaining to the provisioning resource as specified in the Offer.

ProvisioningId string

Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud Platform, this is the Billing Account ID of the billing subaccount."

SkuId string

The SKU pertaining to the provisioning resource as specified in the Offer.

ProductId string

The product pertaining to the provisioning resource as specified in the Offer.

ProvisioningId string

Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud Platform, this is the Billing Account ID of the billing subaccount."

SkuId string

The SKU pertaining to the provisioning resource as specified in the Offer.

productId String

The product pertaining to the provisioning resource as specified in the Offer.

provisioningId String

Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud Platform, this is the Billing Account ID of the billing subaccount."

skuId String

The SKU pertaining to the provisioning resource as specified in the Offer.

productId string

The product pertaining to the provisioning resource as specified in the Offer.

provisioningId string

Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud Platform, this is the Billing Account ID of the billing subaccount."

skuId string

The SKU pertaining to the provisioning resource as specified in the Offer.

product_id str

The product pertaining to the provisioning resource as specified in the Offer.

provisioning_id str

Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud Platform, this is the Billing Account ID of the billing subaccount."

sku_id str

The SKU pertaining to the provisioning resource as specified in the Offer.

productId String

The product pertaining to the provisioning resource as specified in the Offer.

provisioningId String

Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud Platform, this is the Billing Account ID of the billing subaccount."

skuId String

The SKU pertaining to the provisioning resource as specified in the Offer.

GoogleCloudChannelV1RenewalSettingsResponse

EnableRenewal bool

If false, the plan will be completed at the end date.

PaymentCycle Pulumi.GoogleNative.CloudChannel.V1.Inputs.GoogleCloudChannelV1PeriodResponse

Describes how frequently the reseller will be billed, such as once per month.

PaymentPlan string

Describes how a reseller will be billed.

ResizeUnitCount bool

If true and enable_renewal = true, the unit (for example seats or licenses) will be set to the number of active units at renewal time.

EnableRenewal bool

If false, the plan will be completed at the end date.

PaymentCycle GoogleCloudChannelV1PeriodResponse

Describes how frequently the reseller will be billed, such as once per month.

PaymentPlan string

Describes how a reseller will be billed.

ResizeUnitCount bool

If true and enable_renewal = true, the unit (for example seats or licenses) will be set to the number of active units at renewal time.

enableRenewal Boolean

If false, the plan will be completed at the end date.

paymentCycle GoogleCloudChannelV1PeriodResponse

Describes how frequently the reseller will be billed, such as once per month.

paymentPlan String

Describes how a reseller will be billed.

resizeUnitCount Boolean

If true and enable_renewal = true, the unit (for example seats or licenses) will be set to the number of active units at renewal time.

enableRenewal boolean

If false, the plan will be completed at the end date.

paymentCycle GoogleCloudChannelV1PeriodResponse

Describes how frequently the reseller will be billed, such as once per month.

paymentPlan string

Describes how a reseller will be billed.

resizeUnitCount boolean

If true and enable_renewal = true, the unit (for example seats or licenses) will be set to the number of active units at renewal time.

enable_renewal bool

If false, the plan will be completed at the end date.

payment_cycle GoogleCloudChannelV1PeriodResponse

Describes how frequently the reseller will be billed, such as once per month.

payment_plan str

Describes how a reseller will be billed.

resize_unit_count bool

If true and enable_renewal = true, the unit (for example seats or licenses) will be set to the number of active units at renewal time.

enableRenewal Boolean

If false, the plan will be completed at the end date.

paymentCycle Property Map

Describes how frequently the reseller will be billed, such as once per month.

paymentPlan String

Describes how a reseller will be billed.

resizeUnitCount Boolean

If true and enable_renewal = true, the unit (for example seats or licenses) will be set to the number of active units at renewal time.

GoogleCloudChannelV1TrialSettingsResponse

EndTime string

Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.

Trial bool

Determines if the entitlement is in a trial or not: * true - The entitlement is in trial. * false - The entitlement is not in trial.

EndTime string

Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.

Trial bool

Determines if the entitlement is in a trial or not: * true - The entitlement is in trial. * false - The entitlement is not in trial.

endTime String

Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.

trial Boolean

Determines if the entitlement is in a trial or not: * true - The entitlement is in trial. * false - The entitlement is not in trial.

endTime string

Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.

trial boolean

Determines if the entitlement is in a trial or not: * true - The entitlement is in trial. * false - The entitlement is not in trial.

end_time str

Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.

trial bool

Determines if the entitlement is in a trial or not: * true - The entitlement is in trial. * false - The entitlement is not in trial.

endTime String

Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.

trial Boolean

Determines if the entitlement is in a trial or not: * true - The entitlement is in trial. * false - The entitlement is not in trial.

GoogleCloudChannelV1ValueResponse

BoolValue bool

Represents a boolean value.

DoubleValue double

Represents a double value.

Int64Value string

Represents an int64 value.

ProtoValue Dictionary<string, string>

Represents an 'Any' proto value.

StringValue string

Represents a string value.

BoolValue bool

Represents a boolean value.

DoubleValue float64

Represents a double value.

Int64Value string

Represents an int64 value.

ProtoValue map[string]string

Represents an 'Any' proto value.

StringValue string

Represents a string value.

boolValue Boolean

Represents a boolean value.

doubleValue Double

Represents a double value.

int64Value String

Represents an int64 value.

protoValue Map<String,String>

Represents an 'Any' proto value.

stringValue String

Represents a string value.

boolValue boolean

Represents a boolean value.

doubleValue number

Represents a double value.

int64Value string

Represents an int64 value.

protoValue {[key: string]: string}

Represents an 'Any' proto value.

stringValue string

Represents a string value.

bool_value bool

Represents a boolean value.

double_value float

Represents a double value.

int64_value str

Represents an int64 value.

proto_value Mapping[str, str]

Represents an 'Any' proto value.

string_value str

Represents a string value.

boolValue Boolean

Represents a boolean value.

doubleValue Number

Represents a double value.

int64Value String

Represents an int64 value.

protoValue Map<String>

Represents an 'Any' proto value.

stringValue String

Represents a string value.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0