1. Packages
  2. Google Cloud Native
  3. API Docs
  4. cloudchannel
  5. cloudchannel/v1
  6. ChannelPartnerLink

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.cloudchannel/v1.ChannelPartnerLink

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

Initiates a channel partner link between a distributor and a reseller, or between resellers in an n-tier reseller channel. Invited partners need to follow the invite_link_uri provided in the response to accept. After accepting the invitation, a link is set up between the two parties. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * ALREADY_EXISTS: The ChannelPartnerLink sent in the request already exists. * NOT_FOUND: No Cloud Identity customer exists for provided domain. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The new ChannelPartnerLink resource. Auto-naming is currently not supported for this resource. Note - this resource’s API doesn’t support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.

Create ChannelPartnerLink Resource

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

Constructor syntax

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

@overload
def ChannelPartnerLink(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       account_id: Optional[str] = None,
                       link_state: Optional[ChannelPartnerLinkLinkState] = None,
                       reseller_cloud_identity_id: Optional[str] = None)
func NewChannelPartnerLink(ctx *Context, name string, args ChannelPartnerLinkArgs, opts ...ResourceOption) (*ChannelPartnerLink, error)
public ChannelPartnerLink(string name, ChannelPartnerLinkArgs args, CustomResourceOptions? opts = null)
public ChannelPartnerLink(String name, ChannelPartnerLinkArgs args)
public ChannelPartnerLink(String name, ChannelPartnerLinkArgs args, CustomResourceOptions options)
type: google-native:cloudchannel/v1:ChannelPartnerLink
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ChannelPartnerLinkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ChannelPartnerLinkArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ChannelPartnerLinkArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ChannelPartnerLinkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ChannelPartnerLinkArgs
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 channelPartnerLinkResource = new GoogleNative.CloudChannel.V1.ChannelPartnerLink("channelPartnerLinkResource", new()
{
    AccountId = "string",
    LinkState = GoogleNative.CloudChannel.V1.ChannelPartnerLinkLinkState.ChannelPartnerLinkStateUnspecified,
    ResellerCloudIdentityId = "string",
});
Copy
example, err := cloudchannel.NewChannelPartnerLink(ctx, "channelPartnerLinkResource", &cloudchannel.ChannelPartnerLinkArgs{
	AccountId:               pulumi.String("string"),
	LinkState:               cloudchannel.ChannelPartnerLinkLinkStateChannelPartnerLinkStateUnspecified,
	ResellerCloudIdentityId: pulumi.String("string"),
})
Copy
var channelPartnerLinkResource = new ChannelPartnerLink("channelPartnerLinkResource", ChannelPartnerLinkArgs.builder()
    .accountId("string")
    .linkState("CHANNEL_PARTNER_LINK_STATE_UNSPECIFIED")
    .resellerCloudIdentityId("string")
    .build());
Copy
channel_partner_link_resource = google_native.cloudchannel.v1.ChannelPartnerLink("channelPartnerLinkResource",
    account_id="string",
    link_state=google_native.cloudchannel.v1.ChannelPartnerLinkLinkState.CHANNEL_PARTNER_LINK_STATE_UNSPECIFIED,
    reseller_cloud_identity_id="string")
Copy
const channelPartnerLinkResource = new google_native.cloudchannel.v1.ChannelPartnerLink("channelPartnerLinkResource", {
    accountId: "string",
    linkState: google_native.cloudchannel.v1.ChannelPartnerLinkLinkState.ChannelPartnerLinkStateUnspecified,
    resellerCloudIdentityId: "string",
});
Copy
type: google-native:cloudchannel/v1:ChannelPartnerLink
properties:
    accountId: string
    linkState: CHANNEL_PARTNER_LINK_STATE_UNSPECIFIED
    resellerCloudIdentityId: string
Copy

ChannelPartnerLink 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 ChannelPartnerLink resource accepts the following input properties:

