Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. domainregistration
  5. listTopLevelDomainAgreements
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.domainregistration.listTopLevelDomainAgreements

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Description for Gets all legal agreements that user needs to accept before purchasing a domain.

Uses Azure REST API version 2024-04-01.

Other available API versions: 2022-09-01, 2023-01-01, 2023-12-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native domainregistration [ApiVersion]. See the version guide for details.

Using listTopLevelDomainAgreements

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 listTopLevelDomainAgreements(args: ListTopLevelDomainAgreementsArgs, opts?: InvokeOptions): Promise<ListTopLevelDomainAgreementsResult>
function listTopLevelDomainAgreementsOutput(args: ListTopLevelDomainAgreementsOutputArgs, opts?: InvokeOptions): Output<ListTopLevelDomainAgreementsResult>
Copy
def list_top_level_domain_agreements(for_transfer: Optional[bool] = None,
                                     include_privacy: Optional[bool] = None,
                                     name: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> ListTopLevelDomainAgreementsResult
def list_top_level_domain_agreements_output(for_transfer: Optional[pulumi.Input[bool]] = None,
                                     include_privacy: Optional[pulumi.Input[bool]] = None,
                                     name: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[ListTopLevelDomainAgreementsResult]
Copy
func ListTopLevelDomainAgreements(ctx *Context, args *ListTopLevelDomainAgreementsArgs, opts ...InvokeOption) (*ListTopLevelDomainAgreementsResult, error)
func ListTopLevelDomainAgreementsOutput(ctx *Context, args *ListTopLevelDomainAgreementsOutputArgs, opts ...InvokeOption) ListTopLevelDomainAgreementsResultOutput
Copy

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

public static class ListTopLevelDomainAgreements 
{
    public static Task<ListTopLevelDomainAgreementsResult> InvokeAsync(ListTopLevelDomainAgreementsArgs args, InvokeOptions? opts = null)
    public static Output<ListTopLevelDomainAgreementsResult> Invoke(ListTopLevelDomainAgreementsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListTopLevelDomainAgreementsResult> listTopLevelDomainAgreements(ListTopLevelDomainAgreementsArgs args, InvokeOptions options)
public static Output<ListTopLevelDomainAgreementsResult> listTopLevelDomainAgreements(ListTopLevelDomainAgreementsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:domainregistration:listTopLevelDomainAgreements
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the top-level domain.
ForTransfer bool
If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false.
IncludePrivacy bool
If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false.
Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the top-level domain.
ForTransfer bool
If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false.
IncludePrivacy bool
If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the top-level domain.
forTransfer Boolean
If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false.
includePrivacy Boolean
If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false.
name
This property is required.
Changes to this property will trigger replacement.
string
Name of the top-level domain.
forTransfer boolean
If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false.
includePrivacy boolean
If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false.
name
This property is required.
Changes to this property will trigger replacement.
str
Name of the top-level domain.
for_transfer bool
If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false.
include_privacy bool
If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the top-level domain.
forTransfer Boolean
If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false.
includePrivacy Boolean
If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false.

listTopLevelDomainAgreements Result

The following output properties are available:

NextLink string
Link to next page of resources.
Value List<Pulumi.AzureNative.DomainRegistration.Outputs.TldLegalAgreementResponse>
Collection of resources.
NextLink string
Link to next page of resources.
Value []TldLegalAgreementResponse
Collection of resources.
nextLink String
Link to next page of resources.
value List<TldLegalAgreementResponse>
Collection of resources.
nextLink string
Link to next page of resources.
value TldLegalAgreementResponse[]
Collection of resources.
next_link str
Link to next page of resources.
value Sequence[TldLegalAgreementResponse]
Collection of resources.
nextLink String
Link to next page of resources.
value List<Property Map>
Collection of resources.

Supporting Types

TldLegalAgreementResponse

AgreementKey This property is required. string
Unique identifier for the agreement.
Content This property is required. string
Agreement details.
Title This property is required. string
Agreement title.
Url string
URL where a copy of the agreement details is hosted.
AgreementKey This property is required. string
Unique identifier for the agreement.
Content This property is required. string
Agreement details.
Title This property is required. string
Agreement title.
Url string
URL where a copy of the agreement details is hosted.
agreementKey This property is required. String
Unique identifier for the agreement.
content This property is required. String
Agreement details.
title This property is required. String
Agreement title.
url String
URL where a copy of the agreement details is hosted.
agreementKey This property is required. string
Unique identifier for the agreement.
content This property is required. string
Agreement details.
title This property is required. string
Agreement title.
url string
URL where a copy of the agreement details is hosted.
agreement_key This property is required. str
Unique identifier for the agreement.
content This property is required. str
Agreement details.
title This property is required. str
Agreement title.
url str
URL where a copy of the agreement details is hosted.
agreementKey This property is required. String
Unique identifier for the agreement.
content This property is required. String
Agreement details.
title This property is required. String
Agreement title.
url String
URL where a copy of the agreement details is hosted.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native