azure-sdk-for-js/sdk/nginx/arm-nginx/review/arm-nginx.api.md

API Report File for "@azure/arm-nginx"

Do not edit this file. It is a report generated by API Extractor.

import * as coreAuth from '@azure/core-auth';
import * as coreClient from '@azure/core-client';
import { OperationState } from '@azure/core-lro';
import { PagedAsyncIterableIterator } from '@azure/core-paging';
import { SimplePollerLike } from '@azure/core-lro';

// @public
export interface AnalysisCreate {
    // (undocumented)
    config: AnalysisCreateConfig;
}

// @public (undocumented)
export interface AnalysisCreateConfig {
    // (undocumented)
    files?: NginxConfigurationFile[];
    // (undocumented)
    package?: NginxConfigurationPackage;
    // (undocumented)
    protectedFiles?: NginxConfigurationFile[];
    rootFile?: string;
}

// @public
export interface AnalysisDiagnostic {
    // (undocumented)
    description: string;
    // (undocumented)
    directive: string;
    file: string;
    id?: string;
    // (undocumented)
    line: number;
    // (undocumented)
    message: string;
    // (undocumented)
    rule: string;
}

// @public
export interface AnalysisResult {
    // (undocumented)
    data?: AnalysisResultData;
    status: string;
}

// @public (undocumented)
export interface AnalysisResultData {
    // (undocumented)
    errors?: AnalysisDiagnostic[];
}

// @public
export interface AutoUpgradeProfile {
    upgradeChannel: string;
}

// @public
export interface Certificates {
    beginCreateOrUpdate(resourceGroupName: string, deploymentName: string, certificateName: string, options?: CertificatesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CertificatesCreateOrUpdateResponse>, CertificatesCreateOrUpdateResponse>>;
    beginCreateOrUpdateAndWait(resourceGroupName: string, deploymentName: string, certificateName: string, options?: CertificatesCreateOrUpdateOptionalParams): Promise<CertificatesCreateOrUpdateResponse>;
    beginDelete(resourceGroupName: string, deploymentName: string, certificateName: string, options?: CertificatesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, deploymentName: string, certificateName: string, options?: CertificatesDeleteOptionalParams): Promise<void>;
    get(resourceGroupName: string, deploymentName: string, certificateName: string, options?: CertificatesGetOptionalParams): Promise<CertificatesGetResponse>;
    list(resourceGroupName: string, deploymentName: string, options?: CertificatesListOptionalParams): PagedAsyncIterableIterator<NginxCertificate>;
}

// @public
export interface CertificatesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
    body?: NginxCertificate;
    resumeFrom?: string;
    updateIntervalInMs?: number;
}

// @public
export type CertificatesCreateOrUpdateResponse = NginxCertificate;

// @public
export interface CertificatesDeleteOptionalParams extends coreClient.OperationOptions {
    resumeFrom?: string;
    updateIntervalInMs?: number;
}

// @public
export interface CertificatesGetOptionalParams extends coreClient.OperationOptions {
}

// @public
export type CertificatesGetResponse = NginxCertificate;

// @public
export interface CertificatesListNextOptionalParams extends coreClient.OperationOptions {
}

// @public
export type CertificatesListNextResponse = NginxCertificateListResponse;

// @public
export interface CertificatesListOptionalParams extends coreClient.OperationOptions {
}

// @public
export type CertificatesListResponse = NginxCertificateListResponse;

// @public
export interface Configurations {
    analysis(resourceGroupName: string, deploymentName: string, configurationName: string, options?: ConfigurationsAnalysisOptionalParams): Promise<ConfigurationsAnalysisResponse>;
    beginCreateOrUpdate(resourceGroupName: string, deploymentName: string, configurationName: string, options?: ConfigurationsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ConfigurationsCreateOrUpdateResponse>, ConfigurationsCreateOrUpdateResponse>>;
    beginCreateOrUpdateAndWait(resourceGroupName: string, deploymentName: string, configurationName: string, options?: ConfigurationsCreateOrUpdateOptionalParams): Promise<ConfigurationsCreateOrUpdateResponse>;
    beginDelete(resourceGroupName: string, deploymentName: string, configurationName: string, options?: ConfigurationsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, deploymentName: string, configurationName: string, options?: ConfigurationsDeleteOptionalParams): Promise<void>;
    get(resourceGroupName: string, deploymentName: string, configurationName: string, options?: ConfigurationsGetOptionalParams): Promise<ConfigurationsGetResponse>;
    list(resourceGroupName: string, deploymentName: string, options?: ConfigurationsListOptionalParams): PagedAsyncIterableIterator<NginxConfiguration>;
}

// @public
export interface ConfigurationsAnalysisOptionalParams extends coreClient.OperationOptions {
    body?: AnalysisCreate;
}

// @public
export type ConfigurationsAnalysisResponse = AnalysisResult;

// @public
export interface ConfigurationsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
    body?: NginxConfiguration;
    resumeFrom?: string;
    updateIntervalInMs?: number;
}