AccountId
This property is required.
Changes to this property will trigger replacement.
string
LinkState This property is required. Pulumi.GoogleNative.CloudChannel.V1.ChannelPartnerLinkLinkState
State of the channel partner link.
ResellerCloudIdentityId This property is required. string
Cloud Identity ID of the linked reseller.
AccountId
This property is required.
Changes to this property will trigger replacement.
string
LinkState This property is required. ChannelPartnerLinkLinkState
State of the channel partner link.
ResellerCloudIdentityId This property is required. string
Cloud Identity ID of the linked reseller.
accountId
This property is required.
Changes to this property will trigger replacement.
String
linkState This property is required. ChannelPartnerLinkLinkState
State of the channel partner link.
resellerCloudIdentityId This property is required. String
Cloud Identity ID of the linked reseller.
accountId
This property is required.
Changes to this property will trigger replacement.
string
linkState This property is required. ChannelPartnerLinkLinkState
State of the channel partner link.
resellerCloudIdentityId This property is required. string
Cloud Identity ID of the linked reseller.
account_id
This property is required.
Changes to this property will trigger replacement.
str
link_state This property is required. ChannelPartnerLinkLinkState
State of the channel partner link.
reseller_cloud_identity_id This property is required. str
Cloud Identity ID of the linked reseller.
accountId
This property is required.
Changes to this property will trigger replacement.
String
linkState This property is required. "CHANNEL_PARTNER_LINK_STATE_UNSPECIFIED" | "INVITED" | "ACTIVE" | "REVOKED" | "SUSPENDED"
State of the channel partner link.
resellerCloudIdentityId This property is required. String
Cloud Identity ID of the linked reseller.

Outputs

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

ChannelPartnerCloudIdentityInfo Pulumi.GoogleNative.CloudChannel.V1.Outputs.GoogleCloudChannelV1CloudIdentityInfoResponse
Cloud Identity info of the channel partner (IR).
CreateTime string
Timestamp of when the channel partner link is created.
Id string
The provider-assigned unique ID for this managed resource.
InviteLinkUri string
URI of the web page where partner accepts the link invitation.
Name string
Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
PublicId string
Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
UpdateTime string
Timestamp of when the channel partner link is updated.
ChannelPartnerCloudIdentityInfo GoogleCloudChannelV1CloudIdentityInfoResponse
Cloud Identity info of the channel partner (IR).
CreateTime string
Timestamp of when the channel partner link is created.
Id string
The provider-assigned unique ID for this managed resource.
InviteLinkUri string
URI of the web page where partner accepts the link invitation.
Name string
Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
PublicId string
Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
UpdateTime string
Timestamp of when the channel partner link is updated.
channelPartnerCloudIdentityInfo GoogleCloudChannelV1CloudIdentityInfoResponse
Cloud Identity info of the channel partner (IR).
createTime String
Timestamp of when the channel partner link is created.
id String
The provider-assigned unique ID for this managed resource.
inviteLinkUri String
URI of the web page where partner accepts the link invitation.
name String
Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
publicId String
Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
updateTime String
Timestamp of when the channel partner link is updated.
channelPartnerCloudIdentityInfo GoogleCloudChannelV1CloudIdentityInfoResponse
Cloud Identity info of the channel partner (IR).
createTime string
Timestamp of when the channel partner link is created.
id string
The provider-assigned unique ID for this managed resource.
inviteLinkUri string
URI of the web page where partner accepts the link invitation.
name string
Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
publicId string
Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
updateTime string
Timestamp of when the channel partner link is updated.
channel_partner_cloud_identity_info GoogleCloudChannelV1CloudIdentityInfoResponse
Cloud Identity info of the channel partner (IR).
create_time str
Timestamp of when the channel partner link is created.
id str
The provider-assigned unique ID for this managed resource.
invite_link_uri str
URI of the web page where partner accepts the link invitation.
name str
Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
public_id str
Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
update_time str
Timestamp of when the channel partner link is updated.
channelPartnerCloudIdentityInfo Property Map
Cloud Identity info of the channel partner (IR).
createTime String
Timestamp of when the channel partner link is created.
id String
The provider-assigned unique ID for this managed resource.
inviteLinkUri String
URI of the web page where partner accepts the link invitation.
name String
Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
publicId String
Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
updateTime String
Timestamp of when the channel partner link is updated.

