@microsoft/msgraph-sdk-domains/domains/item/index.d.ts

Domains fluent API for Microsoft Graph

import { type Domain } from '@microsoft/msgraph-sdk/models/index.js';
import { type DomainNameReferencesRequestBuilder } from './domainNameReferences/index.js';
import { type FederationConfigurationRequestBuilder } from './federationConfiguration/index.js';
import { type ForceDeleteRequestBuilder } from './forceDelete/index.js';
import { type PromoteRequestBuilder } from './promote/index.js';
import { type RootDomainRequestBuilder } from './rootDomain/index.js';
import { type ServiceConfigurationRecordsRequestBuilder } from './serviceConfigurationRecords/index.js';
import { type VerificationDnsRecordsRequestBuilder } from './verificationDnsRecords/index.js';
import { type VerifyRequestBuilder } from './verify/index.js';
import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
 * Provides operations to manage the collection of domain entities.
 */
export interface DomainItemRequestBuilder extends BaseRequestBuilder<DomainItemRequestBuilder> {
    /**
     * Provides operations to manage the domainNameReferences property of the microsoft.graph.domain entity.
     */
    get domainNameReferences(): DomainNameReferencesRequestBuilder;
    /**
     * Provides operations to manage the federationConfiguration property of the microsoft.graph.domain entity.
     */
    get federationConfiguration(): FederationConfigurationRequestBuilder;
    /**
     * Provides operations to call the forceDelete method.
     */
    get forceDelete(): ForceDeleteRequestBuilder;
    /**
     * Provides operations to call the promote method.
     */
    get promote(): PromoteRequestBuilder;
    /**
     * Provides operations to manage the rootDomain property of the microsoft.graph.domain entity.
     */
    get rootDomain(): RootDomainRequestBuilder;
    /**
     * Provides operations to manage the serviceConfigurationRecords property of the microsoft.graph.domain entity.
     */
    get serviceConfigurationRecords(): ServiceConfigurationRecordsRequestBuilder;
    /**
     * Provides operations to manage the verificationDnsRecords property of the microsoft.graph.domain entity.
     */
    get verificationDnsRecords(): VerificationDnsRecordsRequestBuilder;
    /**
     * Provides operations to call the verify method.
     */
    get verify(): VerifyRequestBuilder;
    /**
     * Delete a domain from a tenant.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/domain-delete?view=graph-rest-1.0|Find more info here}
     */
    delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
    /**
     * Retrieve the properties and relationships of domain object.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<Domain>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/domain-get?view=graph-rest-1.0|Find more info here}
     */
    get(requestConfiguration?: RequestConfiguration<DomainItemRequestBuilderGetQueryParameters> | undefined): Promise<Domain | undefined>;
    /**
     * Update the properties of domain object. Only verified domains can be updated.
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<Domain>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/domain-update?view=graph-rest-1.0|Find more info here}
     */
    patch(body: Domain, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Domain | undefined>;
    /**
     * Delete a domain from a tenant.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
    /**
     * Retrieve the properties and relationships of domain object.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<DomainItemRequestBuilderGetQueryParameters> | undefined): RequestInformation;
    /**
     * Update the properties of domain object. Only verified domains can be updated.
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toPatchRequestInformation(body: Domain, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
 * Retrieve the properties and relationships of domain object.
 */
export interface DomainItemRequestBuilderGetQueryParameters {
    /**
     * Expand related entities
     */
    expand?: string[];
    /**
     * Select properties to be returned
     */
    select?: string[];
}
/**
 * Uri template for the request builder.
 */
export declare const DomainItemRequestBuilderUriTemplate = "{+baseurl}/domains/{domain%2Did}{?%24expand,%24select}";
/**
 * Metadata for all the navigation properties in the request builder.
 */
export declare const DomainItemRequestBuilderNavigationMetadata: Record<Exclude<keyof DomainItemRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
 * Metadata for all the requests in the request builder.
 */
export declare const DomainItemRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map