// @public
export type ConfigurationsCreateOrUpdateResponse = NginxConfiguration;

// @public
export interface ConfigurationsDeleteOptionalParams extends coreClient.OperationOptions {
    resumeFrom?: string;
    updateIntervalInMs?: number;
}

// @public
export interface ConfigurationsGetOptionalParams extends coreClient.OperationOptions {
}

// @public
export type ConfigurationsGetResponse = NginxConfiguration;

// @public
export interface ConfigurationsListNextOptionalParams extends coreClient.OperationOptions {
}

// @public
export type ConfigurationsListNextResponse = NginxConfigurationListResponse;

// @public
export interface ConfigurationsListOptionalParams extends coreClient.OperationOptions {
}

// @public
export type ConfigurationsListResponse = NginxConfigurationListResponse;

// @public
export type CreatedByType = string;

// @public
export interface Deployments {
    beginCreateOrUpdate(resourceGroupName: string, deploymentName: string, options?: DeploymentsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DeploymentsCreateOrUpdateResponse>, DeploymentsCreateOrUpdateResponse>>;
    beginCreateOrUpdateAndWait(resourceGroupName: string, deploymentName: string, options?: DeploymentsCreateOrUpdateOptionalParams): Promise<DeploymentsCreateOrUpdateResponse>;
    beginDelete(resourceGroupName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams): Promise<void>;
    beginUpdate(resourceGroupName: string, deploymentName: string, options?: DeploymentsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DeploymentsUpdateResponse>, DeploymentsUpdateResponse>>;
    beginUpdateAndWait(resourceGroupName: string, deploymentName: string, options?: DeploymentsUpdateOptionalParams): Promise<DeploymentsUpdateResponse>;
    get(resourceGroupName: string, deploymentName: string, options?: DeploymentsGetOptionalParams): Promise<DeploymentsGetResponse>;
    list(options?: DeploymentsListOptionalParams): PagedAsyncIterableIterator<NginxDeployment>;
    listByResourceGroup(resourceGroupName: string, options?: DeploymentsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<NginxDeployment>;
}

// @public
export interface DeploymentsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
    // (undocumented)
    body?: NginxDeployment;
    resumeFrom?: string;
    updateIntervalInMs?: number;
}

// @public
export type DeploymentsCreateOrUpdateResponse = NginxDeployment;

// @public
export interface DeploymentsDeleteOptionalParams extends coreClient.OperationOptions {
    resumeFrom?: string;
    updateIntervalInMs?: number;
}

// @public
export interface DeploymentsGetOptionalParams extends coreClient.OperationOptions {
}

// @public
export type DeploymentsGetResponse = NginxDeployment;

// @public
export interface DeploymentsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
}

// @public
export type DeploymentsListByResourceGroupNextResponse = NginxDeploymentListResponse;

// @public
export interface DeploymentsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
}

// @public
export type DeploymentsListByResourceGroupResponse = NginxDeploymentListResponse;

// @public
export interface DeploymentsListNextOptionalParams extends coreClient.OperationOptions {
}

// @public
export type DeploymentsListNextResponse = NginxDeploymentListResponse;

// @public
export interface DeploymentsListOptionalParams extends coreClient.OperationOptions {
}

// @public
export type DeploymentsListResponse = NginxDeploymentListResponse;

// @public
export interface DeploymentsUpdateOptionalParams extends coreClient.OperationOptions {
    // (undocumented)
    body?: NginxDeploymentUpdateParameters;
    resumeFrom?: string;
    updateIntervalInMs?: number;
}

// @public
export type DeploymentsUpdateResponse = NginxDeployment;

// @public
export interface ErrorAdditionalInfo {
    readonly info?: Record<string, unknown>;
    readonly type?: string;
}

// @public
export interface ErrorDetail {
    readonly additionalInfo?: ErrorAdditionalInfo[];
    readonly code?: string;
    readonly details?: ErrorDetail[];
    readonly message?: string;
    readonly target?: string;
}

// @public
export function getContinuationToken(page: unknown): string | undefined;

// @public (undocumented)
export interface IdentityProperties {
    readonly principalId?: string;
    readonly tenantId?: string;
    // (undocumented)
    type?: IdentityType;
    userAssignedIdentities?: {
        [propertyName: string]: UserIdentityProperties;
    };
}