Supporting Types

ChannelPartnerLinkLinkState
, ChannelPartnerLinkLinkStateArgs

ChannelPartnerLinkStateUnspecified
CHANNEL_PARTNER_LINK_STATE_UNSPECIFIEDNot used.
Invited
INVITEDAn invitation has been sent to the reseller to create a channel partner link.
Active
ACTIVEStatus when the reseller is active.
Revoked
REVOKEDStatus when the reseller has been revoked by the distributor.
Suspended
SUSPENDEDStatus when the reseller is suspended by Google or distributor.
ChannelPartnerLinkLinkStateChannelPartnerLinkStateUnspecified
CHANNEL_PARTNER_LINK_STATE_UNSPECIFIEDNot used.
ChannelPartnerLinkLinkStateInvited
INVITEDAn invitation has been sent to the reseller to create a channel partner link.
ChannelPartnerLinkLinkStateActive
ACTIVEStatus when the reseller is active.
ChannelPartnerLinkLinkStateRevoked
REVOKEDStatus when the reseller has been revoked by the distributor.
ChannelPartnerLinkLinkStateSuspended
SUSPENDEDStatus when the reseller is suspended by Google or distributor.
ChannelPartnerLinkStateUnspecified
CHANNEL_PARTNER_LINK_STATE_UNSPECIFIEDNot used.
Invited
INVITEDAn invitation has been sent to the reseller to create a channel partner link.
Active
ACTIVEStatus when the reseller is active.
Revoked
REVOKEDStatus when the reseller has been revoked by the distributor.
Suspended
SUSPENDEDStatus when the reseller is suspended by Google or distributor.
ChannelPartnerLinkStateUnspecified
CHANNEL_PARTNER_LINK_STATE_UNSPECIFIEDNot used.
Invited
INVITEDAn invitation has been sent to the reseller to create a channel partner link.
Active
ACTIVEStatus when the reseller is active.
Revoked
REVOKEDStatus when the reseller has been revoked by the distributor.
Suspended
SUSPENDEDStatus when the reseller is suspended by Google or distributor.
CHANNEL_PARTNER_LINK_STATE_UNSPECIFIED
CHANNEL_PARTNER_LINK_STATE_UNSPECIFIEDNot used.
INVITED
INVITEDAn invitation has been sent to the reseller to create a channel partner link.
ACTIVE
ACTIVEStatus when the reseller is active.
REVOKED
REVOKEDStatus when the reseller has been revoked by the distributor.
SUSPENDED
SUSPENDEDStatus when the reseller is suspended by Google or distributor.
"CHANNEL_PARTNER_LINK_STATE_UNSPECIFIED"
CHANNEL_PARTNER_LINK_STATE_UNSPECIFIEDNot used.
"INVITED"
INVITEDAn invitation has been sent to the reseller to create a channel partner link.
"ACTIVE"
ACTIVEStatus when the reseller is active.
"REVOKED"
REVOKEDStatus when the reseller has been revoked by the distributor.
"SUSPENDED"
SUSPENDEDStatus when the reseller is suspended by Google or distributor.

GoogleCloudChannelV1CloudIdentityInfoResponse
, GoogleCloudChannelV1CloudIdentityInfoResponseArgs

