UNPKG

@microsoft/msgraph-sdk-domains

Version:
98 lines 6.3 kB
import { type DomainDnsRecord, type DomainDnsRecordCollectionResponse } from '@microsoft/msgraph-sdk/models/index.js'; import { type CountRequestBuilder } from './count/index.js'; import { type DomainDnsRecordItemRequestBuilder } from './item/index.js'; import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions'; /** * Provides operations to manage the verificationDnsRecords property of the microsoft.graph.domain entity. */ export interface VerificationDnsRecordsRequestBuilder extends BaseRequestBuilder<VerificationDnsRecordsRequestBuilder> { /** * Provides operations to count the resources in the collection. */ get count(): CountRequestBuilder; /** * Provides operations to manage the verificationDnsRecords property of the microsoft.graph.domain entity. * @param domainDnsRecordId The unique identifier of domainDnsRecord * @returns {DomainDnsRecordItemRequestBuilder} */ byDomainDnsRecordId(domainDnsRecordId: string): DomainDnsRecordItemRequestBuilder; /** * Retrieve a list of domainDnsRecord objects. You cannot use an associated domain with your Microsoft Entra tenant until ownership is verified. To verify the ownership of the domain, retrieve the domain verification records and add the details to the zone file of the domain. This can be done through the domain registrar or DNS server configuration. Root domains require verification. For example, contoso.com requires verification. If a root domain is verified, subdomains of the root domain are automatically verified. For example, subdomain.contoso.com is automatically be verified if contoso.com has been verified. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {Promise<DomainDnsRecordCollectionResponse>} * @throws {ODataError} error when the service returns a 4XX or 5XX status code * @see {@link https://learn.microsoft.com/graph/api/domain-list-verificationdnsrecords?view=graph-rest-1.0|Find more info here} */ get(requestConfiguration?: RequestConfiguration<VerificationDnsRecordsRequestBuilderGetQueryParameters> | undefined): Promise<DomainDnsRecordCollectionResponse | undefined>; /** * Create new navigation property to verificationDnsRecords for domains * @param body The request body * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {Promise<DomainDnsRecord>} * @throws {ODataError} error when the service returns a 4XX or 5XX status code */ post(body: DomainDnsRecord, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<DomainDnsRecord | undefined>; /** * Retrieve a list of domainDnsRecord objects. You cannot use an associated domain with your Microsoft Entra tenant until ownership is verified. To verify the ownership of the domain, retrieve the domain verification records and add the details to the zone file of the domain. This can be done through the domain registrar or DNS server configuration. Root domains require verification. For example, contoso.com requires verification. If a root domain is verified, subdomains of the root domain are automatically verified. For example, subdomain.contoso.com is automatically be verified if contoso.com has been verified. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toGetRequestInformation(requestConfiguration?: RequestConfiguration<VerificationDnsRecordsRequestBuilderGetQueryParameters> | undefined): RequestInformation; /** * Create new navigation property to verificationDnsRecords for domains * @param body The request body * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toPostRequestInformation(body: DomainDnsRecord, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation; } /** * Retrieve a list of domainDnsRecord objects. You cannot use an associated domain with your Microsoft Entra tenant until ownership is verified. To verify the ownership of the domain, retrieve the domain verification records and add the details to the zone file of the domain. This can be done through the domain registrar or DNS server configuration. Root domains require verification. For example, contoso.com requires verification. If a root domain is verified, subdomains of the root domain are automatically verified. For example, subdomain.contoso.com is automatically be verified if contoso.com has been verified. */ export interface VerificationDnsRecordsRequestBuilderGetQueryParameters { /** * Include count of items */ count?: boolean; /** * Expand related entities */ expand?: string[]; /** * Filter items by property values */ filter?: string; /** * Order items by property values */ orderby?: string[]; /** * Search items by search phrases */ search?: string; /** * Select properties to be returned */ select?: string[]; /** * Skip the first n items */ skip?: number; /** * Show only the first n items */ top?: number; } /** * Uri template for the request builder. */ export declare const VerificationDnsRecordsRequestBuilderUriTemplate = "{+baseurl}/domains/{domain%2Did}/verificationDnsRecords{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}"; /** * Metadata for all the navigation properties in the request builder. */ export declare const VerificationDnsRecordsRequestBuilderNavigationMetadata: Record<Exclude<keyof VerificationDnsRecordsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>; /** * Metadata for all the requests in the request builder. */ export declare const VerificationDnsRecordsRequestBuilderRequestsMetadata: RequestsMetadata; //# sourceMappingURL=index.d.ts.map