// @public
export type IdentityType = string;

// @public
export enum KnownCreatedByType {
    Application = "Application",
    Key = "Key",
    ManagedIdentity = "ManagedIdentity",
    User = "User"
}

// @public
export enum KnownIdentityType {
    None = "None",
    SystemAssigned = "SystemAssigned",
    SystemAssignedUserAssigned = "SystemAssigned, UserAssigned",
    UserAssigned = "UserAssigned"
}

// @public
export enum KnownNginxPrivateIPAllocationMethod {
    Dynamic = "Dynamic",
    Static = "Static"
}

// @public
export enum KnownProvisioningState {
    Accepted = "Accepted",
    Canceled = "Canceled",
    Creating = "Creating",
    Deleted = "Deleted",
    Deleting = "Deleting",
    Failed = "Failed",
    NotSpecified = "NotSpecified",
    Succeeded = "Succeeded",
    Updating = "Updating"
}

// @public (undocumented)
export interface NginxCertificate {
    readonly id?: string;
    // (undocumented)
    location?: string;
    readonly name?: string;
    // (undocumented)
    properties?: NginxCertificateProperties;
    readonly systemData?: SystemData;
    readonly type?: string;
}

// @public (undocumented)
export interface NginxCertificateErrorResponseBody {
    // (undocumented)
    code?: string;
    // (undocumented)
    message?: string;
}

// @public (undocumented)
export interface NginxCertificateListResponse {
    // (undocumented)
    nextLink?: string;
    // (undocumented)
    value?: NginxCertificate[];
}

// @public (undocumented)
export interface NginxCertificateProperties {
    // (undocumented)
    certificateError?: NginxCertificateErrorResponseBody;
    // (undocumented)
    certificateVirtualPath?: string;
    readonly keyVaultSecretCreated?: Date;
    // (undocumented)
    keyVaultSecretId?: string;
    readonly keyVaultSecretVersion?: string;
    // (undocumented)
    keyVirtualPath?: string;
    readonly provisioningState?: ProvisioningState;
    readonly sha1Thumbprint?: string;
}

// @public (undocumented)
export interface NginxConfiguration {
    readonly id?: string;
    // (undocumented)
    location?: string;
    readonly name?: string;
    // (undocumented)
    properties?: NginxConfigurationProperties;
    readonly systemData?: SystemData;
    readonly type?: string;
}

// @public (undocumented)
export interface NginxConfigurationFile {
    // (undocumented)
    content?: string;
    // (undocumented)
    virtualPath?: string;
}

// @public
export interface NginxConfigurationListResponse {
    nextLink?: string;
    value?: NginxConfiguration[];
}

// @public (undocumented)
export interface NginxConfigurationPackage {
    // (undocumented)
    data?: string;
    // (undocumented)
    protectedFiles?: string[];
}

// @public (undocumented)
export interface NginxConfigurationProperties {
    // (undocumented)
    files?: NginxConfigurationFile[];
    // (undocumented)
    package?: NginxConfigurationPackage;
    // (undocumented)
    protectedFiles?: NginxConfigurationFile[];
    readonly provisioningState?: ProvisioningState;
    // (undocumented)
    rootFile?: string;
}

// @public (undocumented)
export interface NginxDeployment {
    readonly id?: string;
    // (undocumented)
    identity?: IdentityProperties;
    // (undocumented)
    location?: string;
    readonly name?: string;
    // (undocumented)
    properties?: NginxDeploymentProperties;
    // (undocumented)
    sku?: ResourceSku;
    readonly systemData?: SystemData;
    tags?: {
        [propertyName: string]: string;
    };
    readonly type?: string;
}

// @public (undocumented)
export interface NginxDeploymentListResponse {
    // (undocumented)
    nextLink?: string;
    // (undocumented)
    value?: NginxDeployment[];
}

// @public (undocumented)
export interface NginxDeploymentProperties {
    autoUpgradeProfile?: AutoUpgradeProfile;
    // (undocumented)
    enableDiagnosticsSupport?: boolean;
    readonly ipAddress?: string;
    // (undocumented)
    logging?: NginxLogging;
    managedResourceGroup?: string;
    // (undocumented)
    networkProfile?: NginxNetworkProfile;
    readonly nginxVersion?: string;
    readonly provisioningState?: ProvisioningState;
    scalingProperties?: NginxDeploymentScalingProperties;
    // (undocumented)
    userProfile?: NginxDeploymentUserProfile;
}