AdminConsoleUri This property is required. string
URI of Customer's Admin console dashboard.
AlternateEmail This property is required. string
The alternate email.
CustomerType This property is required. string
CustomerType indicates verification type needed for using services.
EduData This property is required. Pulumi.GoogleNative.CloudChannel.V1.Inputs.GoogleCloudChannelV1EduDataResponse
Edu information about the customer.
IsDomainVerified This property is required. bool
Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.
LanguageCode This property is required. string
Language code.
PhoneNumber This property is required. string
Phone number associated with the Cloud Identity.
PrimaryDomain This property is required. string
The primary domain name.
AdminConsoleUri This property is required. string
URI of Customer's Admin console dashboard.
AlternateEmail This property is required. string
The alternate email.
CustomerType This property is required. string
CustomerType indicates verification type needed for using services.
EduData This property is required. GoogleCloudChannelV1EduDataResponse
Edu information about the customer.
IsDomainVerified This property is required. bool
Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.
LanguageCode This property is required. string
Language code.
PhoneNumber This property is required. string
Phone number associated with the Cloud Identity.
PrimaryDomain This property is required. string
The primary domain name.
adminConsoleUri This property is required. String
URI of Customer's Admin console dashboard.
alternateEmail This property is required. String
The alternate email.
customerType This property is required. String
CustomerType indicates verification type needed for using services.
eduData This property is required. GoogleCloudChannelV1EduDataResponse
Edu information about the customer.
isDomainVerified This property is required. Boolean
Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.
languageCode This property is required. String
Language code.
phoneNumber This property is required. String
Phone number associated with the Cloud Identity.
primaryDomain This property is required. String
The primary domain name.
adminConsoleUri This property is required. string
URI of Customer's Admin console dashboard.
alternateEmail This property is required. string
The alternate email.
customerType This property is required. string
CustomerType indicates verification type needed for using services.
eduData This property is required. GoogleCloudChannelV1EduDataResponse
Edu information about the customer.
isDomainVerified This property is required. boolean
Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.
languageCode This property is required. string
Language code.
phoneNumber This property is required. string
Phone number associated with the Cloud Identity.
primaryDomain This property is required. string
The primary domain name.
admin_console_uri This property is required. str
URI of Customer's Admin console dashboard.
alternate_email This property is required. str
The alternate email.
customer_type This property is required. str
CustomerType indicates verification type needed for using services.
edu_data This property is required. GoogleCloudChannelV1EduDataResponse
Edu information about the customer.
is_domain_verified This property is required. bool
Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.
language_code This property is required. str
Language code.
phone_number This property is required. str
Phone number associated with the Cloud Identity.
primary_domain This property is required. str
The primary domain name.
adminConsoleUri This property is required. String
URI of Customer's Admin console dashboard.
alternateEmail This property is required. String
The alternate email.
customerType This property is required. String
CustomerType indicates verification type needed for using services.
eduData This property is required. Property Map
Edu information about the customer.
isDomainVerified This property is required. Boolean
Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.
languageCode This property is required. String
Language code.
phoneNumber This property is required. String
Phone number associated with the Cloud Identity.
primaryDomain This property is required. String
The primary domain name.

GoogleCloudChannelV1EduDataResponse
, GoogleCloudChannelV1EduDataResponseArgs

InstituteSize This property is required. string
Size of the institute.
InstituteType This property is required. string
Designated institute type of customer.
Website This property is required. string
Web address for the edu customer's institution.
InstituteSize This property is required. string
Size of the institute.
InstituteType This property is required. string
Designated institute type of customer.
Website This property is required. string
Web address for the edu customer's institution.
instituteSize This property is required. String
Size of the institute.
instituteType This property is required. String
Designated institute type of customer.
website This property is required. String
Web address for the edu customer's institution.
instituteSize This property is required. string
Size of the institute.
instituteType This property is required. string
Designated institute type of customer.
website This property is required. string
Web address for the edu customer's institution.
institute_size This property is required. str
Size of the institute.
institute_type This property is required. str
Designated institute type of customer.
website This property is required. str
Web address for the edu customer's institution.
instituteSize This property is required. String
Size of the institute.
instituteType This property is required. String
Designated institute type of customer.
website This property is required. String
Web address for the edu customer's institution.

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