// @public
export interface NginxDeploymentScalingProperties {
    // (undocumented)
    capacity?: number;
    // (undocumented)
    profiles?: ScaleProfile[];
}

// @public (undocumented)
export interface NginxDeploymentUpdateParameters {
    // (undocumented)
    identity?: IdentityProperties;
    // (undocumented)
    location?: string;
    // (undocumented)
    properties?: NginxDeploymentUpdateProperties;
    // (undocumented)
    sku?: ResourceSku;
    tags?: {
        [propertyName: string]: string;
    };
}

// @public (undocumented)
export interface NginxDeploymentUpdateProperties {
    autoUpgradeProfile?: AutoUpgradeProfile;
    // (undocumented)
    enableDiagnosticsSupport?: boolean;
    // (undocumented)
    logging?: NginxLogging;
    scalingProperties?: NginxDeploymentScalingProperties;
    // (undocumented)
    userProfile?: NginxDeploymentUserProfile;
}

// @public (undocumented)
export interface NginxDeploymentUserProfile {
    preferredEmail?: string;
}

// @public (undocumented)
export interface NginxFrontendIPConfiguration {
    // (undocumented)
    privateIPAddresses?: NginxPrivateIPAddress[];
    // (undocumented)
    publicIPAddresses?: NginxPublicIPAddress[];
}

// @public (undocumented)
export interface NginxLogging {
    // (undocumented)
    storageAccount?: NginxStorageAccount;
}

// @public (undocumented)
export class NginxManagementClient extends coreClient.ServiceClient {
    // (undocumented)
    $host: string;
    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: NginxManagementClientOptionalParams);
    // (undocumented)
    apiVersion: string;
    // (undocumented)
    certificates: Certificates;
    // (undocumented)
    configurations: Configurations;
    // (undocumented)
    deployments: Deployments;
    // (undocumented)
    operations: Operations;
    // (undocumented)
    subscriptionId: string;
}

// @public
export interface NginxManagementClientOptionalParams extends coreClient.ServiceClientOptions {
    $host?: string;
    apiVersion?: string;
    endpoint?: string;
}

// @public (undocumented)
export interface NginxNetworkInterfaceConfiguration {
    // (undocumented)
    subnetId?: string;
}

// @public (undocumented)
export interface NginxNetworkProfile {
    // (undocumented)
    frontEndIPConfiguration?: NginxFrontendIPConfiguration;
    // (undocumented)
    networkInterfaceConfiguration?: NginxNetworkInterfaceConfiguration;
}

// @public (undocumented)
export interface NginxPrivateIPAddress {
    // (undocumented)
    privateIPAddress?: string;
    // (undocumented)
    privateIPAllocationMethod?: NginxPrivateIPAllocationMethod;
    // (undocumented)
    subnetId?: string;
}

// @public
export type NginxPrivateIPAllocationMethod = string;

// @public (undocumented)
export interface NginxPublicIPAddress {
    // (undocumented)
    id?: string;
}

// @public (undocumented)
export interface NginxStorageAccount {
    // (undocumented)
    accountName?: string;
    // (undocumented)
    containerName?: string;
}

// @public
export interface OperationDisplay {
    description?: string;
    operation?: string;
    provider?: string;
    resource?: string;
}

// @public
export interface OperationListResult {
    nextLink?: string;
    value?: OperationResult[];
}

// @public
export interface OperationResult {
    display?: OperationDisplay;
    isDataAction?: boolean;
    name?: string;
}

// @public
export interface Operations {
    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<OperationResult>;
}

// @public
export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
}

// @public
export type OperationsListNextResponse = OperationListResult;

// @public
export interface OperationsListOptionalParams extends coreClient.OperationOptions {
}

// @public
export type OperationsListResponse = OperationListResult;

// @public
export type ProvisioningState = string;

// @public (undocumented)
export interface ResourceProviderDefaultErrorResponse {
    error?: ErrorDetail;
}

// @public (undocumented)
export interface ResourceSku {
    name: string;
}

// @public
export interface ScaleProfile {
    capacity: ScaleProfileCapacity;
    // (undocumented)
    name: string;
}

// @public
export interface ScaleProfileCapacity {
    max: number;
    min: number;
}

// @public
export interface SystemData {
    createdAt?: Date;
    createdBy?: string;
    createdByType?: CreatedByType;
    lastModifiedAt?: Date;
    lastModifiedBy?: string;
    lastModifiedByType?: CreatedByType;
}

// @public (undocumented)
export interface UserIdentityProperties {
    readonly clientId?: string;
    readonly principalId?: string;
}

// (No @packageDocumentation comment for this package)